CedarBackup2.extend.subversion.RepositoryDir

Package CedarBackup2 :: Package extend :: Module subversion :: Class RepositoryDir |
[hide private]
[frames] | no frames]

# Class RepositoryDir

source code

    object --+
             |
            RepositoryDir

Class representing Subversion repository directory.

A repository directory is a directory that contains one or more Subversion repositories.

The following restrictions exist on data in this class:

- The directory 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.

The repository type value is kept around just for reference. It doesn't affect the behavior of the backup.

Relative exclusions are allowed here. However, there is no configured ignore file, because repository dir backups are not recursive.

Instance Methods | [hide private]
__init__(self, repositoryType=None, directoryPath=None, collectMode=None, compressMode=None, relativeExcludePaths=None, excludePatterns=None) Constructor for the `RepositoryDir` 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
_setRepositoryType(self, value) Property target used to set the repository type. | source code
_getRepositoryType(self) Property target used to get the repository type. | source code
_setDirectoryPath(self, value) Property target used to set the directory path. | source code
_getDirectoryPath(self) Property target used to get the repository 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]
| directoryPath Absolute path of the Subversion parent directory.
| collectMode Overridden collect mode for this repository.
| compressMode Overridden compress mode for this repository.
| repositoryType Type of this repository, for reference.
| 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, repositoryType=None, directoryPath=None, collectMode=None, compressMode=None, relativeExcludePaths=None, excludePatterns=None) (Constructor) | source code
Constructor for the `RepositoryDir` class. Parameters: `repositoryType` - Type of repository, for reference `directoryPath` - Absolute path of the Subversion parent directory `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.

### _setRepositoryType(self, value) | source code
Property target used to set the repository type. There is no validation; this value is kept around just for reference.

### _setDirectoryPath(self, value) | source code
Property target used to set the directory 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]

### directoryPath Absolute path of the Subversion parent directory. Get Method: _getDirectoryPath(self) - Property target used to get the repository path. Set Method: _setDirectoryPath(self, value) - Property target used to set the directory path.

### collectMode Overridden collect mode for this repository. 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 repository. 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.

### repositoryType Type of this repository, for reference. Get Method: _getRepositoryType(self) - Property target used to get the repository type. Set Method: _setRepositoryType(self, value) - Property target used to set the repository type.

### 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.