Home | Trees | Index | Help |
|
---|
Package CedarBackup2 :: Module config :: Class CollectDir |
|
object
--+
|
CollectDir
Class representing a Cedar Backup collect directory.
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.
VALID_COLLECT_MODES
.
VALID_ARCHIVE_MODES
.
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.
Note: Lists within this class are "unordered" for equality comparisons.
Method Summary | |
---|---|
Constructor for the CollectDir class. | |
Official string representation for class instance. | |
Informal string representation for class instance. | |
Definition of equals operator for this class. | |
Property target used to get the absolute exclude paths list. | |
Property target used to get the absolute path. | |
Property target used to get the archive mode. | |
Property target used to get the collect mode. | |
Property target used to get the exclude patterns list. | |
Property target used to get the ignore file. | |
Property target used to get the relative exclude paths list. | |
Property target used to set the absolute exclude paths list. | |
Property target used to set the absolute path. | |
Property target used to set the archive mode. | |
Property target used to set the collect mode. | |
Property target used to set the exclude patterns list. | |
Property target used to set the ignore file. | |
Property target used to set the relative exclude paths list. | |
Inherited from object | |
x.__delattr__('name') <==> del x.name | |
x.__getattribute__('name') <==> x.name | |
x.__hash__() <==> hash(x) | |
T.__new__(S, ...) -> a new object with type S, a subtype of T | |
helper for pickle | |
helper for pickle | |
x.__setattr__('name', value) <==> x.name = value |
Property Summary | |
---|---|
absolutePath : Absolute path of the directory to collect. | |
collectMode : Overridden collect mode for this directory. | |
archiveMode : Overridden archive mode for this directory. | |
ignoreFile : Overridden ignore file name for this directory. | |
absoluteExcludePaths : List of absolute paths to exclude. | |
relativeExcludePaths : List of relative paths to exclude. | |
excludePatterns : List of regular expression patterns to exclude. |
Method Details |
---|
__init__(self,
absolutePath=None,
collectMode=None,
archiveMode=None,
ignoreFile=None,
absoluteExcludePaths=None,
relativeExcludePaths=None,
excludePatterns=None)
Constructor for the |
__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. Lists within this
class are "unordered" for equality comparisons.
|
_getAbsoluteExcludePaths(self)Property target used to get the absolute exclude paths list. |
_getAbsolutePath(self)Property target used to get the absolute path. |
_getArchiveMode(self)Property target used to get the archive mode. |
_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. |
_getRelativeExcludePaths(self)Property target used to get the relative exclude paths list. |
_setAbsoluteExcludePaths(self, value)Property target used to set the absolute exclude paths list. Either the value must beNone or each element must be an absolute
path. Elements do not have to exist on disk at the time of
assignment.
|
_setAbsolutePath(self, value)Property target used to set the absolute path. The value must be an absolute path if it is notNone . It does not have to exist
on disk at the time of assignment.
|
_setArchiveMode(self, value)Property target used to set the archive mode. If notNone , the mode must be one of the values in VALID_ARCHIVE_MODES .
|
_setCollectMode(self, value)Property target used to set the collect mode. If notNone , the mode must be one of the values in VALID_COLLECT_MODES .
|
_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 notNone .
|
_setRelativeExcludePaths(self, value)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 |
---|
absolutePathAbsolute path of the directory to collect.
|
collectModeOverridden collect mode for this directory.
|
archiveModeOverridden archive mode for this directory.
|
ignoreFileOverridden ignore file name for this directory.
|
absoluteExcludePathsList of absolute paths to exclude.
|
relativeExcludePathsList of relative paths to exclude.
|
excludePatternsList of regular expression patterns to exclude.
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Mon Dec 18 22:53:31 2006 | http://epydoc.sf.net |