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

Class PurgeConfig

source code

object --+
         |
        PurgeConfig

Class representing a Cedar Backup purge configuration.

The following restrictions exist on data in this class:

For the purgeDirs list, validation is accomplished through the util.ObjectTypeList list implementation that overrides common list methods and transparently ensures that each element is a PurgeDir.


Note: Lists within this class are "unordered" for equality comparisons.

Instance Methods [hide private]
 
__init__(self, purgeDirs=None)
Constructor for the Purge 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
 
_setPurgeDirs(self, value)
Property target used to set the purge dirs list.
source code
 
_getPurgeDirs(self)
Property target used to get the purge dirs 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]
  purgeDirs
List of directories to purge.

Inherited from object: __class__

Method Details [hide private]

__init__(self, purgeDirs=None)
(Constructor)

source code 

Constructor for the Purge class.

Parameters:
  • purgeDirs - List of purge directories.
Raises:
  • ValueError - If one of the values is invalid.
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. Lists within this class are "unordered" for equality comparisons.

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

_setPurgeDirs(self, value)

source code 

Property target used to set the purge dirs list. Either the value must be None or each element must be a PurgeDir.

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

Property Details [hide private]

purgeDirs

List of directories to purge.

Get Method:
_getPurgeDirs(self) - Property target used to get the purge dirs list.
Set Method:
_setPurgeDirs(self, value) - Property target used to set the purge dirs list.