django-yaa-settings 1.1.0

Features

• Easy to install and use

• Provide defaults and validate user settings before use

• Works with Django’s settings overrides in tests

Supports Django 2.2 to 3.1 on Python 3.5 to 3.8.

Version 1.0.0 was the last version to support earlier versions of Django.

Installation

Install from pip:

pip install django-yaa-settings

Usage

In your app, create a local app_settings.py:

from yaa_settings import AppSettings

class MySettings(AppSettings):
    prefix = 'MYAPP'

    # Can be overridden in Django settings as MYAPP_ATTRIBUTE
    ATTRIBUTE = 'a static value defined at class creation'

    @property
    def PROPERTY(self):
        """
        Return a value calculated whenever it is accessed

        Can be overridden in Django settings as MYAPP_PROPERTY
        """
        return 'a value calculated when accessed'

    def CALLABLE(self, value):
        """
        Always called, passed the MYAPP_CALLABLE value from Django settings
        (or passed None if that is not defined)
        """
        if value is None:
            raise ValueError('MYAPP_CALLABLE must be configured')
        return value

• Import and subclass AppSettings

• Only define one AppSettings subclass per file

• Set the prefix attribute if you want to give your settings a prefix in Django’s settings.

• Settings should be uppercase for consistency with main Django settings.

Now you can access your app’s settings directly on the class, without the prefix:

from . import app_settings

def some_method(request):
    if app_settings.ATTRIBUTE == 1:
        return app_settings.PROPERTY
    return app_settings.CALLABLE

You can override these settings in your main Django settings, using the prefix:

MYAPP_ATTRIBUTE = 'value available as app_settings.ATTRIBUTE'
MYAPP_PROPERTY = 'value available as app_settings.PROPERTY'
MYAPP_CALLABLE = 'value passed to MySettings.CALLABLE'

Why?

from django.conf import settings
SETTING = getattr(settings, 'MYAPP_SETTINGS', 'default')

Changelog

• 1.1.0, 2020-07-22: Moved supported Django to 2.2 to 3.1 (#1, #2 - thanks to clinoge)

• 1.0.0, 2018-06-24: Released as stable

• 0.1.0, 2018-06-24: Initial release