Json config files with a statically defined structure.
Project description
staticconfig
Json config files with a staticly defined structure.
This is common code which I used accross many projects.
Usage
A config file's structure is defined by subclassing Config
and filling the constructor with attribute assignments.
Then a file is loaded with the from_json
classmethod:
- If the file exists, it returns an instance of the config class.
- If the file does not exist, it creates one and raises a ConfigError.
The class Namespace
provides syntactic sugar around dicts.
Example
from staticconfig import Namespace, Config
class MyConfig(Config):
def __init__(self):
super().__init__()
self.option1 = "default1"
self.option2 = 0
self.option3 = Namespace()
self.option3.suboption1 = True
self.option3.suboption2 = ["en", "de"]
# If the file doesn't exists this will create it with the default values and raise a ConfigError
config = MyConfig.from_json("config.json")
The produced config file:
{
"option1": "default1",
"option2": 0,
"option3": {
"suboption1": true,
"suboption2": [
"en",
"de"
]
}
}
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
staticconfig-0.0.2.tar.gz
(2.9 kB
view hashes)
Built Distribution
Close
Hashes for staticconfig-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8ae8f11cf8d0dc8ab67cde59635b4826b28805e7cb39c314aa7c64067c15fca |
|
MD5 | 69ec1ed52b2fe214774bfa2dca7596b2 |
|
BLAKE2b-256 | bb6225aa0d06774fc473b9bbe38583f64db9a2bea46ebcdaa6efa6d0a186c60c |