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

Type OptionsConfig

object --+
         |
        OptionsConfig


Class representing a Cedar Backup global options configuration.

The options section is used to store global configuration options and defaults that can be applied to other sections.

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:
Method Summary
  __init__(self, startingDay, workingDir, backupUser, backupGroup, rcpCommand, overrides, hooks)
Constructor for the OptionsConfig 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
  startingDay: Day that starts the week.
  workingDir: Working (temporary) directory to use for backups.
  backupUser: Effective user that backups should run as.
  backupGroup: Effective group that backups should run as.
  rcpCommand: Default rcp-compatible copy command for staging.
  overrides: List of configured command path overrides, if any.
  hooks: List of configured pre- and post-action hooks.

Method Details

__init__(self, startingDay=None, workingDir=None, backupUser=None, backupGroup=None, rcpCommand=None, overrides=None, hooks=None)
(Constructor)

Constructor for the OptionsConfig class.
Parameters:
startingDay - Day that starts the week.
workingDir - Working (temporary) directory to use for backups.
backupUser - Effective user that backups should run as.
backupGroup - Effective group that backups should run as.
rcpCommand - Default rcp-compatible copy command for staging.
overrides - List of configured command path overrides, if any.
hooks - List of configured pre- and post-action hooks.
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.
Parameters:
other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

Property Details

startingDay

Day that starts the week.

workingDir

Working (temporary) directory to use for backups.

backupUser

Effective user that backups should run as.

backupGroup

Effective group that backups should run as.

rcpCommand

Default rcp-compatible copy command for staging.

overrides

List of configured command path overrides, if any.

hooks

List of configured pre- and post-action hooks.

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