| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778 |
- .. This is a autogemerated documentation from python docstrings. It was generated using DStrings2Doc.
- .. module:: config
- .. _config:
- Module config
- =============
- Configuration Module.
- This reads the configuration file and conveniently makes the settings available to KCG
- .. py:class:: NoValueException(Exception)
- Simple Exception that gets thrown when no Value was given in the configuration file
- .. py:class:: MisconfigurationError(Exception)
- Simple Exception to indicate that a misconfiguration was found.
- .. py:method:: leval(string)
- Wrapper arount ast.literal_eval that throws NoValueException if the value was empty
- :param string:
- .. py:class:: ConfSection(object)
- Class to handle a section in the configuration.
- .. py:method:: __init__(self, section, settings, config_object, default_config_object=None, log_level=logging.ERROR)
- .. py:method:: feed_arguments(self, arg_dict)
- Feed this section with commandline arguments for this section. The given arguments will
- override the ones in configuration files.
- :param arg_dict: the dictionary for all sections
- .. py:method:: read(self)
- Read and evaluate configuration settings.
- .. py:class:: Configuration(object)
- Class to handle configuration
- .. py:method:: __init__(self, args=None, log_level=logging.INFO)
- .. py:method:: parse_command_line(self)
- Parses the command line configuration arguments
- .. py:method:: read(self)
- This function reads the configuration file and the default config fille (in case the
- user config file does not contain all values) and adds them as parameters to this module
- .. py:method:: setup(self)
- Check for the user config file and if not exists calls doSetup
- .. py:method:: doSetup(self, rerun=False, parent=None)
- Shows the initial config dialog
|
