Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Hipster-orgazmic tool to mange application settings

Project description

Pydantic settings

Hipster-orgazmic tool to mange application settings

Build Status PyPI version Documentation Status

Library which extends pydantic functionality in scope of application settings. Pydantic already have settings implementation, e.g. pydantic.BaseSettings, but from my point it's missing some useful features:

  1. Overriding settings values by environment variables even for nested fields
  2. Providing detailed information about value location inside a loaded file or environment variable, which helps to point user mistake
  3. Documenting model fields isn't feels comfortable, but it's really essential to write comprehensive documentation for application settings

NOTE: Alpha quality


Using pip:

pip install pydantic-settings

Usage example

Override values by env variables

Allows to override values for nested fields if they are represented as pydantic model.

Here is example:

from pydantic import BaseModel, ValidationError
from pydantic_settings import BaseSettingsModel

class Nested(BaseModel):
    foo: int

class Settings(BaseSettingsModel):
    nested: Nested

    Settings.from_env({'APP_nested_FOO': 'NOT AN INT'})
except ValidationError as e:
    assert e.raw_errors[0].env_loc == 'APP_nested_FOO'  # shows exact env variable name

Point exact error location inside file

from pydantic import BaseModel, IntegerError
from pydantic_settings import BaseSettingsModel, LoadingValidationError, load_settings, FileLocation

class Nested(BaseModel):
    foo: int

class Settings(BaseSettingsModel):
    nested: Nested

conf_text = """
    foo: 'NOT AN INT'

    load_settings(Settings, conf_text, type_hint='yaml')
except LoadingValidationError as e:
    assert e.raw_errors[0].loc == ('nested', 'foo')
    assert e.raw_errors[0].text_loc == FileLocation(line=3, col=10, end_line=3, end_col=22)
    assert isinstance(e.raw_errors[0].exc, IntegerError)

Extracts fields documentation

Allows to extract Sphinx style attributes documentation by processing AST tree of class definition

from pydantic_settings import BaseSettingsModel

class Foo(BaseSettingsModel):
    class Config:
        build_attr_docs = True

    bar: str
    """here is docs"""

    #: this style is't supported, but probably will be added in future
    baz: int

assert Foo.__fields__['bar'].schema.description == 'here is docs'
assert Foo.__fields__['baz'].schema.description is None  # :(

Online docs

Read more detailed documentation on the project Read The Docs page.

Development setup

Project requires poetry for development setup.

  • If you aren't have it already
pip install poetry
  • Install project dependencies
poetry install
  • Run tests
poetry run pytest .
  • Great, all works! Expect one optional step:

  • Install pre-commit for pre-commit hooks

pip install pre-commit
pre-commit install

That will install pre-commit hooks, which will check code with flake8 and black.

NOTE project uses black as code formatter, but i'am personally really dislike their "double quoted strings everywhere" style, that's why black -S should be used (anyway it's configured in pyproject.toml file)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pydantic-settings, version 0.1.2b0
Filename, size File type Python version Upload date Hashes
Filename, size pydantic_settings-0.1.2b0-py3-none-any.whl (21.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pydantic-settings-0.1.2b0.tar.gz (18.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page