CedarBackup2.config.PurgeDir

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

# Class PurgeDir

source code

    object --+
             |
            PurgeDir

Class representing a Cedar Backup purge directory.

The following restrictions exist on data in this class:

- The absolute path must be an absolute path
- The retain days value must be an integer >= 0.

Instance Methods | [hide private]
__init__(self, absolutePath=None, retainDays=None) Constructor for the `PurgeDir` 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) Definition of equals operator for this class. | source code
_setAbsolutePath(self, value) Property target used to set the absolute path. | source code
_getAbsolutePath(self) Property target used to get the absolute path. | source code
_setRetainDays(self, value) Property target used to set the retain days value. | source code
_getRetainDays(self) Property target used to get the absolute path. | source code
Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties | [hide private]
| absolutePath Absolute path of directory to purge.
| retainDays Number of days content within directory should be retained.
Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, absolutePath=None, retainDays=None) (Constructor) | source code
Constructor for the `PurgeDir` class. Parameters: `absolutePath` - Absolute path of the directory to be purged. `retainDays` - Number of days content within directory should be retained. 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
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.

### _setAbsolutePath(self, value) | source code
Property target used to set the absolute path. The value must be an absolute path if it is not `None`. It does not have to exist on disk at the time of assignment. Raises: `ValueError` - If the value is not an absolute path. `ValueError` - If the value cannot be encoded properly.

### _setRetainDays(self, value) | source code
Property target used to set the retain days value. The value must be an integer >= 0. Raises: `ValueError` - If the value is not valid.

Property Details | [hide private]

### absolutePath Absolute path of directory to purge. Get Method: _getAbsolutePath(self) - Property target used to get the absolute path. Set Method: _setAbsolutePath(self, value) - Property target used to set the absolute path.

### retainDays Number of days content within directory should be retained. Get Method: _getRetainDays(self) - Property target used to get the absolute path. Set Method: _setRetainDays(self, value) - Property target used to set the retain days value.