Skip to main content

Simple helper class to handle dict style settings for django app

Project description

This is small helper that makes it easier to store distributable django app settings in project settings.py as a dict. Purpose is to keep settings file simple and clean. With this it’s also easier to set defaults for the settings and warn about settings that have been removed.

Helper also supports marking settings that should be imported before returning. Import is done using django.utils.module_loading.import_string.

Helper resolves variables when requested for the first time and caches the value for faster lookup next time. Variables that are not in required or defaults raise AttributeError. If you like to clear the cache, you can use _clear_cached().

Using migrate, you can configure list of migration actions. Parameter takes a list of tuples, where first field is the new setting name, second is the old name outside of the dictionary and optional third is callable. The callable has format migrate_script(old_value: Any, current_dictionary: dict) -> Any, where current_dictionary contains all values read so far.

Design is based on class done in Django REST framework.

Example

Setting defitions in your applications app_settings.py (for example):

from django_settingsdict import SettingsDict
REQUIRED = (
    'IMPORTANT_SETTING',
)
DEFAULTS = {
    'URL_NAME': 'test_app',
    'MIGRATED_VALUE': 'something old, but supported',
    'REVERSE_FUNC': 'django.core.urlresolvers.reverse',
}
IMPORT_STRINGS = (
    'REVERSE_FUNC',
)
REMOVED = (
    'OLD_SETTING',
)
MIGRATE = (
    ('MIGRATED_VALUE', 'MY_APP_OLD_OPTION'),
)
app_settings = SettingsDict('MY_APP',
                            required=REQUIRED,
                            defaults=DEFAULTS,
                            removed=REMOVED,
                            migrate=MIGRATE,
                            import_strings=IMPORT_STRINGS)

Configuration in your projects settings.py:

MY_APP = {
    'IMPORTANT_SETTING': 'some value',
    'URL_NAME': 'test_app_2',
}
MY_APP_OLD_OPTION = 'this is not fixed yet'

And in your application code:

from .app_settings import app_settings

print(app_settings.IMPORTANT_SETTING)
print(app_settings.URL_NAME)
print(app_settings.REVERSE_FUNC)
print(app_settings.MIGRATED_VALUE)

would make following result:

some value
test_app_2
<function reverse at 0x7fd5119e0578>
this is not fixed yet

Project details


Download files

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

Files for django-settingsdict, version 1.1.1
Filename, size & hash File type Python version Upload date
django_settingsdict-1.1.1-py3.7.egg (6.4 kB) View hashes Egg 3.7
django_settingsdict-1.1.1-py3-none-any.whl (5.0 kB) View hashes Wheel 3.7
django-settingsdict-1.1.1.tar.gz (5.2 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page