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

Class OptionsConfig

source code

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:

Instance Methods [hide private]
 
__init__(self, startingDay=None, workingDir=None, backupUser=None, backupGroup=None, rcpCommand=None, overrides=None, hooks=None)
Constructor for the OptionsConfig class.
source code
 
__repr__(self)
Official string representation for class instance.
source code
 
__str__(self)
Informal string representation for class instance.
source code
 
__cmp__(self, other)
Definition of equals operator for this class.
source code
 
_setStartingDay(self, value)
Property target used to set the starting day.
source code
 
_getStartingDay(self)
Property target used to get the starting day.
source code
 
_setWorkingDir(self, value)
Property target used to set the working directory.
source code
 
_getWorkingDir(self)
Property target used to get the working directory.
source code
 
_setBackupUser(self, value)
Property target used to set the backup user.
source code
 
_getBackupUser(self)
Property target used to get the backup user.
source code
 
_setBackupGroup(self, value)
Property target used to set the backup group.
source code
 
_getBackupGroup(self)
Property target used to get the backup group.
source code
 
_setRcpCommand(self, value)
Property target used to set the rcp command.
source code
 
_getRcpCommand(self)
Property target used to get the rcp command.
source code
 
_setOverrides(self, value)
Property target used to set the command path overrides list.
source code
 
_getOverrides(self)
Property target used to get the command path overrides list.
source code
 
_setHooks(self, value)
Property target used to set the pre- and post-action hooks list.
source code
 
_getHooks(self)
Property target used to get the command path hooks list.
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__

Properties [hide private]
  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.

Inherited from object: __class__

Method Details [hide private]

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

source code 
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: object.__init__

__repr__(self)
(Representation operator)

source code 
Official string representation for class instance.
Overrides: object.__repr__

__str__(self)
(Informal representation operator)

source code 
Informal string representation for class instance.
Overrides: object.__str__

__cmp__(self, other)
(Comparison operator)

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

_setStartingDay(self, value)

source code 
Property target used to set the starting day. If it is not None, the value must be a valid English day of the week, one of "monday", "tuesday", "wednesday", etc.
Raises:
  • ValueError - If the value is not a valid day of the week.

_setWorkingDir(self, value)

source code 
Property target used to set the working 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.

_setBackupUser(self, value)

source code 
Property target used to set the backup user. The value must be a non-empty string if it is not None.
Raises:
  • ValueError - If the value is an empty string.

_setBackupGroup(self, value)

source code 
Property target used to set the backup group. The value must be a non-empty string if it is not None.
Raises:
  • ValueError - If the value is an empty string.

_setRcpCommand(self, value)

source code 
Property target used to set the rcp command. The value must be a non-empty string if it is not None.
Raises:
  • ValueError - If the value is an empty string.

_setOverrides(self, value)

source code 
Property target used to set the command path overrides list. Either the value must be None or each element must be a CommandOverride.
Raises:
  • ValueError - If the value is not a CommandOverride

_setHooks(self, value)

source code 
Property target used to set the pre- and post-action hooks list. Either the value must be None or each element must be an ActionHook.
Raises:
  • ValueError - If the value is not a CommandOverride

Property Details [hide private]

startingDay

Day that starts the week.
Get Method:
CedarBackup2.config.OptionsConfig._getStartingDay(self) - Property target used to get the starting day.
Set Method:
CedarBackup2.config.OptionsConfig._setStartingDay(self, value) - Property target used to set the starting day.

workingDir

Working (temporary) directory to use for backups.
Get Method:
CedarBackup2.config.OptionsConfig._getWorkingDir(self) - Property target used to get the working directory.
Set Method:
CedarBackup2.config.OptionsConfig._setWorkingDir(self, value) - Property target used to set the working directory.

backupUser

Effective user that backups should run as.
Get Method:
CedarBackup2.config.OptionsConfig._getBackupUser(self) - Property target used to get the backup user.
Set Method:
CedarBackup2.config.OptionsConfig._setBackupUser(self, value) - Property target used to set the backup user.

backupGroup

Effective group that backups should run as.
Get Method:
CedarBackup2.config.OptionsConfig._getBackupGroup(self) - Property target used to get the backup group.
Set Method:
CedarBackup2.config.OptionsConfig._setBackupGroup(self, value) - Property target used to set the backup group.

rcpCommand

Default rcp-compatible copy command for staging.
Get Method:
CedarBackup2.config.OptionsConfig._getRcpCommand(self) - Property target used to get the rcp command.
Set Method:
CedarBackup2.config.OptionsConfig._setRcpCommand(self, value) - Property target used to set the rcp command.

overrides

List of configured command path overrides, if any.
Get Method:
CedarBackup2.config.OptionsConfig._getOverrides(self) - Property target used to get the command path overrides list.
Set Method:
CedarBackup2.config.OptionsConfig._setOverrides(self, value) - Property target used to set the command path overrides list.

hooks

List of configured pre- and post-action hooks.
Get Method:
CedarBackup2.config.OptionsConfig._getHooks(self) - Property target used to get the command path hooks list.
Set Method:
CedarBackup2.config.OptionsConfig._setHooks(self, value) - Property target used to set the pre- and post-action hooks list.