pyenvalid 0.1.0

Beautiful validation errors for pydantic-settings

pyenvalid

Beautiful validation errors for pydantic-settings.

The Problem

When using pydantic-settings with required environment variables, missing or invalid values produce cryptic errors:

from pydantic_settings import BaseSettings

class Settings(BaseSettings):
    database_url: str
    api_key: str
    port: int = 8080

settings = Settings()  # Raises ValidationError if DATABASE_URL or API_KEY not set

pydantic_core._pydantic_core.ValidationError: 2 validation errors for Settings
database_url
  Field required [type=missing, input_value={}, input_type=dict]
    For further information visit https://errors.pydantic.dev/2.12/v/missing
api_key
  Field required [type=missing, input_value={}, input_type=dict]
    For further information visit https://errors.pydantic.dev/2.12/v/missing

This error is confusing because:

• It doesn't mention environment variables in a friendly way
• The input_value={} is misleading (it's not a dict, it's your environment)
• Hard to quickly see which variables need to be set

The Solution

pyenvalid wraps validation and provides clear, actionable error messages:

┌──────────────────────────────────────────────────────────────────────────┐
│ CONFIGURATION ERROR                                                      │
├──────────────────────────────────────────────────────────────────────────┤
│                                                                          │
│ The following environment variables have issues:                         │
│                                                                          │
│   ✗ DATABASE_URL (missing)                                               │
│   ✗ API_KEY (missing)                                                    │
│                                                                          │
├──────────────────────────────────────────────────────────────────────────┤
│ Set these in your .env file or environment                               │
└──────────────────────────────────────────────────────────────────────────┘

Installation

pip install pyenvalid

Or with uv:

uv add pyenvalid

Usage

from pydantic_settings import BaseSettings
from pyenvalid import validate_settings

class Settings(BaseSettings):
    database_url: str
    api_key: str
    port: int = 8080

settings = validate_settings(Settings)

That's it. If DATABASE_URL or API_KEY are missing, you get the nice error box instead of pydantic's raw error.

With .env file

from pydantic_settings import BaseSettings, SettingsConfigDict
from pyenvalid import validate_settings

class Settings(BaseSettings):
    model_config = SettingsConfigDict(env_file=".env")

    secret_key: str
    database_url: str

settings = validate_settings(Settings)

Custom error messages

from pyenvalid import ConfigurationError, validate_settings

try:
    settings = validate_settings(Settings)
except ConfigurationError as e:
    raise ConfigurationError(
        e.errors,
        title="DATABASE ERROR",
        hint="Check your .env.local file",
    ) from None

Handling errors programmatically

from pyenvalid import ConfigurationError, validate_settings

try:
    settings = validate_settings(Settings)
except ConfigurationError as e:
    print(e.errors)  # [('database_url', 'missing'), ('api_key', 'missing')]
    print(e.missing_fields)  # ['database_url', 'api_key']

Error Types

The error type shown is the raw pydantic error type:

Error	Meaning
missing	Required field not set
int_parsing	Value can't be parsed as integer
bool_parsing	Value can't be parsed as boolean
literal_error	Value not in allowed options
url_parsing	Invalid URL format

License

MIT