vmm: comparison VirtualMailManager/Config.py

equal deleted inserted replaced

-:efa1327b721f
+:c705a9e38962
 """
 VirtualMailManager.Config
 VMM's configuration module for simplified configuration access.
-This module defines a few classes:
-``LazyConfig``
-This class provides the following additonal methods
-* `LazyConfig.pget()`
-polymorphic getter which returns the value with the appropriate
-type.
-* `LazyConfig.dget()`
-like *pget()*, but checks additonal for default values in
-`LazyConfig._cfg`.
-* `LazyConfig.set()`
-like `RawConfigParser.set()`, but converts the new value to the
-appropriate type/class and optional validates the new value.
-* `LazyConfig.bool_new()`
-converts data from raw_input into boolean values.
-* `LazyConfig.get_boolean()`
-like `RawConfigParser.getboolean()`, but doesn't fail on real
-`bool` values.
-``Config``
-The Config class used by vmm.
-``LazyConfigOption``
-The class for the configuration objects in the ``Config`` class'
-``_cfg`` dictionary.
 """
 from ConfigParser import \
 Error, MissingSectionHeaderError, NoOptionError, NoSectionError, \
 class LazyConfig(RawConfigParser):
 """The **lazy** derivate of the `RawConfigParser`.
 There are two additional getters:
-`LazyConfig.pget()`
+`pget()`
 The polymorphic getter, which returns a option's value with the
 appropriate type.
-`LazyConfig.dget()`
+`dget()`
 Like `LazyConfig.pget()`, but returns the option's default, from
 `LazyConfig._cfg['sectionname']['optionname'].default`, if the
 option is not configured in a ini-like configuration file.
+`set()` differs from `RawConfigParser`'s `set()` method. `set()` takes
-`LazyConfig.set()` differs from ``RawConfigParser``'s ``set()`` method.
+the `section` and `option` arguments combined to a single string in the
-``LazyConfig.set()`` takes the ``section`` and ``option`` arguments
+form "section.option".
-combined to a single string in the form
-"``section``\ **.**\ ``option``".
 """
 def __init__(self):
 RawConfigParser.__init__(self)
 self._modified = False
 """sample _cfg dictionary. Create your own in your derived class."""
 def bool_new(self, value):
 """Converts the string `value` into a `bool` and returns it.
-| '1', 'on', 'yes' and 'true' will become ``True``
+| '1', 'on', 'yes' and 'true' will become `True`
-| '0', 'off', 'no' and 'false' will become ``False``
+| '0', 'off', 'no' and 'false' will become `False`
-Throws a `ConfigValueError` for all other values, except ``bool``\ s.
+Throws a `ConfigValueError` for all other values, except bools.
 """
 if isinstance(value, bool):
 return value
 if value.lower() in self._boolean_states:
 return self._boolean_states[value.lower()]
 """Returns the value of the `option`."""
 section, option = self._get_section_option(option)
 return self._cfg[section][option].getter(section, option)
 def set(self, option, value):
-"""Set the value of an option.
+"""Set the `value` of the `option`.
-Throws a ``ValueError`` if `value` couldn't be converted to
+Throws a `ValueError` if `value` couldn't be converted using
-``LazyConfigOption.cls``"""
+`LazyConfigOption.cls`"""
 section, option = self._get_section_option(option)
 val = self._cfg[section][option].cls(value)
 if self._cfg[section][option].validate:
 val = self._cfg[section][option].validate(val)
 if not RawConfigParser.has_section(self, section):
 self.add_section(section)
 RawConfigParser.set(self, section, option, val)
 self._modified = True
 def has_section(self, section):
-"""Checks if ``section`` is a known configuration section."""
+"""Checks if `section` is a known configuration section."""
 return section.lower() in self._cfg
 def has_option(self, option):
-"""Checks if the option (section\ **.**\ option) is a known
+"""Checks if the option (section.option) is a known configuration
-configuration option."""
+option."""
 try:
 self._get_section_option(option)
 return True
 except(BadOptionError, NoSectionError, NoOptionError):
 return False
 class LazyConfigOption(object):
 """A simple container class for configuration settings.
-``LazyConfigOption`` instances are required by `LazyConfig` instances,
+`LazyConfigOption` instances are required by `LazyConfig` instances,
-and instances of classes derived from ``LazyConfig``, like the
+and instances of classes derived from `LazyConfig`, like the
 `Config` class.
 """
 __slots__ = ('__cls', '__default', '__getter', '__validate')
 def __init__(self, cls, default, getter, validate=None):
-"""Creates a new ``LazyConfigOption`` instance.
+"""Creates a new `LazyConfigOption` instance.
 Arguments:
-``cls`` : type
+`cls` : type
 The class/type of the option's value
-``default``
+`default`
-Default value of the option. Use ``None`` if the option should
+Default value of the option. Use ``None`` if the option should not
-not have a default value.
+have a default value.
-``getter`` : callable
+`getter` : callable
-A method's name of `RawConfigParser` and derived classes, to
+A method's name of `RawConfigParser` and derived classes, to get a
-get a option's value, e.g. `self.getint`.
+option's value, e.g. `self.getint`.
-``validate`` : NoneType or a callable
+`validate` : NoneType or a callable
-None or any method, that takes one argument, in order to check
+None or any method, that takes one argument, in order to check the
-the value, when `LazyConfig.set()` is called.
+value, when `LazyConfig.set()` is called.
 """
 self.__cls = cls
 if not default is None:# enforce the type of the default value
 self.__default = self.__cls(default)
 else:
 """The class of the option's value e.g. `str`, `unicode` or `bool`"""
 return self.__cls
 @property
 def default(self):
-"""The option's default value, may be ``None``"""
+"""The option's default value, may be `None`"""
 return self.__default
 @property
 def getter(self):
 """The getter method or function to get the option's value"""
 def __init__(self, filename):
 """Creates a new Config instance
 Arguments:
-``filename``
+`filename` : str
 path to the configuration file
 """
 LazyConfig.__init__(self)
 self._cfgFileName = filename
 self._cfgFile = None
 self.__missing = {}
 for option in options:
 errmsg.write((u'    %s\n') % option)
 raise VMMConfigException(errmsg.getvalue(), CONF_ERROR)
 def known_scheme(self, scheme):
-"""Converts ``scheme`` to upper case and checks if is known by
+"""Converts `scheme` to upper case and checks if is known by
 Dovecot (listed in VirtualMailManager.SCHEMES).
 Throws a `ConfigValueError` if the scheme is not listed in
 VirtualMailManager.SCHEMES.
 """
 scheme = scheme.upper()
 # TODO: VMM.SCHEMES
 def unicode(self, section, option):
-"""Returns the value of the ``option`` from ``section``, converted
+"""Returns the value of the `option` from `section`, converted to
-to Unicode.
+Unicode."""
-"""
 return get_unicode(self.get(section, option))
 def __chkCfg(self):
 """Checks all section's options for settings w/o a default value.
-Returns ``True`` if everything is fine, else ``False``."""
+Returns `True` if everything is fine, else `False`."""
 errors = False
 for section in self._cfg.iterkeys():
 missing = []
 for option, value in self._cfg[section].iteritems():
 if (value.default is None and

branch	v0.6.x
changeset 209	c705a9e38962
parent 207	95be8f62bc0c
child 211	0b129678cfe1