dataclasses-configobj

Hydrate Data Classes from ini/dat/toml files.

Aims to be dataclasses-json, but for configobj.

This is very alpha right now, but the feaures which work, should work:

Usage

Define the shape of your config:

• Each subsection will be mapped to a nested class
• Each subsection may define a single _many
• A _many must have type List[...]
• The type of List of a _many shall have a _name

Example:

@dataclass
class Single:
    other: str

@dataclass
class OneOfMany:
    _name: str
    val: str

@dataclass
class Config:
    single: Single
    _many: List[OneOfMany]
    optional: Optional[str] = None
    withdefault: str = 'test123'

To load this .ini file:

[single]
other = hello
[one]
val = apple
[two]
val = banana

We can read, validate, and lift to an instance of Config with:

from configobj import ConfigObj
from dataclasses_configobj import lift, to_spec
from validate import Validator

spec = to_spec(Config)
co = ConfigObj(infile=infile, configspec=spec)

validator = Validator()
co.validate(validator)

config: Config = lift(Config, co)

To yield config:

Config(
    single=Single(other='hello'),
    optional=None,
    withdefault='test123'
    _many=[
        OneOfMany(_name='one', val='apple'),
        OneOfMany(_name='two', val='banana')
    ]
)