structconf 0.3.0

struct config using yaml

StructConf

Config your project with yaml and validation.

Enjoy wirting your code with IDEs python type hint

Simple Usage

1. Define your configuration class, with attribute type and default value

from structconf import StructConf

class SimpleConf(StructConf):
    a: int = 1
    b: str = "b"

2. write your yaml config file (e.g simple.yaml)

a: 2
b: "123"

3. load yaml config file to your struct class

conf = SimpleConf.load("simple.yaml")
assert conf.a == 2
assert conf.b == "123"

Advanced Usage

StructConf use pydantic to validate your yaml and python class. So we can use recursive modelto build complex configuration.

from structconf import StructConf

class AConf(StructConf):
    a: int = 1


class BConf(StructConf):
    b: int = 2


class ComplexConf(StructConf):
    aconf: AConf = AConf()
    bconf: BConf = BConf()