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

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

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.

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

Method Summary
  __init__(self, absolutePath, collectMode, archiveMode, ignoreFile, absoluteExcludePaths, relativeExcludePaths, excludePatterns)
Constructor for the CollectDir 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
  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)

Constructor for the CollectDir class.
Parameters:
absolutePath - Absolute path of the directory to collect.
collectMode - Overridden collect mode for this directory.
archiveMode - Overridden archive mode for this directory.
ignoreFile - Overidden 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.
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

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.

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