svnmailer.settings.Settings

Package svnmailer :: Module settings :: Class Settings

[show private | hide private]

Type Settings

object --+
         |
        Settings

Known Subclasses:: ConfigFileSettings

Settings management

Note: The init method must be overridden to do the actual initialization.

Method Summary
	`__init__(self, args, *kwargs)` Constructor
`GroupSettingsContainer`	`getDefaultGroupContainer(self, **kwargs)` Returns an initialized default group settings container
`GeneralSettingsContainer`	`getGeneralContainer(self, **kwargs)` Returns an initialized general settings container
`GroupSettingsContainer`	`getGroupContainer(self, **kwargs)` Returns an initialized group settings container
`RuntimeSettingsContainer`	`getRuntimeContainer(self, **kwargs)` Returns an initialized runtime settings container
	`init(self, args, *kwargs)` Abstract initialization method
	`_checkInitialization(self)` Checks if all containers are filled
`list`	`_getArgs(self)` Returns the basic arguments for container initialization
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...
	`__repr__(x)` x.__repr__() <==> repr(x)...
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value...
	`__str__(x)` x.__str__() <==> str(x)...

Instance Variable Summary
`str`	`_charset_`: The charset used for settings recoding
`dict`	`_maps_`: The value mappers to use or `None`
`bool`	`debug`: Debug state
`GeneralSettingsContainer`	`general`: General settings
`list` of `GroupSettingsContainer`	`groups`: group settings list
`RuntimeSettingsContainer`	`runtime`: Runtime settigs

Method Details

init(self, *args, **kwargs)
(Constructor)

Constructor

Don't override this one. Override init() instead.

Overrides:: __builtin__.object.__init__

getDefaultGroupContainer(self, **kwargs)

Returns an initialized default group settings container

Returns:: The container object
(type=GroupSettingsContainer)

getGeneralContainer(self, **kwargs)

Returns an initialized general settings container

Returns:: The container object
(type=GeneralSettingsContainer)

getGroupContainer(self, **kwargs)

Returns an initialized group settings container

Returns:: The container object
(type=GroupSettingsContainer)

getRuntimeContainer(self, **kwargs)

Returns an initialized runtime settings container

Note that the runtime settings (from commandline) are always assumed to be utf-8 encoded.

Returns:: The container object
(type=RuntimeSettingsContainer)

init(self, *args, **kwargs)

Abstract initialization method

_checkInitialization(self)

Checks if all containers are filled

_getArgs(self)

Returns the basic arguments for container initialization

Returns:: The args
(type=list)

Instance Variable Details

_charset_

The charset used for settings recoding

Type:: str

_maps_

The value mappers to use or None

Type:: dict

debug

Debug state

Type:: bool

general

General settings

Type:: GeneralSettingsContainer

groups

group settings list

Type:: list of GroupSettingsContainer

runtime

Runtime settigs

Type:: RuntimeSettingsContainer

Generated by Epydoc 2.1 on Mon Apr 17 12:39:11 2006

http://epydoc.sf.net