Lightweight configuration with automatic dataclasses parsing (HOCON/JSON/YAML/PROPERTIES)
Project description
Dataconf
Lightweight configuration with automatic dataclasses parsing (hocon/json/yaml/properties files).
Getting started
Requires at least Python 3.8.
# pypi
pip install dataconf
poetry add dataconf
# master
pip install --upgrade git+https://github.com/zifeo/dataconf.git
poetry add git+https://github.com/zifeo/dataconf.git
# dev
poetry install
pre-commit install
Usage
from dataclasses import dataclass, field
from typing import List, Dict, Text, Union
from dateutil.relativedelta import relativedelta
import dataconf
conf = """
str_name = test
str_name = ${HOSTNAME}
float_num = 2.2
list_data = [
a
b
]
nested {
a = test
}
nested_list = [
{
a = test1
}
]
duration = 2s
union = 1
"""
@dataclass
class Nested:
a: Text
@dataclass
class Config:
str_name: Text
float_num: float
list_data: List[Text]
nested: Nested
nested_list: List[Nested]
duration: relativedelta
union: Union[Text, int]
default: Text = 'hello'
default_factory: Dict[Text, Text] = field(default_factory=dict)
print(dataconf.load(conf, Config))
# TestConf(test='pc.home', float=2.1, default='hello', list=['a', 'b'], nested=Nested(a='test'), nested_list=[Nested(a='test1')], duration=relativedelta(seconds=+2), default_factory={}, union=1)
import dataconf
conf = dataconf.loads('confs/test.hocon', Config)
conf = dataconf.loads('confs/test.json', Config)
conf = dataconf.loads('confs/test.yaml', Config)
conf = dataconf.loads('confs/test.properties', Config)
dataconf.dumps('confs/test.hocon', out='hocon')
dataconf.dumps('confs/test.json', out='json')
dataconf.dumps('confs/test.yaml', out='yaml')
dataconf.dumps('confs/test.properties', out='properties')
Follows same api as python JSON package (e.g. load
, loads
, dump
, dumps
).
For full HOCON capabilities see here.
CI
dataconf -c confs/test.hocon -m tests.configs -d TestConf -o hocon
# dataconf.exceptions.TypeConfigException: expected type <class 'datetime.timedelta'> at .duration, got <class 'int'>
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
dataconf-0.1.5.tar.gz
(9.6 kB
view hashes)
Built Distribution
dataconf-0.1.5-py3-none-any.whl
(10.7 kB
view hashes)