Class PurgeConfig
source code
object --+
|
PurgeConfig
Class representing a Cedar Backup purge configuration.
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.
The following restrictions exist on data in this class:
-
The purge directory list must be a list of
PurgeDir
objects.
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.
|
|
|
|
|
|
|
|
|
|
|
_getPurgeDirs(self)
Property target used to get the purge dirs list. |
source code
|
|
Inherited from object :
__delattr__ ,
__getattribute__ ,
__hash__ ,
__new__ ,
__reduce__ ,
__reduce_ex__ ,
__setattr__
|
|
purgeDirs
List of directories to purge.
|
Inherited from object :
__class__
|
__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__
|
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__
|
Definition of equals operator for this class. 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.
|
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
|
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.
|