envhint

Typed environment variable loading via class declaration. Requires only strcoerce.

The problem

# Scattered across every project:
PORT    = int(os.environ.get("PORT", "8080"))
DEBUG   = bool(os.environ.get("DEBUG", "false"))  # bug — always True
HOSTS   = os.environ.get("ALLOWED_HOSTS", "").split(",")
TIMEOUT = timedelta(minutes=int(os.environ.get("TIMEOUT_MINUTES", "5")))

Install

pip install envhint

Usage

from envhint import Env
from datetime import timedelta

class Settings(Env):
    port: int = 8080
    debug: bool = False
    db_url: str                        # required — raises EnvError if absent
    allowed_hosts: list[str] = []
    request_timeout: timedelta = timedelta(seconds=30)

settings = Settings()

print(settings.port)            # 8080  (int, not "8080")
print(settings.debug)           # False (not True like bool("false"))
print(settings.allowed_hosts)   # ["api.example.com", "admin.example.com"]

Set via environment:

PORT=9000
DEBUG=false
DB_URL=postgresql://localhost/mydb
ALLOWED_HOSTS=api.example.com,admin.example.com
REQUEST_TIMEOUT=2m30s

All errors reported at once

class Settings(Env):
    db_url: str
    secret_key: str
    api_key: str

Settings(_env={})
# EnvError: Environment configuration errors:
#   DB_URL: required but not set
#   SECRET_KEY: required but not set
#   API_KEY: required but not set

Testing without patching os.environ

def test_my_feature():
    settings = Settings(_env={
        "DB_URL": "postgresql://localhost/test",
        "SECRET_KEY": "test-secret",
    })
    assert settings.port == 8080  # default

.env file support

settings = Settings(_env_file=".env")
# Real env vars take priority over .env file values

Supported types

License

MIT