comprehensiveconfig 1.1.1

A library to create ergonomic, auto-validated configuration models with great support for static type annotations.

Comprehensive Configuration

A simple configuration library that lets you create a pydantic-like model for your configuration.

Installation

pip install comprehensiveconfig

Features

• Supports static type checking
• toml writer
• json writer
• Number Fields
• Text Fields (with regex filtering)
• List fields
• Table fields
• TableSpec (Model) fields
• Sections
• Include doc comments in Section
• auto loading
• initialize default config (with auto loader)
• yaml writer
• Tests targetting mypy and other static type checkers to ensure EVERYTHING looks good across IDE's
• section list (via a Table field)
• Field type unions (overwriting normal union syntax)
• per attribute doc comments (inline and noninline)
• enum support (Via spec.ConfigEnum and python's enum.Enum)
• fully supported string escapes

Example (Python)

# example.py
from comprehensiveconfig import ConfigSpec
from comprehensiveconfig.spec import Section, Integer, Float, Text, List
from comprehensiveconfig.toml import TomlWriter

class MyConfigSpec(ConfigSpec,
                   default_file="myconfig.toml",
                   writer=TomlWriter,
                   create_file=True):
    class MySection(Section, name="My_Section"):
        some_field = Integer(10)
        other_field = Text("Some Default Text")

        class SubSection(Section):
            '''An example Sub Section'''
            x = Integer(10)

    class Credentials(Section):
        '''Example credentials section'''
        email = Text("[e-mail]", regex=r"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$")
        password = Text("MyPassword")

    some_field = Float(6.9)
    list_of_stuff = List(["12", "13", "14"], inner_type=Text())


# Accessing values from globally loaded config (if one exists, otherwise it accesses the actual Field class)
print(MyConfigSpec.some_field)
print(MyConfigSpec.MySection.other_field)

# Another way to open configuration
second_config = MyConfigSpec.load("another_config.toml", TomlWriter)

Example (toml output)

some_field = 6.9
list_of_stuff = ["12", "13", "14"]

[My_Section]
some_field = 10
other_field = "Some Default Text"

[My_Section.SubSection]
# An example Sub Section
x = 10

[Credentials]
# Example credentials section
email = "[e-mail]"
password = "MyPassword"