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, dependencies)
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.
    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, used for execution ordering.
  dependencies: Dependencies for action, used for execution ordering.

Method Details

__init__(self, name=None, module=None, function=None, index=None, dependencies=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, used for execution ordering
dependencies - Dependencies for action, used 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.

Property Details

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, used for execution ordering.

dependencies

Dependencies for action, used for execution ordering.

Generated by Epydoc 2.1 on Thu Mar 29 20:58:26 2007 http://epydoc.sf.net