A supercharged dict used as configuration
Project description
Documentation
Installation
$ pip install configdict
CheckedDict
A dictionary based on a default prototype. A CheckedDict can only define key:value pairs which are already present in the default. It is possible to define a docstring for each key and different restrictions for the values regarding possible values, ranges and type. A CheckedDict is useful for configuration settings.
ConfigDict
Based on CheckedDict, a ConfigDict is a persistent, unique dictionary. It is saved under the config folder determined by the OS and it is updated with each modification. It is useful for implementing configuration of a module / library / app, where there is a default/initial state and the user needs to be able to configure global settings which must be persisted between sessions (similar to the settings in an application)
Example
config = ConfigDict("myproj.subproj")
config.addKey("keyA", 10, doc="documentaion of keyA")
config.addKey("keyB", 0.5, range=(0, 1))
config.addKey("keyC", "blue", choices=("blue", "red"),
doc="documentation of keyC")
config.load()
Alternatively, a ConfigDict can be created all at once:
config = ConfigDict("myapp",
default = {
'font-size': 10.0,
'font-family': "Monospace",
'port' : 9100,
},
validator = {
'font-size::range' : (8, 24),
'port::range' : (9000, 65000),
'font-family::choices' : {'Roboto', 'Monospace'},
},
docs = {
'port': 'The port number to listen to',
'font-size': 'The size of the font, in pixels'
}
)
This will create the dictionary and load any persisted version. Any saved modifications will override the default values. Whenever the user changes any value (via config[key] = newvalue) the dictionary will be saved.
In all other respects a ConfigDict behaves like a normal dictionary.
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 Distributions
Built Distribution
Hashes for configdict-2.8.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fc688e38b813eea30676643070d35c89796ddc11f4d99826028af08b5b53913 |
|
MD5 | d66ef4fe9011cd1f88b511ca01ce34b1 |
|
BLAKE2b-256 | 4aaa44d5147f31d7115aedd422b4f3c004293ca17e81c82a518043f531d0b544 |