tipy.drvr.Configuration

This class subclass the Configparser class. Configparser is used to read() a configuration file (ini format) in memory in the form of a dictionary associating sections and options. This class implement a new method which allow to retrieve and cast a configuration option and asserts the option do exists and can be casted. The config file could be edited by the user and you know... never trust user input.

getas(self, section, option, typeCast=None)

source code

A more secure way to retrieve configuration options.

This method check if the section and the option is in the configuration dictionary, else it raise an error. Also this method allow an optional parameter for casting the result before returning it. Allowed type casting are:

bool: cast to bool
int: cas to int
float: cast to float
list: cast to list
intlist: cast to list and cast each element to int
floatlist: cast to list and cast each element to float

The method makes sure the casting is possible.

Parameters:

section (str) - The section from which to retrieve the option.
option (str) - The option to retrieve inside the section.
typeCast - Indicate how to cast the result. If no value are passed the result is returned as a string.

Returns: str or int or bool or float or list (depends on "typeCast" param)

The casted value of the given option found inside the given section.

Raises:

MissingConfigurationSection - If the given section cannot be found in the configuration dictionary.
MissingConfigurationOption - If the given option cannot be found in the configuration dictionary.
UnknownTypeCastError - If the given typeCast value is not "bool", "int", "float", "list", "intlist" or "floatlist".

Class Configuration

init(self)
(Constructor)

getas(self, section, option, typeCast=None)

Class Configuration

__init__(self) (Constructor)

getas(self, section, option, typeCast=None)

init(self)
(Constructor)