Package CedarBackup2 :: Package extend :: Module mbox :: Class MboxDir
[show private | hide private]
[frames | no frames]

Type MboxDir

object --+
         |
        MboxDir


Class representing mbox directory configuration..

The following restrictions exist on data in this class: Unlike collect directory configuration, this is the only place exclusions are allowed (no global exclusions at the <mbox> configuration level). Also, we only allow relative exclusions and there is no configured ignore file. This is because mbox directory backups are not recursive.
Method Summary
  __init__(self, absolutePath, collectMode, compressMode, relativeExcludePaths, excludePatterns)
Constructor for the MboxDir 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.
  _getAbsolutePath(self)
Property target used to get the absolute path.
  _getCollectMode(self)
Property target used to get the collect mode.
  _getCompressMode(self)
Property target used to get the compress mode.
  _getExcludePatterns(self)
Property target used to get the exclude patterns list.
  _getRelativeExcludePaths(self)
Property target used to get the relative exclude paths list.
  _setAbsolutePath(self, value)
Property target used to set the absolute path.
  _setCollectMode(self, value)
Property target used to set the collect mode.
  _setCompressMode(self, value)
Property target used to set the compress mode.
  _setExcludePatterns(self, value)
Property target used to set the exclude patterns list.
  _setRelativeExcludePaths(self, value)
Property target used to set the relative exclude paths list.
    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 to the mbox directory.
  collectMode: Overridden collect mode for this mbox directory.
  compressMode: Overridden compress mode for this mbox directory.
  relativeExcludePaths: List of relative paths to exclude.
  excludePatterns: List of regular expression patterns to exclude.

Method Details

__init__(self, absolutePath=None, collectMode=None, compressMode=None, relativeExcludePaths=None, excludePatterns=None)
(Constructor)

Constructor for the MboxDir class.

You should never directly instantiate this class.
Parameters:
absolutePath - Absolute path to a mbox file on disk.
collectMode - Overridden collect mode for this directory.
compressMode - Overridden compression mode for this directory.
relativeExcludePaths - List of relative paths to exclude.
excludePatterns - List of regular expression patterns to exclude
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.
Parameters:
other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

_getAbsolutePath(self)

Property target used to get the absolute path.

_getCollectMode(self)

Property target used to get the collect mode.

_getCompressMode(self)

Property target used to get the compress mode.

_getExcludePatterns(self)

Property target used to get the exclude patterns list.

_getRelativeExcludePaths(self)

Property target used to get the relative exclude paths list.

_setAbsolutePath(self, value)

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

_setCollectMode(self, value)

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

_setCompressMode(self, value)

Property target used to set the compress mode. If not None, the mode must be one of the values in VALID_COMPRESS_MODES.
Raises:
ValueError - If the value is not valid.

_setExcludePatterns(self, value)

Property target used to set the exclude patterns list.

_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

absolutePath

Absolute path to the mbox directory.
Get Method:
_getAbsolutePath(self)
Set Method:
_setAbsolutePath(self, value)

collectMode

Overridden collect mode for this mbox directory.
Get Method:
_getCollectMode(self)
Set Method:
_setCollectMode(self, value)

compressMode

Overridden compress mode for this mbox directory.
Get Method:
_getCompressMode(self)
Set Method:
_setCompressMode(self, value)

relativeExcludePaths

List of relative paths to exclude.
Get Method:
_getRelativeExcludePaths(self)
Set Method:
_setRelativeExcludePaths(self, value)

excludePatterns

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

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