Home | Trees | Index | Help |
|
---|
Package CedarBackup2 :: Module config :: Class 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.
VALID_COLLECT_MODES
.
VALID_ARCHIVE_MODES
.
absoluteExcludePaths
must be an
absolute path
CollectFile
objects.
CollectDir
objects.
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.
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 | |
---|---|
Constructor for the CollectConfig 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 archive mode. | |
Property target used to get the collect dirs list. | |
Property target used to get the collect files list. | |
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 target directory. | |
Property target used to set the absolute exclude paths list. | |
Property target used to set the archive mode. | |
Property target used to set the collect dirs list. | |
Property target used to set the collect files list. | |
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 target directory. | |
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 | |
---|---|
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 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. |
_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 beNone or each element must be an absolute
path. Elements do 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 VALID_ARCHIVE_MODES .
|
_setCollectDirs(self, value)Property target used to set the collect dirs list. Either the value must beNone or each element must be a
CollectDir .
|
_setCollectFiles(self, value)Property target used to set the collect files list. Either the value must beNone or each element must be a
CollectFile .
|
_setCollectMode(self, value)Property target used to set the collect mode. If notNone , the mode must be one of 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 .
|
_setTargetDir(self, value)Property target used to set the target directory. The value must be an absolute path if it is notNone . It does not have to
exist on disk at the time of assignment.
|
Property Details |
---|
targetDirDirectory to collect files into.
|
collectModeDefault collect mode.
|
archiveModeDefault archive mode for collect files.
|
ignoreFileDefault ignore file name.
|
absoluteExcludePathsList of absolute paths to exclude.
|
excludePatternsList of regular expressions patterns to exclude.
|
collectFilesList of collect files.
|
collectDirsList of collect directories.
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Mon Dec 18 22:53:32 2006 | http://epydoc.sf.net |