123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172 |
- """
- Settings and configuration for Django.
- Values will be read from the module specified by the DJANGO_SETTINGS_MODULE environment
- variable, and then from django.conf.global_settings; see the global settings file for
- a list of all possible variables.
- """
- import importlib
- import os
- import time # Needed for Windows
- from django.conf import global_settings
- from django.core.exceptions import ImproperlyConfigured
- from django.utils.functional import LazyObject, empty
- from django.utils import six
- ENVIRONMENT_VARIABLE = "DJANGO_SETTINGS_MODULE"
- class LazySettings(LazyObject):
- """
- A lazy proxy for either global Django settings or a custom settings object.
- The user can manually configure settings prior to using them. Otherwise,
- Django uses the settings module pointed to by DJANGO_SETTINGS_MODULE.
- """
- def _setup(self, name=None):
- """
- Load the settings module pointed to by the environment variable. This
- is used the first time we need any settings at all, if the user has not
- previously configured the settings manually.
- """
- settings_module = os.environ.get(ENVIRONMENT_VARIABLE)
- if not settings_module:
- desc = ("setting %s" % name) if name else "settings"
- raise ImproperlyConfigured(
- "Requested %s, but settings are not configured. "
- "You must either define the environment variable %s "
- "or call settings.configure() before accessing settings."
- % (desc, ENVIRONMENT_VARIABLE))
- self._wrapped = Settings(settings_module)
- def __getattr__(self, name):
- if self._wrapped is empty:
- self._setup(name)
- return getattr(self._wrapped, name)
- def configure(self, default_settings=global_settings, **options):
- """
- Called to manually configure the settings. The 'default_settings'
- parameter sets where to retrieve any unspecified values from (its
- argument must support attribute access (__getattr__)).
- """
- if self._wrapped is not empty:
- raise RuntimeError('Settings already configured.')
- holder = UserSettingsHolder(default_settings)
- for name, value in options.items():
- setattr(holder, name, value)
- self._wrapped = holder
- @property
- def configured(self):
- """
- Returns True if the settings have already been configured.
- """
- return self._wrapped is not empty
- class BaseSettings(object):
- """
- Common logic for settings whether set by a module or by the user.
- """
- def __setattr__(self, name, value):
- if name in ("MEDIA_URL", "STATIC_URL") and value and not value.endswith('/'):
- raise ImproperlyConfigured("If set, %s must end with a slash" % name)
- elif name == "ALLOWED_INCLUDE_ROOTS" and isinstance(value, six.string_types):
- raise ValueError("The ALLOWED_INCLUDE_ROOTS setting must be set "
- "to a tuple, not a string.")
- object.__setattr__(self, name, value)
- class Settings(BaseSettings):
- def __init__(self, settings_module):
- # update this dict from global settings (but only for ALL_CAPS settings)
- for setting in dir(global_settings):
- if setting.isupper():
- setattr(self, setting, getattr(global_settings, setting))
- # store the settings module in case someone later cares
- self.SETTINGS_MODULE = settings_module
- try:
- mod = importlib.import_module(self.SETTINGS_MODULE)
- except ImportError as e:
- raise ImportError(
- "Could not import settings '%s' (Is it on sys.path? Is there an import error in the settings file?): %s"
- % (self.SETTINGS_MODULE, e)
- )
- tuple_settings = ("INSTALLED_APPS", "TEMPLATE_DIRS")
- self._explicit_settings = set()
- for setting in dir(mod):
- if setting.isupper():
- setting_value = getattr(mod, setting)
- if (setting in tuple_settings and
- isinstance(setting_value, six.string_types)):
- raise ImproperlyConfigured("The %s setting must be a tuple. "
- "Please fix your settings." % setting)
- setattr(self, setting, setting_value)
- self._explicit_settings.add(setting)
- if not self.SECRET_KEY:
- raise ImproperlyConfigured("The SECRET_KEY setting must not be empty.")
- if hasattr(time, 'tzset') and self.TIME_ZONE:
- # When we can, attempt to validate the timezone. If we can't find
- # this file, no check happens and it's harmless.
- zoneinfo_root = '/usr/share/zoneinfo'
- if (os.path.exists(zoneinfo_root) and not
- os.path.exists(os.path.join(zoneinfo_root, *(self.TIME_ZONE.split('/'))))):
- raise ValueError("Incorrect timezone setting: %s" % self.TIME_ZONE)
- # Move the time zone info into os.environ. See ticket #2315 for why
- # we don't do this unconditionally (breaks Windows).
- os.environ['TZ'] = self.TIME_ZONE
- time.tzset()
- def is_overridden(self, setting):
- return setting in self._explicit_settings
- class UserSettingsHolder(BaseSettings):
- """
- Holder for user configured settings.
- """
- # SETTINGS_MODULE doesn't make much sense in the manually configured
- # (standalone) case.
- SETTINGS_MODULE = None
- def __init__(self, default_settings):
- """
- Requests for configuration variables not in this class are satisfied
- from the module specified in default_settings (if possible).
- """
- self.__dict__['_deleted'] = set()
- self.default_settings = default_settings
- def __getattr__(self, name):
- if name in self._deleted:
- raise AttributeError
- return getattr(self.default_settings, name)
- def __setattr__(self, name, value):
- self._deleted.discard(name)
- super(UserSettingsHolder, self).__setattr__(name, value)
- def __delattr__(self, name):
- self._deleted.add(name)
- if hasattr(self, name):
- super(UserSettingsHolder, self).__delattr__(name)
- def __dir__(self):
- return list(self.__dict__) + dir(self.default_settings)
- def is_overridden(self, setting):
- deleted = (setting in self._deleted)
- set_locally = (setting in self.__dict__)
- set_on_default = getattr(self.default_settings, 'is_overridden', lambda s: False)(setting)
- return (deleted or set_locally or set_on_default)
- settings = LazySettings()
|