Skip to main content

Manage Django settings with Pydantic.

Project description

django-pydantic-settings

Use pydantic settings management to simplify configuration of Django settings.

Very much a work in progress, but reads the standard DJANGO_SETTINGS_MODULE environment variable (defaulting to pydantic_settings.Settings) to load a sub-class of pydantic_settings.Settings. All settings (that have been defined in pydantic_settings.Settings) can be overridden with environment variables. A special DatabaseSettings class is used to allow multiple databases to be configured simply with DSNs. In theory, django-pydantic-settings should be compatible with any version of Django that runs on Python 3.6+ (which means Django 1.11 and on), but has so far only been tested against Django 3.1.

Installation & Setup

Install django-pydantic-settings:

pip install django-pydantic-settings

Modify your Django project's manage.py file to use django-pydantic-settings, it should look something like this:

#!/usr/bin/env python
"""Django's command-line utility for administrative tasks."""
import sys

from pydantic_settings import SetUp


def main():
    """Run administrative tasks."""
    SetUp().configure()

    try:
        from django.core.management import execute_from_command_line
    except ImportError as exc:
        raise ImportError(
            "Couldn't import Django. Are you sure it's installed and "
            "available on your PYTHONPATH environment variable? Did you "
            "forget to activate a virtual environment?"
        ) from exc
    execute_from_command_line(sys.argv)


if __name__ == "__main__":
    main()

Your wsgi.py and/or asgi.py files will need to be modified similarly, and look something like this:

from django.core.wsgi import get_wsgi_application

from pydantic_settings import SetUp

SetUp().configure()
application = get_wsgi_application()

The SetUp class will automatically look for the standard DJANGO_SETTINGS_MODULE environment variable, read it, confirm that it points to an existing Python module, and load that module. Your DJANGO_SETTINGS_MODULE variable should point to a pydantic_settings.settings.PydanticSettings sub-class (though technically any Python class that defines a dict() method which returns a Python dictionary of key/value pairs matching the required Django settings will work). Calling the configure() method will then use the specified module to configure your project's Django settings.

Required settings

The only setting that absolutely must be configured in order to run Django using django-pydantic-settings is the DATABASES setting. By default, this is configured by simply setting the DATABASE_URL environment variable, as described in the next section. All other settings are provided, or will have calculated, a reasonable default. Other settings worth thinking about are ROOT_URLCONF and WSGI_APPLICATION, which, unless otherwise specified, are calculated based on your DJANGO_SETTINGS_MODULE assuming that you're using the default Django project layout a provided by django-admin.py startproject. So, for example, if your DJANGO_SETINGS_MODULE is set to my_awesome_project.settings.PydanticSettingsSubclass, then ROOT_URLCONF and WSGI_APPLICATION will be set to my_awesome_project.urls and my_awesome_project.wsgi respectively. This default behavior can be overridden by simply specifying ROOT_URLCONF:str = 'the_actual_urlconf' and WSGI_APPLICATION:str = 'the_actual_wsgi_file' in your PydanticSettings sub-class.

The other setting worth thinking about is SECRET_KEY. By default, SECRET_KEY is automatically generated using Django's own get_random_secret_key() function. This will work just fine, though as it will be re-calculated every time your PydanticSettings sub-class is instantiated, you should set this to somethign static if you're using Django's authentication and don't want to lose your session every time the server is restarted.

Database configuration

By defining multiple DatabaseDsn attributes of the DatabaseSettings class, you can easily configure one or more database connections with environment variables. DSNs are parsed using dj-database-url.

class DatabaseSettings(BaseSettings):
    default: DatabaseDsn = Field(env="DATABASE_URL")
    secondary: DatabaseDsn = Field(env="SECONDARY_DATABASE_URL")
 DATABASE_URL=sqlite:///foo SECONDARY_DATABASE_URL=sqlite:///bar ./settings_test/manage.py shell
Python 3.9.1 (default, Jan  8 2021, 17:17:43)
[Clang 12.0.0 (clang-1200.0.32.28)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
(InteractiveConsole)
>>> from django.conf import settings
...
>>> pp.pprint(settings.DATABASES)
{   'default': {   'ATOMIC_REQUESTS': False,
                   'AUTOCOMMIT': True,
                   'CONN_MAX_AGE': 0,
                   'ENGINE': 'django.db.backends.sqlite3',
                   'HOST': '',
                   'NAME': 'foo',
                   'OPTIONS': {},
                   'PASSWORD': '',
                   'PORT': '',
                   'TEST': {   'CHARSET': None,
                               'COLLATION': None,
                               'MIGRATE': True,
                               'MIRROR': None,
                               'NAME': None},
                   'TIME_ZONE': None,
                   'USER': ''},
    'secondary': {   'CONN_MAX_AGE': 0,
                     'ENGINE': 'django.db.backends.sqlite3',
                     'HOST': '',
                     'NAME': 'bar',
                     'PASSWORD': '',
                     'PORT': '',
                     'USER': ''}}
>>>

Sentry configuration

django-pydantic-settings provides built-in functionality for configuring your Django project to use Sentry. The simplest way to use this is to inherit from pydantic_settings.sentry.SentrySettings rather than pydantic_settings.settings.PydanticSettings. This adds the setting SENTRY_DSN, which uses the pydantic_settings.sentry.SentryDsn type. This will automatically be set according to the DJANGO_SENTRY_DSN environment variable, and expects a Sentry DSN (obviously). It validates that the provided DSN is a valid URL, and then automatically initializes the Sentry SDK using the built-in DjangoIntegration. Using this functionality required sentry-sdk to be installed, which will be included automatically if you install django-pydantic-settings[sentry].

Project details


Download files

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

Source Distribution

django-pydantic-settings-0.1.9.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

django_pydantic_settings-0.1.9-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file django-pydantic-settings-0.1.9.tar.gz.

File metadata

  • Download URL: django-pydantic-settings-0.1.9.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/2.7.16 Darwin/20.3.0

File hashes

Hashes for django-pydantic-settings-0.1.9.tar.gz
Algorithm Hash digest
SHA256 daa9ee5c8104453de8cacd6c7415b50fe6bbf0a31243f875744d4e9c313430ce
MD5 61df712cb965dadf990759935e282886
BLAKE2b-256 7bb2d752763b3cf1541b8baac5209f6f2b9cd7c16d36dbb9c4ec4bda798ae4e5

See more details on using hashes here.

Provenance

File details

Details for the file django_pydantic_settings-0.1.9-py3-none-any.whl.

File metadata

File hashes

Hashes for django_pydantic_settings-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 22a8a6d37fabe6c0533a1856bc23420d01e59f0b5df83e05404cacea6ac9f6bf
MD5 1e0c2bc97c25f53e4eda13bf1cf2dd99
BLAKE2b-256 32655caff7b12dfc5be1e2cc2fd90a294cff8c8d297790e323b1920db02ec3e7

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page