https://github.com/raphendyr/django-settingsdict

Simple helper class to handle dict style settings for django app
https://github.com/raphendyr/django-settingsdict

Last synced: 2 months ago
JSON representation

Simple helper class to handle dict style settings for django app

• Host: GitHub
• URL: https://github.com/raphendyr/django-settingsdict
• Owner: raphendyr
• License: bsd-2-clause
• Created: 2016-10-17T12:20:27.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-07-29T13:46:31.000Z (over 5 years ago)
• Last Synced: 2024-10-11T23:19:42.034Z (3 months ago)
• Language: Python
• Size: 7.81 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Django settings dict

====================

This is small helper that makes it easier to store distributable django app settings in project :code:`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 :code:`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 :code:`required` or :code:`defaults` raise :code:`AttributeError`.

If you like to clear the cache, you can use :code:`_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 :code:`app_settings.py` (for example):

.. code-block:: python

  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 :code:`settings.py`:

.. code-block:: python

  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:

.. code-block:: python

  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:

.. code-block::

  some value

  test_app_2

  

  this is not fixed yet