Conf Fu
A configuration package that allows you to configure your Python scripts, through a combination of JSON configuration files and command line options, with a minimum of code.
Install
Install the package:
pip install conffu
Note: on Linux, you may need to install libffi-dev and re-install Python if installation causes a 'No module named _ctypes error'. This is not specific to conffu, but any package requiring _ctypes in one of its dependencies.
If you want to be able to read/write XML configurations as well, there is a dependency on lxml, install using:
pip install conffu[xml]
Example
With the package installed, try running this script:
from conffu import Config
cfg = Config({
'_globals': {
'temp': 'C:/Temp'
},
'temp_file': '{temp}/text.txt',
'number': 3
})
print(f'The number is {cfg.number}')
cfg.save('example_config.json')
After running that, this also works:
from conffu import Config
cfg = Config.from_file('example_config.json')
print(f'The number is {cfg.number}')
Make a change and save this script as example.py:
from conffu import Config
cfg = Config.from_file('example_config.json').update_from_arguments()
print(f'The number is {cfg.number}')
Then try running it like this:
python example.py -number 7
There's many more options, check the documentation for more examples.
Caveat
Note that Config allows you to do this:
from conffu import Config
cfg = Config()
cfg['test'] = 1
print(cfg.test) # prints 1
cfg.test = 2
print(cfg.test) # prints 2
That is, you're allowed to access configuration keys as if they were attributes on the configuration. However, if you try to access a key that happens to also be an attribute on the object, you get the attribute. This has the advantage that the feature doesn't break how objects work in Python, but the disadvantage that you'll need to access keys that have the same name as object attributes using the dictionary syntax. For example:
from conffu import Config
cfg = Config()
# create a new config value a
cfg['a'] = 1
# change the value of a, accessing it as you would a property / attribute
cfg.a = 2
# create a new object attribute b
cfg.b = 3
# this does not change the attribute b, because you're directly accessing a new config value b
cfg.['b'] = 4
print(cfg.a, cfg.b) # prints 2 3
print(cfg['a'], cfg['b']) # prints 2 4
If you don't like this behaviour, consider using the DictConfig class instead of Config - they are identical, except that the DictConfig does not have this behaviour and you must always access keys like cfg['test'], or cfg['key.subkey'].
If you do like the ability to access configuration values like attributes, you should take care that your code only assigns to existing values (initialise them as 'null' when creating the config from json for example), or that you use the dictionary syntax when assigning values and you only use the attribute syntax for reading values.
License
This project is licensed under the MIT license. See LICENSE.txt.
Changelog
See CHANGELOG.md.
2 maintainers
Metadata
2 maintainers
Release files for conffu 2.2.23
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| conffu-2.2.23.tar.gz | 25.2 kB | Without provenance | Details |
Release files / conffu-2.2.23.tar.gz
| Download URL | conffu-2.2.23.tar.gz |
|---|---|
| Size | 25.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
db9f8fca9d40def1adced276bc9386bbd5959b89a101f2e4f63a4e3ee7c35cb8
|
|
BLAKE2b-256 checksum How to use checksums |
1b951391004a0fcca2e4a7beefb712157f52edd058b21fada333c31dbc9de84e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.13
|
Security for conffu 2.2.23
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
