Home       Trees       Index       Help   
Package svnmailer :: Package settings :: Module _base :: Class BaseConfig
[show private | hide private]
[frames | no frames]

Class BaseConfig

object --+
         |
        BaseConfig

Known Subclasses:
FileConfig
Representation of the loaded config
Method Summary
  __init__(self, settingsobj)
Initialization
  __delitem__(self, section)
Removes a section to prevent further processing
iter __iter__(self)
Iterator over the section names
generator extractSection(self, section, xform, keep, check)
Returns the options of the specified section
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name...
  __getattribute__(...)
x.__getattribute__('name') <==> x.name...
  __hash__(x)
x.__hash__() <==> hash(x)...
  __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)...
    Inherited from type
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T...

Instance Variable Summary
str charset: Charset of the config file

Method Details

__init__(self, settingsobj)
(Constructor)

Initialization
Parameters:
settingsobj - The settings object
           (type=BaseSettings)
Overrides:
__builtin__.object.__init__

__delitem__(self, section)
(Index deletion operator)

Removes a section to prevent further processing
Parameters:
section - The section to remove
           (type=str)
Raises:
KeyError - The section doesn't exist

__iter__(self)

Iterator over the section names
Returns:
The section name iterator
           (type=iter)

extractSection(self, section, xform=True, keep=False, check=True)

Returns the options of the specified section

The section is also removed. (except keep is True)

Parameters:
self
section - The config section name
           (type=str)
Flags
xform - Shall the option names be normalized?
           (type=bool)
keep - Keep the section after processing?
           (type=bool)
check - Check the option name for sanity?
           (type=bool)
Returns:
A sequence of tuples ([('name', 'value'), ...])
           (type=generator)
Raises:
ConfigSectionNotFoundError - The specified section was not found in the config file
ConfigOptionUnkownError - There was an unknown config option.

Instance Variable Details

charset

Charset of the config file
Type:
str

   Home       Trees       Index       Help   
Generated by Epydoc 2.0 on Sun Sep 25 20:49:04 2005 http://epydoc.sf.net