pydjantic 1.1.4

Pydantic Settings for Django

pydjantic

Use Pydantic Settings in your Django application.

Introduction

If you are tired of the mess in your Django Settings - I feel your pain:

• Ridiculously long settings.py file, with ASCII-art separation
• from common import * Python anti-pattern
• try: <import> except: ImportError Python anti-pattern
• base.py, production.py, local.py, domain.py - bunch of unrelated modules that override each other
• django-environ library, that do even worse...

On the other hand we have Pydantic Settings, which is de-facto standard for all non-django projects.

If you love Pydantic settings management approach, Pydjantic is a right tool for you.

Pydjantic allows you to define your settings in familiar way - just inherit from BaseSettings:

from typing import List

from pydantic import BaseSettings, Field
from pydantic.fields import Undefined
from pydjantic import to_django

class GeneralSettings(BaseSettings):
    SECRET_KEY: str = Field(default=Undefined, env='DJANGO_SECRET_KEY')
    DEBUG: bool = Field(default=False, env='DEBUG')
    INSTALLED_APPS: List[str] = [
        'django.contrib.admin',
        'django.contrib.auth',
    ]
    LANGUAGE_CODE: str = 'en-us'
    USE_TZ: bool = True


class StaticSettings(BaseSettings):
    STATIC_URL: str = '/static/'
    STATIC_ROOT: str = 'staticfiles'


class SentrySettings(BaseSettings):
    SENTRY_DSN: str = Field(default=Undefined, env='SENTRY_DSN')


class ProjectSettings(GeneralSettings, StaticSettings, SentrySettings):
    pass


to_django(ProjectSettings())

You can create as many classes/modules as you want, to achieve perfect settings' management. Divide your settings by domains, and then create final ProjectSettings class, that inherits from these domains.

Provide the instance of ProjectSettings to to_django function. That's all, your django settings will work as expected.

Installation

Install using pip install -U pydjantic or poetry add pydjantic.

Example

In the /demo directory you can find a working Django app with pydjantic settings.

Database configuration

Pydjantic comes with a special helper for managing DB configs - BaseDBConfig. See example below:

from pydantic import Field, PostgresDsn
from pydjantic import BaseDBConfig


class DatabaseConfig(BaseDBConfig):
    default: PostgresDsn = Field(default="postgres://user:password@hostname:5432/dbname", env="DATABASE_URL")

db_settings = DatabaseConfig()
assert db_settings.default == {
    'CONN_MAX_AGE': 0,
    'ENGINE': 'django.db.backends.postgresql_psycopg2',
    'HOST': 'hostname',
    'NAME': 'dbname',
    'PASSWORD': 'password',
    'PORT': 5432,
    'USER': 'user',
}

Also, you can define database configurations directly:

from pydantic import BaseSettings, Field

class PostgresDB(BaseSettings):
    ENGINE: str = 'django.db.backends.postgresql_psycopg2'
    HOST: str = Field(default='localhost', env='DATABASE_HOST')
    NAME: str = Field(default='dbname', env='DATABASE_NAME')
    PASSWORD: str = Field(default='password', env='DATABASE_PASSWORD')
    PORT: int = Field(default=5432, env='DATABASE_PORT')
    USER: str = Field(default='user', env='DATABASE_USER')
    OPTIONS: dict = Field(default={}, env='DATABASE_OPTIONS')
    CONN_MAX_AGE: int = Field(default=0, env='DATABASE_CONN_MAX_AGE')

class DatabaseConfig(BaseSettings):
    default = PostgresDB()

Or mix these approaches:

class DatabaseConfig(BaseDBConfig):
    default = Field(default="postgres://user:password@hostname:5432/dbname")
    replica = PostgresDB()

For more examples see tests.

Transformation from dsn to django format is done by dj-database-url library.