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

Type StageConfig

object --+
         |
        StageConfig


Class representing a Cedar Backup stage 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:

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

Method Summary
  __init__(self, targetDir, localPeers, remotePeers)
Constructor for the StageConfig 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.
  _getLocalPeers(self)
Property target used to get the local peers list.
  _getRemotePeers(self)
Property target used to get the remote peers list.
  _getTargetDir(self)
Property target used to get the target directory.
  _setLocalPeers(self, value)
Property target used to set the local peers list.
  _setRemotePeers(self, value)
Property target used to set the remote peers list.
  _setTargetDir(self, value)
Property target used to set the target directory.
    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 stage files into, by peer name.
  localPeers: List of local peers.
  remotePeers: List of remote peers.

Method Details

__init__(self, targetDir=None, localPeers=None, remotePeers=None)
(Constructor)

Constructor for the StageConfig class.
Parameters:
targetDir - Directory to stage files into, by peer name.
localPeers - List of local peers.
remotePeers - List of remote peers.
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.

_getLocalPeers(self)

Property target used to get the local peers list.

_getRemotePeers(self)

Property target used to get the remote peers list.

_getTargetDir(self)

Property target used to get the target directory.

_setLocalPeers(self, value)

Property target used to set the local peers list. Either the value must be None or each element must be a LocalPeer.
Raises:
ValueError - If the value is not an absolute path.

_setRemotePeers(self, value)

Property target used to set the remote peers list. Either the value must be None or each element must be a RemotePeer.
Raises:
ValueError - If the value is not a RemotePeer

_setTargetDir(self, value)

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

Property Details

targetDir

Directory to stage files into, by peer name.
Get Method:
_getTargetDir(self)
Set Method:
_setTargetDir(self, value)

localPeers

List of local peers.
Get Method:
_getLocalPeers(self)
Set Method:
_setLocalPeers(self, value)

remotePeers

List of remote peers.
Get Method:
_getRemotePeers(self)
Set Method:
_setRemotePeers(self, value)

Generated by Epydoc 2.1 on Thu Dec 22 20:45:14 2005 http://epydoc.sf.net