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

Property Details

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.

Generated by Epydoc 2.1 on Mon Sep 4 13:49:34 2006 http://epydoc.sf.net