Package CedarBackup3 :: Module config :: Class ExtensionsConfig
[hide private]
[frames] | no frames]

Class ExtensionsConfig

source code

object --+
         |
        ExtensionsConfig

Class representing Cedar Backup extensions configuration.

Extensions configuration is used to specify "extended actions" implemented by code external to Cedar Backup. For instance, a hypothetical third party might write extension code to collect database repository data. If they write a properly-formatted extension function, they can use the extension configuration to map a command-line Cedar Backup action (i.e. "database") to their function.

The following restrictions exist on data in this class:

Instance Methods [hide private]
 
__init__(self, actions=None, orderMode=None)
Constructor for the ExtensionsConfig class.
source code
 
__repr__(self)
Official string representation for class instance.
source code
 
__str__(self)
Informal string representation for class instance.
source code
 
__cmp__(self, other)
Original Python 2 comparison operator.
source code
 
__eq__(self, other)
Equals operator, implemented in terms of original Python 2 compare operator.
source code
 
__lt__(self, other)
Less-than operator, implemented in terms of original Python 2 compare operator.
source code
 
__gt__(self, other)
Greater-than operator, implemented in terms of original Python 2 compare operator.
source code
 
_setOrderMode(self, value)
Property target used to set the order mode.
source code
 
_getOrderMode(self)
Property target used to get the order mode.
source code
 
_setActions(self, value)
Property target used to set the actions list.
source code
 
_getActions(self)
Property target used to get the actions list.
source code
 
__ge__(x, y)
x>=y
 
__le__(x, y)
x<=y

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties [hide private]
  orderMode
Order mode for extensions, to control execution ordering.
  actions
List of extended actions.

Inherited from object: __class__

Method Details [hide private]

__init__(self, actions=None, orderMode=None)
(Constructor)

source code 

Constructor for the ExtensionsConfig class.

Parameters:
  • actions - List of extended actions
Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 

Official string representation for class instance.

Overrides: object.__repr__

__str__(self)
(Informal representation operator)

source code 

Informal string representation for class instance.

Overrides: object.__str__

__cmp__(self, other)
(Comparison operator)

source code 

Original Python 2 comparison operator.

Parameters:
  • other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

_setOrderMode(self, value)

source code 

Property target used to set the order mode. The value must be one of VALID_ORDER_MODES.

Raises:
  • ValueError - If the value is not valid.

_setActions(self, value)

source code 

Property target used to set the actions list. Either the value must be None or each element must be an ExtendedAction.

Raises:
  • ValueError - If the value is not a ExtendedAction

Property Details [hide private]

orderMode

Order mode for extensions, to control execution ordering.

Get Method:
_getOrderMode(self) - Property target used to get the order mode.
Set Method:
_setOrderMode(self, value) - Property target used to set the order mode.

actions

List of extended actions.

Get Method:
_getActions(self) - Property target used to get the actions list.
Set Method:
_setActions(self, value) - Property target used to set the actions list.