Package CedarBackup2 :: Module config :: Class ExtendedAction
[show private | hide private]
[frames | no frames]

Type ExtendedAction

object --+
         |
        ExtendedAction


Class representing an extended action.

As with all of the other classes that represent configuration sections, all of these values are optional. It is up to some higher-level construct to decide whether everything they need is filled in. Some validation is done on non-None assignments through the use of the Python property() construct.

Essentially, an extended action needs to allow the following to happen:
  exec("from %s import %s" % (module, function))
  exec("%s(action, configPath")" % function)
The following restrictions exist on data in this class:
Method Summary
  __init__(self, name, module, function, index)
Constructor for the ExtendedAction class.
  __repr__(self)
Official string representation for class instance.
  __str__(self)
Informal string representation for class instance.
  __cmp__(self, other)
Definition of equals operator for this class.
  _getFunction(self)
Property target used to get the function name.
  _getIndex(self)
Property target used to get the action index.
  _getModule(self)
Property target used to get the module name.
  _getName(self)
Property target used to get the action name.
  _setFunction(self, value)
Property target used to set the function name.
  _setIndex(self, value)
Property target used to set the action index.
  _setModule(self, value)
Property target used to set the module name.
  _setName(self, value)
Property target used to set the action name.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value

Property Summary
  name: Name of the extended action.
  module: Name of the module containing the extended action function.
  function: Name of the extended action function.
  index: Index of action, for execution ordering.

Method Details

__init__(self, name=None, module=None, function=None, index=None)
(Constructor)

Constructor for the ExtendedAction class.
Parameters:
name - Name of the extended action
module - Name of the module containing the extended action function
function - Name of the extended action function
index - Index of action, for execution ordering
Raises:
ValueError - If one of the values is invalid.
Overrides:
__builtin__.object.__init__

__repr__(self)
(Representation operator)

Official string representation for class instance.
Overrides:
__builtin__.object.__repr__

__str__(self)
(Informal representation operator)

Informal string representation for class instance.
Overrides:
__builtin__.object.__str__

__cmp__(self, other)
(Comparison operator)

Definition of equals operator for this class.
Parameters:
other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

_getFunction(self)

Property target used to get the function name.

_getIndex(self)

Property target used to get the action index.

_getModule(self)

Property target used to get the module name.

_getName(self)

Property target used to get the action name.

_setFunction(self, value)

Property target used to set the function name. The value must be a non-empty string if it is not None. It must also be a valid Python identifier.
Raises:
ValueError - If the value is an empty string.

_setIndex(self, value)

Property target used to set the action index. The value must be an integer >= 0.
Raises:
ValueError - If the value is not valid.

_setModule(self, value)

Property target used to set the module name. The value must be a non-empty string if it is not None. It must also be a valid Python identifier.
Raises:
ValueError - If the value is an empty string.

_setName(self, value)

Property target used to set the action name. The value must be a non-empty string if it is not None. It must also consist only of lower-case letters and digits.
Raises:
ValueError - If the value is an empty string.

Property Details

name

Name of the extended action.
Get Method:
_getName(self)
Set Method:
_setName(self, value)

module

Name of the module containing the extended action function.
Get Method:
_getModule(self)
Set Method:
_setModule(self, value)

function

Name of the extended action function.
Get Method:
_getFunction(self)
Set Method:
_setFunction(self, value)

index

Index of action, for execution ordering.
Get Method:
_getIndex(self)
Set Method:
_setIndex(self, value)

Generated by Epydoc 2.1 on Thu Dec 22 20:45:15 2005 http://epydoc.sf.net