config¶

Configuration module for global configuration settings.

class frequent.config.Configuration(*args, **kwargs)[source]¶

Bases: collections.abc.MutableMapping

Configuration storage object.

This object is basically a dict with some additional bells and whistles, including:

The ability to access/modify items like attributes.
Serialize to/from strings via dumps and loads.
save and load to/from files.
Easily convert standard dict objects with to_dict and from_dict.

Examples

This object works like a dict, where settings can be retrieved and set using:

>>> config = Configuration()
>>> config['answer'] = 42
>>> config['answer']
42

Additionally, you can nest settings using the . as a seperator, for instance:

>>> config['nested.setting'] = 'value'
>>> config['nested']
{'setting': 'value'}
>>> config['nested.setting']
'value'
>>> config['nested']['setting']
'value'

Furthermore, you can work with settings as if they were attributes:

>>> config.nested.setting
'value'
>>> config.dirs.temp = '/home/doug/tmp'
>>> config['dirs.temp']
'/home/doug/tmp'

clear() → None[source]¶: Clears all the settings stored in this configuration.

copy() → frequent.config.Configuration[source]¶

Creates a copy of this configuration object.

Returns: A copy of this configuration object.
Return type: Configuration

dumps(compact: bool = True, **kwargs) → str[source]¶

Serializes this configuration object to a string.

The default method uses the built-in python json library to convert this configuration to a JSON string. To use another method or format override this method.

Parameters: compact (bool, optional) – Make the returned representation as compact as possible (default is True).
Returns: String-serialized representation of this configuration.
Return type: str

classmethod from_dict(data: Dict[str, Any]) → frequent.config.Configuration[source]¶

Creates a configuration object from the given dict.

Parameters: data (dict) – Dictionary to generate the new configuration object with.
Returns: The new configuration from the given dictionary data.
Return type: Configuration

classmethod load(path: str, **kwargs) → frequent.config.Configuration[source]¶

Loads a configuration object from the file path specified.

Parameters

path (str) – File path to load the configuration object from.
kwargs (optional) – Additional parameters to pass through to the loads call.

Returns

The Configuration object loaded from the path given.

Return type

Configuration