CedarBackup2.extend.mbox.MboxDir

Package CedarBackup2 :: Package extend :: Module mbox :: Class MboxDir |
[hide private]
[frames] | no frames]

# Class MboxDir

source code

    object --+
             |
            MboxDir

Class representing mbox directory configuration..

The following restrictions exist on data in this class:

- The absolute path must be absolute.
- The collect mode must be one of the values in VALID_COLLECT_MODES.
- The compress mode must be one of the values in VALID_COMPRESS_MODES.

Unlike collect directory configuration, this is the only place exclusions are allowed (no global exclusions at the <mbox> configuration level). Also, we only allow relative exclusions and there is no configured ignore file. This is because mbox directory backups are not recursive.

Instance Methods | [hide private]
__init__(self, absolutePath=None, collectMode=None, compressMode=None, relativeExcludePaths=None, excludePatterns=None) Constructor for the `MboxDir` 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
_setCollectMode(self, value) Property target used to set the collect mode. | source code
_getCollectMode(self) Property target used to get the collect mode. | source code
_setCompressMode(self, value) Property target used to set the compress mode. | source code
_getCompressMode(self) Property target used to get the compress mode. | source code
_setRelativeExcludePaths(self, value) Property target used to set the relative exclude paths list. | source code
_getRelativeExcludePaths(self) Property target used to get the relative exclude paths list. | source code
_setExcludePatterns(self, value) Property target used to set the exclude patterns list. | source code
_getExcludePatterns(self) Property target used to get the exclude patterns list. | source code
Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Properties | [hide private]
| absolutePath Absolute path to the mbox directory.
| collectMode Overridden collect mode for this mbox directory.
| compressMode Overridden compress mode for this mbox directory.
| relativeExcludePaths List of relative paths to exclude.
| excludePatterns List of regular expression patterns to exclude.
Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, absolutePath=None, collectMode=None, compressMode=None, relativeExcludePaths=None, excludePatterns=None) (Constructor) | source code
Constructor for the `MboxDir` class. You should never directly instantiate this class. Parameters: `absolutePath` - Absolute path to a mbox file on disk. `collectMode` - Overridden collect mode for this directory. `compressMode` - Overridden compression mode for this directory. `relativeExcludePaths` - List of relative paths to exclude. `excludePatterns` - List of regular expression patterns to exclude 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.

### _setCollectMode(self, value) | source code
Property target used to set the collect mode. If not `None`, the mode must be one of the values in VALID_COLLECT_MODES. Raises: `ValueError` - If the value is not valid.

### _setCompressMode(self, value) | source code
Property target used to set the compress mode. If not `None`, the mode must be one of the values in VALID_COMPRESS_MODES. Raises: `ValueError` - If the value is not valid.

### _setRelativeExcludePaths(self, value) | source code
Property target used to set the relative exclude paths list. Elements do not have to exist on disk at the time of assignment.

Property Details | [hide private]

### absolutePath Absolute path to the mbox directory. 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.

### collectMode Overridden collect mode for this mbox directory. Get Method: _getCollectMode(self) - Property target used to get the collect mode. Set Method: _setCollectMode(self, value) - Property target used to set the collect mode.

### compressMode Overridden compress mode for this mbox directory. Get Method: _getCompressMode(self) - Property target used to get the compress mode. Set Method: _setCompressMode(self, value) - Property target used to set the compress mode.

### relativeExcludePaths List of relative paths to exclude. Get Method: _getRelativeExcludePaths(self) - Property target used to get the relative exclude paths list. Set Method: _setRelativeExcludePaths(self, value) - Property target used to set the relative exclude paths list.

### excludePatterns List of regular expression patterns to exclude. Get Method: _getExcludePatterns(self) - Property target used to get the exclude patterns list. Set Method: _setExcludePatterns(self, value) - Property target used to set the exclude patterns list.