cfgparser 1.0.4

Python package that allows to parse typed JSON configs defined by python dataclasses

PythonConfigParser

easy, light-weight fully-typed python configs. not more, not less.

Usage

define your config stucture in a dataclass like

from dataclasses import dataclass
from typing import List

@dataclass
class DummyConfigElement:
    name: str
    list: List[int]
    another_list: List[float]

from file

First initialize the config parser with the path to the module with the config definitions.

parser = JSONConfigParser(datastructure_module_name="mysrc.datastructures.configs")
# Then parse the config from file.
my_config = parser.parse_from_file("myconfig.json")

from dictionary

my_config_dict = {"type_name" : "mysrc.datastructures.configs.a"}
my_config = JSONConfigParser().parse(my_config_dict)

type definition

There are two ways to define the configs type:

• specified in the config itself
  • e.g in the code example above
  • path to the config class must be specified as str in the config as key "type_name"
• specified when parsing the config
  • if the config has no key "typed_config" set, the type can be specified when parsing the config

from mysrc.datastructures.configs import a
my_config_dict = {"some_key" : "some_value"}
my_config = JSONConfigParser().parse_typed(my_config_dict,a)

Features

• fully typed json configs
• nested configs
• dict object into typed dataclass

Installation

pip install cfgparser

Coming Features

• yaml support
• typed optional support
• typed union support
• specify config from cli
• cd pipeline
• post hock
• distributed configs