liblaf-conf lets Python applications define typed configuration once, load it
from environment variables, and apply scoped runtime overrides with
contextvars.
✨ Features
- 🧩 Descriptor-based config models: Build config objects from
BaseConfig,Field, andgroup()instead of wiring ad hoc globals or nested dicts. - 🌱 Environment-ready defaults: Bind fields to derived or explicit
environment variable names and refresh a whole config tree with
load_env(). - 🎯 Typed helper factories: Reach for
field_bool,field_json,field_path, and the temporal helpers for one conversion path shared by environment values and direct assignments. - 🔄 Context-local overrides: Use
Var.override()orBaseConfig.override()to change values temporarily without leaking across contexts. - 🪺 Nested serialization helpers: Compose related sections and export the
active state with
to_dict()orto_namespace().
📦 Installation
[!NOTE]
liblaf-confsupports Python 3.12 and newer.
uv add liblaf-conf
🚀 Quick Start
from liblaf import conf
class DatabaseConfig(conf.BaseConfig):
url: conf.Field[str] = conf.field_str(default="sqlite:///app.db")
class AppConfig(conf.BaseConfig):
debug: conf.Field[bool] = conf.field_bool(default=False)
allowed_hosts: conf.Field[list[str]] = conf.field_list_str(
factory=lambda: ["localhost"]
)
database: conf.Group[DatabaseConfig] = conf.group(DatabaseConfig)
cfg = AppConfig()
cfg.set(database={"url": "sqlite:///dev.db"})
cfg.load_env()
cfg.debug.set(True)
with cfg.override(debug=False):
assert cfg.debug.get() is False
assert cfg.to_dict() == {
"debug": True,
"allowed_hosts": ["localhost"],
"database": {"url": "sqlite:///dev.db"},
}
BaseConfig subclasses are cached singletons, so AppConfig() returns the
same config object each time while each field still stores its active value in
a ContextVar. Mutable defaults are copied when first read in each context;
use a factory when constructing the value needs more than a copy.
Semantics
load_env(), set(), and override() affect only the active contextvars
context. Child async tasks inherit values when they are created; existing tasks
and threads keep their own context. to_dict() and to_namespace() read one
active-context view and include active overrides. They allocate new container
objects but do not deep-copy mutable field values.
For a field with an environment variable, load_env() is deterministic: a
present variable is converted and installed; an absent variable clears the
current value, so the next read uses a fresh declared default or factory value.
Conversion errors always propagate. Direct set() and override() use that
same field converter, rather than bypassing validation.
⌨️ Local Development
Clone the repository and use the maintained task surfaces:
git clone https://github.com/liblaf/conf.git
cd conf
mise install
mise run lint
nox --tags test
mise run docs:serve
mise provides the primary setup, lint, and docs commands in this repository.
nox drives the Python test matrix used by CI.
🤝 Contributing
Issues and pull requests are welcome, especially when they improve the public API, typed converter helpers, or documentation examples.
🔗 Links
📝 License
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file liblaf_conf-0.2.0.tar.gz.
File metadata
- Download URL: liblaf_conf-0.2.0.tar.gz
- Upload date:
- Size: 12.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f87657a0756698d88172f0654bd4981108942090170439b43d0e14849035b48
|
|
| MD5 |
f8e6a6d2df1b484e73fb1c3ad4669904
|
|
| BLAKE2b-256 |
597570384e4e3cf62f182e3db8ba0136fd65069c4eedbe1fcf979948fc139052
|
Provenance
The following attestation bundles were made for liblaf_conf-0.2.0.tar.gz:
Publisher:
python-release.yaml on liblaf/conf
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
liblaf_conf-0.2.0.tar.gz -
Subject digest:
6f87657a0756698d88172f0654bd4981108942090170439b43d0e14849035b48 - Sigstore transparency entry: 2733459102
- Sigstore integration time:
-
Permalink:
liblaf/conf@6cb5cb3e8511a0d3ef0fa62bacfb3a8048877dde -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/liblaf
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-release.yaml@6cb5cb3e8511a0d3ef0fa62bacfb3a8048877dde -
Trigger Event:
release
-
Statement type:
File details
Details for the file liblaf_conf-0.2.0-py3-none-any.whl.
File metadata
- Download URL: liblaf_conf-0.2.0-py3-none-any.whl
- Upload date:
- Size: 17.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a789ecec9cda0c592ad832e51764a1fe25274fe69a420c5add55618e5736f1b
|
|
| MD5 |
cc5dc81f7960bcd851ccd167a1bd02e0
|
|
| BLAKE2b-256 |
c8cb03b37f13812b8a66ff5fbfa17ce27c46000787a0583c4eb034c109da6241
|
Provenance
The following attestation bundles were made for liblaf_conf-0.2.0-py3-none-any.whl:
Publisher:
python-release.yaml on liblaf/conf
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
liblaf_conf-0.2.0-py3-none-any.whl -
Subject digest:
9a789ecec9cda0c592ad832e51764a1fe25274fe69a420c5add55618e5736f1b - Sigstore transparency entry: 2733459564
- Sigstore integration time:
-
Permalink:
liblaf/conf@6cb5cb3e8511a0d3ef0fa62bacfb3a8048877dde -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/liblaf
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-release.yaml@6cb5cb3e8511a0d3ef0fa62bacfb3a8048877dde -
Trigger Event:
release
-
Statement type: