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

Type CollectConfig

object --+
         |
        CollectConfig


Class representing a Cedar Backup collect 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:

For the absoluteExcludePaths list, validation is accomplished through the util.AbsolutePathList list implementation that overrides common list methods and transparently does the absolute path validation for us.

For the collectFiles and collectDirs list, validation is accomplished through the util.ObjectTypeList list implementation that overrides common list methods and transparently ensures that each element has an appropriate type.

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

Method Summary
  __init__(self, targetDir, collectMode, archiveMode, ignoreFile, absoluteExcludePaths, excludePatterns, collectFiles, collectDirs)
Constructor for the CollectConfig class.
  __repr__(self)
Official string representation for class instance.
  __str__(self)
Informal string representation for class instance.
  __cmp__(self, other)
Definition of equals operator for this class.
  _getAbsoluteExcludePaths(self)
Property target used to get the absolute exclude paths list.
  _getArchiveMode(self)
Property target used to get the archive mode.
  _getCollectDirs(self)
Property target used to get the collect dirs list.
  _getCollectFiles(self)
Property target used to get the collect files list.
  _getCollectMode(self)
Property target used to get the collect mode.
  _getExcludePatterns(self)
Property target used to get the exclude patterns list.
  _getIgnoreFile(self)
Property target used to get the ignore file.
  _getTargetDir(self)
Property target used to get the target directory.
  _setAbsoluteExcludePaths(self, value)
Property target used to set the absolute exclude paths list.
  _setArchiveMode(self, value)
Property target used to set the archive mode.
  _setCollectDirs(self, value)
Property target used to set the collect dirs list.
  _setCollectFiles(self, value)
Property target used to set the collect files list.
  _setCollectMode(self, value)
Property target used to set the collect mode.
  _setExcludePatterns(self, value)
Property target used to set the exclude patterns list.
  _setIgnoreFile(self, value)
Property target used to set the ignore file.
  _setTargetDir(self, value)
Property target used to set the target directory.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value

Property Summary
  targetDir: Directory to collect files into.
  collectMode: Default collect mode.
  archiveMode: Default archive mode for collect files.
  ignoreFile: Default ignore file name.
  absoluteExcludePaths: List of absolute paths to exclude.
  excludePatterns: List of regular expressions patterns to exclude.
  collectFiles: List of collect files.
  collectDirs: List of collect directories.

Method Details

__init__(self, targetDir=None, collectMode=None, archiveMode=None, ignoreFile=None, absoluteExcludePaths=None, excludePatterns=None, collectFiles=None, collectDirs=None)
(Constructor)

Constructor for the CollectConfig class.
Parameters:
targetDir - Directory to collect files into.
collectMode - Default collect mode.
archiveMode - Default archive mode for collect files.
ignoreFile - Default ignore file name.
absoluteExcludePaths - List of absolute paths to exclude.
excludePatterns - List of regular expression patterns to exclude.
collectFiles - List of collect files.
collectDirs - List of collect directories.
Raises:
ValueError - If one of the values is invalid.
Overrides:
__builtin__.object.__init__

__repr__(self)
(Representation operator)

Official string representation for class instance.
Overrides:
__builtin__.object.__repr__

__str__(self)
(Informal representation operator)

Informal string representation for class instance.
Overrides:
__builtin__.object.__str__

__cmp__(self, other)
(Comparison operator)

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.

_getAbsoluteExcludePaths(self)

Property target used to get the absolute exclude paths list.

_getArchiveMode(self)

Property target used to get the archive mode.

_getCollectDirs(self)

Property target used to get the collect dirs list.

_getCollectFiles(self)

Property target used to get the collect files list.

_getCollectMode(self)

Property target used to get the collect mode.

_getExcludePatterns(self)

Property target used to get the exclude patterns list.

_getIgnoreFile(self)

Property target used to get the ignore file.

_getTargetDir(self)

Property target used to get the target directory.

_setAbsoluteExcludePaths(self, value)

Property target used to set the absolute exclude paths list. Either the value must be None or each element must be an absolute path. Elements do not have to exist on disk at the time of assignment.
Raises:
ValueError - If the value is not an absolute path.

_setArchiveMode(self, value)

Property target used to set the archive mode. If not None, the mode must be one of VALID_ARCHIVE_MODES.
Raises:
ValueError - If the value is not valid.

_setCollectDirs(self, value)

Property target used to set the collect dirs list. Either the value must be None or each element must be a CollectDir.
Raises:
ValueError - If the value is not a CollectDir

_setCollectFiles(self, value)

Property target used to set the collect files list. Either the value must be None or each element must be a CollectFile.
Raises:
ValueError - If the value is not a CollectFile

_setCollectMode(self, value)

Property target used to set the collect mode. If not None, the mode must be one of VALID_COLLECT_MODES.
Raises:
ValueError - If the value is not valid.

_setExcludePatterns(self, value)

Property target used to set the exclude patterns list.

_setIgnoreFile(self, value)

Property target used to set the ignore file. The value must be a non-empty string if it is not None.
Raises:
ValueError - If the value is an empty string.
ValueError - If the value cannot be encoded properly.

_setTargetDir(self, value)

Property target used to set the target directory. 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.

Property Details

targetDir

Directory to collect files into.
Get Method:
_getTargetDir(self)
Set Method:
_setTargetDir(self, value)

collectMode

Default collect mode.
Get Method:
_getCollectMode(self)
Set Method:
_setCollectMode(self, value)

archiveMode

Default archive mode for collect files.
Get Method:
_getArchiveMode(self)
Set Method:
_setArchiveMode(self, value)

ignoreFile

Default ignore file name.
Get Method:
_getIgnoreFile(self)
Set Method:
_setIgnoreFile(self, value)

absoluteExcludePaths

List of absolute paths to exclude.
Get Method:
_getAbsoluteExcludePaths(self)
Set Method:
_setAbsoluteExcludePaths(self, value)

excludePatterns

List of regular expressions patterns to exclude.
Get Method:
_getExcludePatterns(self)
Set Method:
_setExcludePatterns(self, value)

collectFiles

List of collect files.
Get Method:
_getCollectFiles(self)
Set Method:
_setCollectFiles(self, value)

collectDirs

List of collect directories.
Get Method:
_getCollectDirs(self)
Set Method:
_setCollectDirs(self, value)

Generated by Epydoc 2.1 on Mon Dec 18 22:53:32 2006 http://epydoc.sf.net