Package gnue :: Package common :: Package apps :: Module GConfig
[show private | hide private]

Module gnue.common.apps.GConfig

Class that loads the configuration files so gnue apps can get default settings.
Classes
GConfig Configuration manager for GNU Enterprise Applications
GConfigAlias This class provides access to the configuration options of a given section in a configuration file
GConfigParser Add support for our GTypecast systems to the generic ConfigParser

Exceptions
InvalidFormatError Configuration file cannot be parsed

Function Summary
  getInstalledBase(*parameters)
This method is deprecated.
unicode printable_config_options(options, output_width)
Create a human readable description of the given set of configuration options.
  _build_defaults(definitions)
Create a dictionary of default values for all configuration option listed in the given definitions dictionary.
  get_installed_base(*parameters)
Returns the first matching item of the arguments in the _site_config dictionary.

Variable Summary
dict _site_config = {'common_shared': '/usr/local/gnue-sandbo...

Function Details

getInstalledBase(*parameters)

This method is deprecated. Please use get_installed_base() instead.

printable_config_options(options, output_width=60)

Create a human readable description of the given set of configuration options.
Parameters:
options - list of dictionaries with at least 'Name', 'Default' and 'Description' keys
output_width - maximum length of a single text line
Returns:
the human readable description of all options
           (type=unicode)

_build_defaults(definitions)

Create a dictionary of default values for all configuration option listed in the given definitions dictionary.
Parameters:
definitions - dictionary of configuration options
Returns:
dictionary with default values where the option name is the key and it's default the value

get_installed_base(*parameters)

Returns the first matching item of the arguments in the _site_config dictionary.

Variable Details

_site_config

Type:
dict
Value:
{'common_appbase': '/usr/local/gnue-sandbox/gnue',
 'common_etc': '/usr/local/gnue-sandbox/gnue/etc',
 'common_images': '/usr/local/gnue-sandbox/gnue/share/gnue/images',
 'common_shared': '/usr/local/gnue-sandbox/gnue/share/gnue',
 'install_prefix': '/usr/local/gnue-sandbox/gnue'}                     


GNUe Home

Private API

Developer's Corner