Configs: Configuration for Humans¶
Parsing INI configs must be easy, as are the INI files.
Configs provides a simple API for getting data from INI config files.
Loading data from a config is as easy as configs.load('my.conf').
Configs work with Python 2.7+.
The repo is at bitbucket.org/moigagoo/configs.
Features¶
- Root-level params support
- Numeric and boolean values are converted automatically
- Sections with only key-value items are parsed as dicts
- Sections with only flag items (keys with no value) are parsed as lists
- Mixed content sections are parsed as tuples of a dict and a list, which can be accessed individually
- Sections are iterable (even the mixed ones; list first, dict second)
- Comments support
Usage¶
Sample config file (sample.conf):
path = some_path
[general]
foo = baz
[list_section]
7.1
42
[new_section]
new_key = new_value
[mixed]
prop = val
flag
boolean = False
;Commented lines
;are ignored
Load the file:
>>> import configs
>>> c = configs.load('sample.conf')
Get all values:
>>> c
{'root': {'path': 'some_path'}, 'new_section': {'new_key': 'new_value'}, 'mixed': (['flag'], {'prop': 'val', 'boolean': False}), 'general': {'foo': 'baz'}, 'list_section': [7.1, 42]}
Get section:
>>> c['general']
{'foo': 'baz'}
Get a single value:
>>> c['general']['foo']
baz
>>> c['path']
some_path
>>> c['root']['path']
some_path
>>> c['list_section'][1]
42
Numeric values are parsed as numbers:
>>> c['list_section'][1] + 3
45
>>> c['list_section'][0] * 2
14.2
Iterate over a section:
>>> for key in c['general']:
print(key, c['general'][key])
foo baz
>>> for value in c['list_section']:
print(value)
7.1
42
>>> for mix in c['mixed']:
print(mix)
flag
prop
>>> c['mixed'].dict_props
{'prop': 'val'}
>>> c['mixed'].list_props
flag
Fallback Config¶
New in version 1.4.
It is possible to define a fallback configuration when loading a config.
If the loaded config does not have some values defined in the fallback config, the default values will be used.
Fallback config file (default.conf):
top_level = value
path = ../
url = http://example.com
[general]
spam = eggs
foo = bar
[list_section]
1
2.2
3
;Commented line
Use the optional fallback_file parameter of the load method:
>>> fc = configs.load('sample.conf', fallback_file='default.conf')
>>> fc
{'list_section': [1, 2.2, 3, 7.1, 42], 'new_section': {'new_key': 'new_value'}, 'root': {'url': 'http://example.com', 'top_level': 'value', 'path': 'some_path'}, 'general': {'spam': 'eggs', 'foo': 'baz'}, 'mixed': (['flag'], {'prop': 'val'})}
>>> fc['general']['spam']
eggs
The defaults Dict¶
New in version 2.0.5.
You can pass a dict of default values to be loaded into the root section in the defaults param of the load method:
>> dc = configs.load('sample.conf', defaults={'defaul_key': 'default_value'})
>>> dc
{'list_section': [1, 2.2, 3, 7.1, 42], 'new_section': {'new_key': 'new_value'}, 'root': {'url': 'http://example.com', 'top_level': 'value', 'path': 'some_path', 'defaul_key': 'default_value'}, 'general': {'spam': 'eggs', 'foo': 'baz'}, 'mixed': (['flag'], {'prop': 'val'})}
>>> fc['defaul_key']
default_value
New in version 2.0.1.
Boolean values are converted automatically.
Use the special True and False values to declare boolean type (case matters!):
this_is_a_boolean_value = True
this_is_a_string = true
this_is_a_number = 1
