Two way configurations mapping helper for Python.
Project description
📄⇄🛠 Two way configurations mapping helper for Python.
Get Started
from biconfigs import Biconfigs
configs = Biconfigs('configs.json')
# Simply change the dict, and it will automatically save the changes to file.
configs['options'] = {'debug': True,
'username': 'Anthony',
'list': [] }
# Access with simple 'x.y.z' style
configs.options.list.append('example')
Content of file configs.json after execution:
{
"options": {
"debug": true,
"list": [
"example"
],
"username": "Anthony"
}
}
Install
pip install biconfigs
Dependencies
No dependencies required 🎉
Tested on Python 2.6, 2.7, 3.3, 3.4, 3.5, pypy, pypy3
Documentation
When to save
Saving when: Item create, item delete, list reorder, value change, ``get_set``, etc.
# All the following single statement will cause saving configs['item'] = 'value' configs['options'] = {} configs.options['list'] = [] configs.options.list.append('example') configs.options['list'] = [] configs.options.clear() value2 = configs.get_set('item2', 45)
Not saving when: Item access, assignment but not changed, etc.
# All the following single statement will NOT cause saving value = configs.item configs['item'] = 'value' # The value of 'item' is not changed value3 = configs.get('item_not_exists', 'default_value')
Non-blocking saving
By default, Biconfigs use asynchronous saving. You can disable the feature by setting async_write to False
# set "async_write=False" if your want to use synchronous saving
# to ensure your data saved to file in time,
# WARNING: In sync mode, your changes will block the incoming statement
# until the file correctly saved.
configs = Biconfigs('configs.json', async_write=False)
configs['item'] = 'value' # Blocking
# Configure file saved already
# Your code...
High frequency update
Normally, Biconfigs will write the changes to file immediately. But sometime you may want to update values frequently, which will result in a IO bottleneck. So you can use ``with`` statement to prevent auto saving for a while.
with configs:
for i in range(1000):
configs['some_key'] = i
# This statement will execute saving process only one time when exiting "with" scope
Get or set
Biconfigs provides a special function get_set for dict. The get_set acts just like dict.get(key, default), but it will save the default value to dict if the key is not exists.
For example:
# get_set will return the default value if the key is not exists
>>> self.config.get_set('item', 'value')
'value'
# get_set also set the default value to dict
>>> self.config.item
'value'
# get_set will just return the value of existing key
>>> self.config.get_set('item', 'new-value')
'value'
Reload from file
Simply use reload function to reload from file. Note: reload will discard all present data in Biconfigs-object and loads new ones from file)
configs.reload()
Parsers
Biconfigs use Prettified Json as default parser. You may want to set parser='json' to save as compacted json file.
configs = Biconfigs('configs.json', parser='json')
configs['item'] = 'value'
configs['debug'] = False
configs.json:
{"debug": false, "item": "value"}
Available Parsers - json: Compact JSON format - pretty-json: Prettified JSON - To be developed…
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for biconfigs-0.0.15-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0285f27c51bd24bcd33f6c69eb3b61a561d243b6f08be8142ae19d6210ac1f71 |
|
MD5 | 26b6f4ae81e14274736bc48ed3987a67 |
|
BLAKE2b-256 | 1b77a36eacb54cebf25fcf704aeda003a30a3bf74672e6ba520abc0136b8d67b |