2022-11-14 22:43:45 +01:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2023-10-19 20:22:27 +00:00
< title > django.conf — Evennia 2.x documentation< / title >
2022-11-14 22:43:45 +01:00
< link rel = "stylesheet" href = "../../_static/nature.css" type = "text/css" / >
< link rel = "stylesheet" href = "../../_static/pygments.css" type = "text/css" / >
< script id = "documentation_options" data-url_root = "../../" src = "../../_static/documentation_options.js" > < / script >
< script src = "../../_static/jquery.js" > < / script >
< script src = "../../_static/underscore.js" > < / script >
< script src = "../../_static/doctools.js" > < / script >
< script src = "../../_static/language_data.js" > < / script >
< link rel = "shortcut icon" href = "../../_static/favicon.ico" / >
< link rel = "index" title = "Index" href = "../../genindex.html" / >
< link rel = "search" title = "Search" href = "../../search.html" / >
< / head > < body >
2023-10-19 20:22:27 +00:00
2022-11-14 22:43:45 +01:00
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../../genindex.html" title = "General Index"
accesskey="I">index< / a > < / li >
< li class = "right" >
< a href = "../../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
2023-10-19 20:22:27 +00:00
< li class = "nav-item nav-item-0" > < a href = "../../index.html" > Evennia 2.x< / a > » < / li >
2022-11-14 22:43:45 +01:00
< li class = "nav-item nav-item-1" > < a href = "../index.html" accesskey = "U" > Module code< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > django.conf< / a > < / li >
< / ul >
2023-06-10 08:53:19 +00:00
< / div >
2022-11-14 22:43:45 +01:00
< div class = "document" >
< div class = "documentwrapper" >
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
< p class = "logo" > < a href = "../../index.html" >
< img class = "logo" src = "../../_static/evennia_logo.png" alt = "Logo" / >
< / a > < / p >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
< form class = "search" action = "../../search.html" method = "get" >
< input type = "text" name = "q" aria-labelledby = "searchlabel" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script > < h3 > Links< / h3 >
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "https://www.evennia.com/docs/latest/index.html" > Documentation Top< / a > < / li >
< li > < a href = "https://www.evennia.com" > Evennia Home< / a > < / li >
< li > < a href = "https://github.com/evennia/evennia" > Github< / a > < / li >
2022-11-14 22:43:45 +01:00
< li > < a href = "http://games.evennia.com" > Game Index< / a > < / li >
< li >
< a href = "https://discord.gg/AJJpcRUhtF" > Discord< / a > -
< a href = "https://github.com/evennia/evennia/discussions" > Discussions< / a > -
< a href = "https://evennia.blogspot.com/" > Blog< / a >
< / li >
< / ul >
2023-10-19 20:22:27 +00:00
< h3 > Doc Versions< / h3 >
2022-11-14 22:43:45 +01:00
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "conf.html" > 2.x (main branch)< / a > < / li >
2022-11-15 20:29:38 +00:00
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "../1.3.0/index.html" > 1.3.0 (v1.3.0 branch)< / a > < / li >
< li > < a href = "../0.9.5/index.html" > 0.9.5 (v0.9.5 branch)< / a > < / li >
2022-11-15 20:29:38 +00:00
2022-11-14 22:43:45 +01:00
< / ul >
< / div >
< / div >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< h1 > Source code for django.conf< / h1 > < div class = "highlight" > < pre >
< span > < / span > < span class = "sd" > " " " < / span >
< span class = "sd" > Settings and configuration for Django.< / span >
< span class = "sd" > Read values from the module specified by the DJANGO_SETTINGS_MODULE environment< / span >
< span class = "sd" > variable, and then from django.conf.global_settings; see the global_settings.py< / span >
< span class = "sd" > for a list of all possible variables.< / span >
< span class = "sd" > " " " < / span >
< span class = "kn" > import< / span > < span class = "nn" > importlib< / span >
< span class = "kn" > import< / span > < span class = "nn" > os< / span >
< span class = "kn" > import< / span > < span class = "nn" > time< / span >
< span class = "kn" > import< / span > < span class = "nn" > traceback< / span >
< span class = "kn" > import< / span > < span class = "nn" > warnings< / span >
< span class = "kn" > from< / span > < span class = "nn" > pathlib< / span > < span class = "kn" > import< / span > < span class = "n" > Path< / span >
< span class = "kn" > import< / span > < span class = "nn" > django< / span >
< span class = "kn" > from< / span > < span class = "nn" > django.conf< / span > < span class = "kn" > import< / span > < span class = "n" > global_settings< / span >
< span class = "kn" > from< / span > < span class = "nn" > django.core.exceptions< / span > < span class = "kn" > import< / span > < span class = "n" > ImproperlyConfigured< / span >
2023-12-02 22:36:16 +00:00
< span class = "kn" > from< / span > < span class = "nn" > django.utils.deprecation< / span > < span class = "kn" > import< / span > < span class = "n" > RemovedInDjango50Warning< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango51Warning< / span >
2022-11-14 22:43:45 +01:00
< span class = "kn" > from< / span > < span class = "nn" > django.utils.functional< / span > < span class = "kn" > import< / span > < span class = "n" > LazyObject< / span > < span class = "p" > ,< / span > < span class = "n" > empty< / span >
< span class = "n" > ENVIRONMENT_VARIABLE< / span > < span class = "o" > =< / span > < span class = "s2" > " DJANGO_SETTINGS_MODULE" < / span >
2023-12-02 22:36:16 +00:00
< span class = "n" > DEFAULT_STORAGE_ALIAS< / span > < span class = "o" > =< / span > < span class = "s2" > " default" < / span >
< span class = "n" > STATICFILES_STORAGE_ALIAS< / span > < span class = "o" > =< / span > < span class = "s2" > " staticfiles" < / span >
2022-11-14 22:43:45 +01:00
< span class = "c1" > # RemovedInDjango50Warning< / span >
< span class = "n" > USE_DEPRECATED_PYTZ_DEPRECATED_MSG< / span > < span class = "o" > =< / span > < span class = "p" > (< / span >
< span class = "s2" > " The USE_DEPRECATED_PYTZ setting, and support for pytz timezones is " < / span >
< span class = "s2" > " deprecated in favor of the stdlib zoneinfo module. Please update your " < / span >
< span class = "s2" > " code to use zoneinfo and remove the USE_DEPRECATED_PYTZ setting." < / span >
< span class = "p" > )< / span >
< span class = "n" > USE_L10N_DEPRECATED_MSG< / span > < span class = "o" > =< / span > < span class = "p" > (< / span >
< span class = "s2" > " The USE_L10N setting is deprecated. Starting with Django 5.0, localized " < / span >
< span class = "s2" > " formatting of data will always be enabled. For example Django will " < / span >
< span class = "s2" > " display numbers and dates using the format of the current locale." < / span >
< span class = "p" > )< / span >
2022-11-18 11:08:09 +00:00
< span class = "n" > CSRF_COOKIE_MASKED_DEPRECATED_MSG< / span > < span class = "o" > =< / span > < span class = "p" > (< / span >
< span class = "s2" > " The CSRF_COOKIE_MASKED transitional setting is deprecated. Support for " < / span >
< span class = "s2" > " it will be removed in Django 5.0." < / span >
< span class = "p" > )< / span >
2023-12-02 22:36:16 +00:00
< span class = "n" > DEFAULT_FILE_STORAGE_DEPRECATED_MSG< / span > < span class = "o" > =< / span > < span class = "p" > (< / span >
< span class = "s2" > " The DEFAULT_FILE_STORAGE setting is deprecated. Use STORAGES instead." < / span >
< span class = "p" > )< / span >
< span class = "n" > STATICFILES_STORAGE_DEPRECATED_MSG< / span > < span class = "o" > =< / span > < span class = "p" > (< / span >
< span class = "s2" > " The STATICFILES_STORAGE setting is deprecated. Use STORAGES instead." < / span >
< span class = "p" > )< / span >
2022-11-14 22:43:45 +01:00
< span class = "k" > class< / span > < span class = "nc" > SettingsReference< / span > < span class = "p" > (< / span > < span class = "nb" > str< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > String subclass which references a current settings value. It' s treated as< / span >
< span class = "sd" > the value in memory but serializes to a settings.NAME attribute reference.< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > def< / span > < span class = "fm" > __new__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "n" > setting_name< / span > < span class = "p" > ):< / span >
< span class = "k" > return< / span > < span class = "nb" > str< / span > < span class = "o" > .< / span > < span class = "fm" > __new__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "p" > ,< / span > < span class = "n" > setting_name< / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > setting_name< / span > < span class = "o" > =< / span > < span class = "n" > setting_name< / span >
< span class = "k" > class< / span > < span class = "nc" > LazySettings< / span > < span class = "p" > (< / span > < span class = "n" > LazyObject< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > A lazy proxy for either global Django settings or a custom settings object.< / span >
< span class = "sd" > The user can manually configure settings prior to using them. Otherwise,< / span >
< span class = "sd" > Django uses the settings module pointed to by DJANGO_SETTINGS_MODULE.< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > def< / span > < span class = "nf" > _setup< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > Load the settings module pointed to by the environment variable. This< / span >
< span class = "sd" > is used the first time settings are needed, if the user hasn' t< / span >
< span class = "sd" > configured settings manually.< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > settings_module< / span > < span class = "o" > =< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > environ< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "n" > ENVIRONMENT_VARIABLE< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > settings_module< / span > < span class = "p" > :< / span >
< span class = "n" > desc< / span > < span class = "o" > =< / span > < span class = "p" > (< / span > < span class = "s2" > " setting < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "n" > name< / span > < span class = "p" > )< / span > < span class = "k" > if< / span > < span class = "n" > name< / span > < span class = "k" > else< / span > < span class = "s2" > " settings" < / span >
< span class = "k" > raise< / span > < span class = "n" > ImproperlyConfigured< / span > < span class = "p" > (< / span >
< span class = "s2" > " Requested < / span > < span class = "si" > %s< / span > < span class = "s2" > , but settings are not configured. " < / span >
< span class = "s2" > " You must either define the environment variable < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span >
< span class = "s2" > " or call settings.configure() before accessing settings." < / span >
< span class = "o" > %< / span > < span class = "p" > (< / span > < span class = "n" > desc< / span > < span class = "p" > ,< / span > < span class = "n" > ENVIRONMENT_VARIABLE< / span > < span class = "p" > )< / span >
< span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _wrapped< / span > < span class = "o" > =< / span > < span class = "n" > Settings< / span > < span class = "p" > (< / span > < span class = "n" > settings_module< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "fm" > __repr__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "c1" > # Hardcode the class name as otherwise it yields ' Settings' .< / span >
< span class = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _wrapped< / span > < span class = "ow" > is< / span > < span class = "n" > empty< / span > < span class = "p" > :< / span >
< span class = "k" > return< / span > < span class = "s2" > " < LazySettings [Unevaluated]> " < / span >
< span class = "k" > return< / span > < span class = "s1" > ' < LazySettings " < / span > < span class = "si" > %(settings_module)s< / span > < span class = "s1" > " > ' < / span > < span class = "o" > %< / span > < span class = "p" > {< / span >
< span class = "s2" > " settings_module" < / span > < span class = "p" > :< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _wrapped< / span > < span class = "o" > .< / span > < span class = "n" > SETTINGS_MODULE< / span > < span class = "p" > ,< / span >
< span class = "p" > }< / span >
< span class = "k" > def< / span > < span class = "fm" > __getattr__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " Return the value of a setting and cache it in self.__dict__." " " < / span >
2022-11-18 11:08:09 +00:00
< span class = "k" > if< / span > < span class = "p" > (< / span > < span class = "n" > _wrapped< / span > < span class = "o" > :=< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _wrapped< / span > < span class = "p" > )< / span > < span class = "ow" > is< / span > < span class = "n" > empty< / span > < span class = "p" > :< / span >
2022-11-14 22:43:45 +01:00
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _setup< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > )< / span >
2022-11-18 11:08:09 +00:00
< span class = "n" > _wrapped< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _wrapped< / span >
< span class = "n" > val< / span > < span class = "o" > =< / span > < span class = "nb" > getattr< / span > < span class = "p" > (< / span > < span class = "n" > _wrapped< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > )< / span >
2022-11-14 22:43:45 +01:00
< span class = "c1" > # Special case some settings which require further modification.< / span >
< span class = "c1" > # This is done here for performance reasons so the modified value is cached.< / span >
< span class = "k" > if< / span > < span class = "n" > name< / span > < span class = "ow" > in< / span > < span class = "p" > {< / span > < span class = "s2" > " MEDIA_URL" < / span > < span class = "p" > ,< / span > < span class = "s2" > " STATIC_URL" < / span > < span class = "p" > }< / span > < span class = "ow" > and< / span > < span class = "n" > val< / span > < span class = "ow" > is< / span > < span class = "ow" > not< / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
< span class = "n" > val< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _add_script_prefix< / span > < span class = "p" > (< / span > < span class = "n" > val< / span > < span class = "p" > )< / span >
< span class = "k" > elif< / span > < span class = "n" > name< / span > < span class = "o" > ==< / span > < span class = "s2" > " SECRET_KEY" < / span > < span class = "ow" > and< / span > < span class = "ow" > not< / span > < span class = "n" > val< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "n" > ImproperlyConfigured< / span > < span class = "p" > (< / span > < span class = "s2" > " The SECRET_KEY setting must not be empty." < / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "vm" > __dict__< / span > < span class = "p" > [< / span > < span class = "n" > name< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "n" > val< / span >
< span class = "k" > return< / span > < span class = "n" > val< / span >
< span class = "k" > def< / span > < span class = "fm" > __setattr__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > Set the value of setting. Clear all cached values if _wrapped changes< / span >
< span class = "sd" > (@override_settings does this) or clear single values when set.< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > if< / span > < span class = "n" > name< / span > < span class = "o" > ==< / span > < span class = "s2" > " _wrapped" < / span > < span class = "p" > :< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "vm" > __dict__< / span > < span class = "o" > .< / span > < span class = "n" > clear< / span > < span class = "p" > ()< / span >
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "vm" > __dict__< / span > < span class = "o" > .< / span > < span class = "n" > pop< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "kc" > None< / span > < span class = "p" > )< / span >
< span class = "nb" > super< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "fm" > __setattr__< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "fm" > __delattr__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " Delete a setting and clear it from cache if needed." " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "nb" > super< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "fm" > __delattr__< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "vm" > __dict__< / span > < span class = "o" > .< / span > < span class = "n" > pop< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "kc" > None< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > configure< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > default_settings< / span > < span class = "o" > =< / span > < span class = "n" > global_settings< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > options< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > Called to manually configure the settings. The ' default_settings' < / span >
< span class = "sd" > parameter sets where to retrieve any unspecified values from (its< / span >
< span class = "sd" > argument must support attribute access (__getattr__)).< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _wrapped< / span > < span class = "ow" > is< / span > < span class = "ow" > not< / span > < span class = "n" > empty< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s2" > " Settings already configured." < / span > < span class = "p" > )< / span >
< span class = "n" > holder< / span > < span class = "o" > =< / span > < span class = "n" > UserSettingsHolder< / span > < span class = "p" > (< / span > < span class = "n" > default_settings< / span > < span class = "p" > )< / span >
< span class = "k" > for< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "ow" > in< / span > < span class = "n" > options< / span > < span class = "o" > .< / span > < span class = "n" > items< / span > < span class = "p" > ():< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > name< / span > < span class = "o" > .< / span > < span class = "n" > isupper< / span > < span class = "p" > ():< / span >
< span class = "k" > raise< / span > < span class = "ne" > TypeError< / span > < span class = "p" > (< / span > < span class = "s2" > " Setting < / span > < span class = "si" > %r< / span > < span class = "s2" > must be uppercase." < / span > < span class = "o" > %< / span > < span class = "n" > name< / span > < span class = "p" > )< / span >
< span class = "nb" > setattr< / span > < span class = "p" > (< / span > < span class = "n" > holder< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _wrapped< / span > < span class = "o" > =< / span > < span class = "n" > holder< / span >
< span class = "nd" > @staticmethod< / span >
< span class = "k" > def< / span > < span class = "nf" > _add_script_prefix< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > Add SCRIPT_NAME prefix to relative paths.< / span >
< span class = "sd" > Useful when the app is being served at a subpath and manually prefixing< / span >
< span class = "sd" > subpath to STATIC_URL and MEDIA_URL in settings is inconvenient.< / span >
< span class = "sd" > " " " < / span >
< span class = "c1" > # Don' t apply prefix to absolute paths and URLs.< / span >
< span class = "k" > if< / span > < span class = "n" > value< / span > < span class = "o" > .< / span > < span class = "n" > startswith< / span > < span class = "p" > ((< / span > < span class = "s2" > " http://" < / span > < span class = "p" > ,< / span > < span class = "s2" > " https://" < / span > < span class = "p" > ,< / span > < span class = "s2" > " /" < / span > < span class = "p" > )):< / span >
< span class = "k" > return< / span > < span class = "n" > value< / span >
< span class = "kn" > from< / span > < span class = "nn" > django.urls< / span > < span class = "kn" > import< / span > < span class = "n" > get_script_prefix< / span >
< span class = "k" > return< / span > < span class = "s2" > " < / span > < span class = "si" > %s%s< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "p" > (< / span > < span class = "n" > get_script_prefix< / span > < span class = "p" > (),< / span > < span class = "n" > value< / span > < span class = "p" > )< / span >
< span class = "nd" > @property< / span >
< span class = "k" > def< / span > < span class = "nf" > configured< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " Return True if the settings have already been configured." " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "k" > return< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _wrapped< / span > < span class = "ow" > is< / span > < span class = "ow" > not< / span > < span class = "n" > empty< / span >
2023-12-02 22:36:16 +00:00
< span class = "k" > def< / span > < span class = "nf" > _show_deprecation_warning< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > message< / span > < span class = "p" > ,< / span > < span class = "n" > category< / span > < span class = "p" > ):< / span >
2022-11-14 22:43:45 +01:00
< span class = "n" > stack< / span > < span class = "o" > =< / span > < span class = "n" > traceback< / span > < span class = "o" > .< / span > < span class = "n" > extract_stack< / span > < span class = "p" > ()< / span >
< span class = "c1" > # Show a warning if the setting is used outside of Django.< / span >
2023-12-02 22:36:16 +00:00
< span class = "c1" > # Stack index: -1 this line, -2 the property, -3 the< / span >
< span class = "c1" > # LazyObject __getattribute__(), -4 the caller.< / span >
< span class = "n" > filename< / span > < span class = "p" > ,< / span > < span class = "n" > _< / span > < span class = "p" > ,< / span > < span class = "n" > _< / span > < span class = "p" > ,< / span > < span class = "n" > _< / span > < span class = "o" > =< / span > < span class = "n" > stack< / span > < span class = "p" > [< / span > < span class = "o" > -< / span > < span class = "mi" > 4< / span > < span class = "p" > ]< / span >
2022-11-14 22:43:45 +01:00
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > filename< / span > < span class = "o" > .< / span > < span class = "n" > startswith< / span > < span class = "p" > (< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > dirname< / span > < span class = "p" > (< / span > < span class = "n" > django< / span > < span class = "o" > .< / span > < span class = "vm" > __file__< / span > < span class = "p" > )):< / span >
2023-12-02 22:36:16 +00:00
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "n" > message< / span > < span class = "p" > ,< / span > < span class = "n" > category< / span > < span class = "p" > ,< / span > < span class = "n" > stacklevel< / span > < span class = "o" > =< / span > < span class = "mi" > 2< / span > < span class = "p" > )< / span >
< span class = "nd" > @property< / span >
< span class = "k" > def< / span > < span class = "nf" > USE_L10N< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _show_deprecation_warning< / span > < span class = "p" > (< / span >
< span class = "n" > USE_L10N_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango50Warning< / span >
< span class = "p" > )< / span >
2022-11-14 22:43:45 +01:00
< span class = "k" > return< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "fm" > __getattr__< / span > < span class = "p" > (< / span > < span class = "s2" > " USE_L10N" < / span > < span class = "p" > )< / span >
< span class = "c1" > # RemovedInDjango50Warning.< / span >
< span class = "nd" > @property< / span >
< span class = "k" > def< / span > < span class = "nf" > _USE_L10N_INTERNAL< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "c1" > # Special hook to avoid checking a traceback in internal use on hot< / span >
< span class = "c1" > # paths.< / span >
< span class = "k" > return< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "fm" > __getattr__< / span > < span class = "p" > (< / span > < span class = "s2" > " USE_L10N" < / span > < span class = "p" > )< / span >
2023-12-02 22:36:16 +00:00
< span class = "c1" > # RemovedInDjango51Warning.< / span >
< span class = "nd" > @property< / span >
< span class = "k" > def< / span > < span class = "nf" > DEFAULT_FILE_STORAGE< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _show_deprecation_warning< / span > < span class = "p" > (< / span >
< span class = "n" > DEFAULT_FILE_STORAGE_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango51Warning< / span >
< span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "fm" > __getattr__< / span > < span class = "p" > (< / span > < span class = "s2" > " DEFAULT_FILE_STORAGE" < / span > < span class = "p" > )< / span >
< span class = "c1" > # RemovedInDjango51Warning.< / span >
< span class = "nd" > @property< / span >
< span class = "k" > def< / span > < span class = "nf" > STATICFILES_STORAGE< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _show_deprecation_warning< / span > < span class = "p" > (< / span >
< span class = "n" > STATICFILES_STORAGE_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango51Warning< / span >
< span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "fm" > __getattr__< / span > < span class = "p" > (< / span > < span class = "s2" > " STATICFILES_STORAGE" < / span > < span class = "p" > )< / span >
2022-11-14 22:43:45 +01:00
< span class = "k" > class< / span > < span class = "nc" > Settings< / span > < span class = "p" > :< / span >
< span class = "k" > def< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > settings_module< / span > < span class = "p" > ):< / span >
< span class = "c1" > # update this dict from global settings (but only for ALL_CAPS settings)< / span >
< span class = "k" > for< / span > < span class = "n" > setting< / span > < span class = "ow" > in< / span > < span class = "nb" > dir< / span > < span class = "p" > (< / span > < span class = "n" > global_settings< / span > < span class = "p" > ):< / span >
< span class = "k" > if< / span > < span class = "n" > setting< / span > < span class = "o" > .< / span > < span class = "n" > isupper< / span > < span class = "p" > ():< / span >
< span class = "nb" > setattr< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > setting< / span > < span class = "p" > ,< / span > < span class = "nb" > getattr< / span > < span class = "p" > (< / span > < span class = "n" > global_settings< / span > < span class = "p" > ,< / span > < span class = "n" > setting< / span > < span class = "p" > ))< / span >
< span class = "c1" > # store the settings module in case someone later cares< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > SETTINGS_MODULE< / span > < span class = "o" > =< / span > < span class = "n" > settings_module< / span >
< span class = "n" > mod< / span > < span class = "o" > =< / span > < span class = "n" > importlib< / span > < span class = "o" > .< / span > < span class = "n" > import_module< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > SETTINGS_MODULE< / span > < span class = "p" > )< / span >
< span class = "n" > tuple_settings< / span > < span class = "o" > =< / span > < span class = "p" > (< / span >
< span class = "s2" > " ALLOWED_HOSTS" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " INSTALLED_APPS" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " TEMPLATE_DIRS" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " LOCALE_PATHS" < / span > < span class = "p" > ,< / span >
2022-11-18 11:08:09 +00:00
< span class = "s2" > " SECRET_KEY_FALLBACKS" < / span > < span class = "p" > ,< / span >
2022-11-14 22:43:45 +01:00
< span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _explicit_settings< / span > < span class = "o" > =< / span > < span class = "nb" > set< / span > < span class = "p" > ()< / span >
< span class = "k" > for< / span > < span class = "n" > setting< / span > < span class = "ow" > in< / span > < span class = "nb" > dir< / span > < span class = "p" > (< / span > < span class = "n" > mod< / span > < span class = "p" > ):< / span >
< span class = "k" > if< / span > < span class = "n" > setting< / span > < span class = "o" > .< / span > < span class = "n" > isupper< / span > < span class = "p" > ():< / span >
< span class = "n" > setting_value< / span > < span class = "o" > =< / span > < span class = "nb" > getattr< / span > < span class = "p" > (< / span > < span class = "n" > mod< / span > < span class = "p" > ,< / span > < span class = "n" > setting< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > setting< / span > < span class = "ow" > in< / span > < span class = "n" > tuple_settings< / span > < span class = "ow" > and< / span > < span class = "ow" > not< / span > < span class = "nb" > isinstance< / span > < span class = "p" > (< / span >
< span class = "n" > setting_value< / span > < span class = "p" > ,< / span > < span class = "p" > (< / span > < span class = "nb" > list< / span > < span class = "p" > ,< / span > < span class = "nb" > tuple< / span > < span class = "p" > )< / span >
< span class = "p" > ):< / span >
< span class = "k" > raise< / span > < span class = "n" > ImproperlyConfigured< / span > < span class = "p" > (< / span >
< span class = "s2" > " The < / span > < span class = "si" > %s< / span > < span class = "s2" > setting must be a list or a tuple." < / span > < span class = "o" > %< / span > < span class = "n" > setting< / span >
< span class = "p" > )< / span >
< span class = "nb" > setattr< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > setting< / span > < span class = "p" > ,< / span > < span class = "n" > setting_value< / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _explicit_settings< / span > < span class = "o" > .< / span > < span class = "n" > add< / span > < span class = "p" > (< / span > < span class = "n" > setting< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > USE_TZ< / span > < span class = "ow" > is< / span > < span class = "kc" > False< / span > < span class = "ow" > and< / span > < span class = "ow" > not< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > is_overridden< / span > < span class = "p" > (< / span > < span class = "s2" > " USE_TZ" < / span > < span class = "p" > ):< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span >
< span class = "s2" > " The default value of USE_TZ will change from False to True " < / span >
< span class = "s2" > " in Django 5.0. Set USE_TZ to False in your project settings " < / span >
< span class = "s2" > " if you want to keep the current default behavior." < / span > < span class = "p" > ,< / span >
< span class = "n" > category< / span > < span class = "o" > =< / span > < span class = "n" > RemovedInDjango50Warning< / span > < span class = "p" > ,< / span >
< span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > is_overridden< / span > < span class = "p" > (< / span > < span class = "s2" > " USE_DEPRECATED_PYTZ" < / span > < span class = "p" > ):< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "n" > USE_DEPRECATED_PYTZ_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango50Warning< / span > < span class = "p" > )< / span >
2022-11-18 11:08:09 +00:00
< span class = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > is_overridden< / span > < span class = "p" > (< / span > < span class = "s2" > " CSRF_COOKIE_MASKED" < / span > < span class = "p" > ):< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "n" > CSRF_COOKIE_MASKED_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango50Warning< / span > < span class = "p" > )< / span >
2022-11-14 22:43:45 +01:00
< span class = "k" > if< / span > < span class = "nb" > hasattr< / span > < span class = "p" > (< / span > < span class = "n" > time< / span > < span class = "p" > ,< / span > < span class = "s2" > " tzset" < / span > < span class = "p" > )< / span > < span class = "ow" > and< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > TIME_ZONE< / span > < span class = "p" > :< / span >
< span class = "c1" > # When we can, attempt to validate the timezone. If we can' t find< / span >
< span class = "c1" > # this file, no check happens and it' s harmless.< / span >
< span class = "n" > zoneinfo_root< / span > < span class = "o" > =< / span > < span class = "n" > Path< / span > < span class = "p" > (< / span > < span class = "s2" > " /usr/share/zoneinfo" < / span > < span class = "p" > )< / span >
< span class = "n" > zone_info_file< / span > < span class = "o" > =< / span > < span class = "n" > zoneinfo_root< / span > < span class = "o" > .< / span > < span class = "n" > joinpath< / span > < span class = "p" > (< / span > < span class = "o" > *< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > TIME_ZONE< / span > < span class = "o" > .< / span > < span class = "n" > split< / span > < span class = "p" > (< / span > < span class = "s2" > " /" < / span > < span class = "p" > ))< / span >
< span class = "k" > if< / span > < span class = "n" > zoneinfo_root< / span > < span class = "o" > .< / span > < span class = "n" > exists< / span > < span class = "p" > ()< / span > < span class = "ow" > and< / span > < span class = "ow" > not< / span > < span class = "n" > zone_info_file< / span > < span class = "o" > .< / span > < span class = "n" > exists< / span > < span class = "p" > ():< / span >
< span class = "k" > raise< / span > < span class = "ne" > ValueError< / span > < span class = "p" > (< / span > < span class = "s2" > " Incorrect timezone setting: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > TIME_ZONE< / span > < span class = "p" > )< / span >
< span class = "c1" > # Move the time zone info into os.environ. See ticket #2315 for why< / span >
< span class = "c1" > # we don' t do this unconditionally (breaks Windows).< / span >
< span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > environ< / span > < span class = "p" > [< / span > < span class = "s2" > " TZ" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > TIME_ZONE< / span >
< span class = "n" > time< / span > < span class = "o" > .< / span > < span class = "n" > tzset< / span > < span class = "p" > ()< / span >
< span class = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > is_overridden< / span > < span class = "p" > (< / span > < span class = "s2" > " USE_L10N" < / span > < span class = "p" > ):< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "n" > USE_L10N_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango50Warning< / span > < span class = "p" > )< / span >
2023-12-02 22:36:16 +00:00
< span class = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > is_overridden< / span > < span class = "p" > (< / span > < span class = "s2" > " DEFAULT_FILE_STORAGE" < / span > < span class = "p" > ):< / span >
< span class = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > is_overridden< / span > < span class = "p" > (< / span > < span class = "s2" > " STORAGES" < / span > < span class = "p" > ):< / span >
< span class = "k" > raise< / span > < span class = "n" > ImproperlyConfigured< / span > < span class = "p" > (< / span >
< span class = "s2" > " DEFAULT_FILE_STORAGE/STORAGES are mutually exclusive." < / span >
< span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "o" > =< / span > < span class = "p" > {< / span >
< span class = "o" > **< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "p" > ,< / span >
< span class = "n" > DEFAULT_STORAGE_ALIAS< / span > < span class = "p" > :< / span > < span class = "p" > {< / span > < span class = "s2" > " BACKEND" < / span > < span class = "p" > :< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > DEFAULT_FILE_STORAGE< / span > < span class = "p" > },< / span >
< span class = "p" > }< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "n" > DEFAULT_FILE_STORAGE_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango51Warning< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > is_overridden< / span > < span class = "p" > (< / span > < span class = "s2" > " STATICFILES_STORAGE" < / span > < span class = "p" > ):< / span >
< span class = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > is_overridden< / span > < span class = "p" > (< / span > < span class = "s2" > " STORAGES" < / span > < span class = "p" > ):< / span >
< span class = "k" > raise< / span > < span class = "n" > ImproperlyConfigured< / span > < span class = "p" > (< / span >
< span class = "s2" > " STATICFILES_STORAGE/STORAGES are mutually exclusive." < / span >
< span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "o" > =< / span > < span class = "p" > {< / span >
< span class = "o" > **< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "p" > ,< / span >
< span class = "n" > STATICFILES_STORAGE_ALIAS< / span > < span class = "p" > :< / span > < span class = "p" > {< / span > < span class = "s2" > " BACKEND" < / span > < span class = "p" > :< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STATICFILES_STORAGE< / span > < span class = "p" > },< / span >
< span class = "p" > }< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "n" > STATICFILES_STORAGE_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango51Warning< / span > < span class = "p" > )< / span >
< span class = "c1" > # RemovedInDjango51Warning.< / span >
< span class = "k" > if< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > is_overridden< / span > < span class = "p" > (< / span > < span class = "s2" > " STORAGES" < / span > < span class = "p" > ):< / span >
< span class = "nb" > setattr< / span > < span class = "p" > (< / span >
< span class = "bp" > self< / span > < span class = "p" > ,< / span >
< span class = "s2" > " DEFAULT_FILE_STORAGE" < / span > < span class = "p" > ,< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "n" > DEFAULT_STORAGE_ALIAS< / span > < span class = "p" > ,< / span > < span class = "p" > {})< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "s2" > " BACKEND" < / span > < span class = "p" > ),< / span >
< span class = "p" > )< / span >
< span class = "nb" > setattr< / span > < span class = "p" > (< / span >
< span class = "bp" > self< / span > < span class = "p" > ,< / span >
< span class = "s2" > " STATICFILES_STORAGE" < / span > < span class = "p" > ,< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "n" > STATICFILES_STORAGE_ALIAS< / span > < span class = "p" > ,< / span > < span class = "p" > {})< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "s2" > " BACKEND" < / span > < span class = "p" > ),< / span >
< span class = "p" > )< / span >
2022-11-14 22:43:45 +01:00
< span class = "k" > def< / span > < span class = "nf" > is_overridden< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > setting< / span > < span class = "p" > ):< / span >
< span class = "k" > return< / span > < span class = "n" > setting< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _explicit_settings< / span >
< span class = "k" > def< / span > < span class = "fm" > __repr__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "k" > return< / span > < span class = "s1" > ' < < / span > < span class = "si" > %(cls)s< / span > < span class = "s1" > " < / span > < span class = "si" > %(settings_module)s< / span > < span class = "s1" > " > ' < / span > < span class = "o" > %< / span > < span class = "p" > {< / span >
< span class = "s2" > " cls" < / span > < span class = "p" > :< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "vm" > __class__< / span > < span class = "o" > .< / span > < span class = "vm" > __name__< / span > < span class = "p" > ,< / span >
< span class = "s2" > " settings_module" < / span > < span class = "p" > :< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > SETTINGS_MODULE< / span > < span class = "p" > ,< / span >
< span class = "p" > }< / span >
< span class = "k" > class< / span > < span class = "nc" > UserSettingsHolder< / span > < span class = "p" > :< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " Holder for user configured settings." " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "c1" > # SETTINGS_MODULE doesn' t make much sense in the manually configured< / span >
< span class = "c1" > # (standalone) case.< / span >
< span class = "n" > SETTINGS_MODULE< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span >
< span class = "k" > def< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > default_settings< / span > < span class = "p" > ):< / span >
2023-01-06 17:19:13 +00:00
< span class = "w" > < / span > < span class = "sd" > " " " < / span >
2022-11-14 22:43:45 +01:00
< span class = "sd" > Requests for configuration variables not in this class are satisfied< / span >
< span class = "sd" > from the module specified in default_settings (if possible).< / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "vm" > __dict__< / span > < span class = "p" > [< / span > < span class = "s2" > " _deleted" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "nb" > set< / span > < span class = "p" > ()< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > default_settings< / span > < span class = "o" > =< / span > < span class = "n" > default_settings< / span >
< span class = "k" > def< / span > < span class = "fm" > __getattr__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > ):< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > name< / span > < span class = "o" > .< / span > < span class = "n" > isupper< / span > < span class = "p" > ()< / span > < span class = "ow" > or< / span > < span class = "n" > name< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _deleted< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > AttributeError< / span >
< span class = "k" > return< / span > < span class = "nb" > getattr< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > default_settings< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "fm" > __setattr__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _deleted< / span > < span class = "o" > .< / span > < span class = "n" > discard< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > name< / span > < span class = "o" > ==< / span > < span class = "s2" > " USE_L10N" < / span > < span class = "p" > :< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "n" > USE_L10N_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango50Warning< / span > < span class = "p" > )< / span >
2022-11-18 11:08:09 +00:00
< span class = "k" > if< / span > < span class = "n" > name< / span > < span class = "o" > ==< / span > < span class = "s2" > " CSRF_COOKIE_MASKED" < / span > < span class = "p" > :< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "n" > CSRF_COOKIE_MASKED_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango50Warning< / span > < span class = "p" > )< / span >
2023-12-02 22:36:16 +00:00
< span class = "k" > if< / span > < span class = "n" > name< / span > < span class = "o" > ==< / span > < span class = "s2" > " DEFAULT_FILE_STORAGE" < / span > < span class = "p" > :< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "p" > [< / span > < span class = "n" > DEFAULT_STORAGE_ALIAS< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "p" > {< / span >
< span class = "s2" > " BACKEND" < / span > < span class = "p" > :< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > DEFAULT_FILE_STORAGE< / span >
< span class = "p" > }< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "n" > DEFAULT_FILE_STORAGE_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango51Warning< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > name< / span > < span class = "o" > ==< / span > < span class = "s2" > " STATICFILES_STORAGE" < / span > < span class = "p" > :< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "p" > [< / span > < span class = "n" > STATICFILES_STORAGE_ALIAS< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "p" > {< / span >
< span class = "s2" > " BACKEND" < / span > < span class = "p" > :< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STATICFILES_STORAGE< / span >
< span class = "p" > }< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "n" > STATICFILES_STORAGE_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango51Warning< / span > < span class = "p" > )< / span >
2022-11-14 22:43:45 +01:00
< span class = "nb" > super< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "fm" > __setattr__< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "n" > value< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > name< / span > < span class = "o" > ==< / span > < span class = "s2" > " USE_DEPRECATED_PYTZ" < / span > < span class = "p" > :< / span >
< span class = "n" > warnings< / span > < span class = "o" > .< / span > < span class = "n" > warn< / span > < span class = "p" > (< / span > < span class = "n" > USE_DEPRECATED_PYTZ_DEPRECATED_MSG< / span > < span class = "p" > ,< / span > < span class = "n" > RemovedInDjango50Warning< / span > < span class = "p" > )< / span >
2023-12-02 22:36:16 +00:00
< span class = "c1" > # RemovedInDjango51Warning.< / span >
< span class = "k" > if< / span > < span class = "n" > name< / span > < span class = "o" > ==< / span > < span class = "s2" > " STORAGES" < / span > < span class = "p" > :< / span >
< span class = "k" > if< / span > < span class = "n" > default_file_storage< / span > < span class = "o" > :=< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "n" > DEFAULT_STORAGE_ALIAS< / span > < span class = "p" > ):< / span >
< span class = "nb" > super< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "fm" > __setattr__< / span > < span class = "p" > (< / span >
< span class = "s2" > " DEFAULT_FILE_STORAGE" < / span > < span class = "p" > ,< / span > < span class = "n" > default_file_storage< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "s2" > " BACKEND" < / span > < span class = "p" > )< / span >
< span class = "p" > )< / span >
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "o" > .< / span > < span class = "n" > setdefault< / span > < span class = "p" > (< / span >
< span class = "n" > DEFAULT_STORAGE_ALIAS< / span > < span class = "p" > ,< / span >
< span class = "p" > {< / span > < span class = "s2" > " BACKEND" < / span > < span class = "p" > :< / span > < span class = "s2" > " django.core.files.storage.FileSystemStorage" < / span > < span class = "p" > },< / span >
< span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > staticfiles_storage< / span > < span class = "o" > :=< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "n" > STATICFILES_STORAGE_ALIAS< / span > < span class = "p" > ):< / span >
< span class = "nb" > super< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "fm" > __setattr__< / span > < span class = "p" > (< / span >
< span class = "s2" > " STATICFILES_STORAGE" < / span > < span class = "p" > ,< / span > < span class = "n" > staticfiles_storage< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "s2" > " BACKEND" < / span > < span class = "p" > )< / span >
< span class = "p" > )< / span >
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > STORAGES< / span > < span class = "o" > .< / span > < span class = "n" > setdefault< / span > < span class = "p" > (< / span >
< span class = "n" > STATICFILES_STORAGE_ALIAS< / span > < span class = "p" > ,< / span >
< span class = "p" > {< / span >
< span class = "s2" > " BACKEND" < / span > < span class = "p" > :< / span > < span class = "p" > (< / span >
< span class = "s2" > " django.contrib.staticfiles.storage.StaticFilesStorage" < / span >
< span class = "p" > ),< / span >
< span class = "p" > },< / span >
< span class = "p" > )< / span >
2022-11-14 22:43:45 +01:00
< span class = "k" > def< / span > < span class = "fm" > __delattr__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > ):< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _deleted< / span > < span class = "o" > .< / span > < span class = "n" > add< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "nb" > hasattr< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > ):< / span >
< span class = "nb" > super< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "fm" > __delattr__< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "fm" > __dir__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "k" > return< / span > < span class = "nb" > sorted< / span > < span class = "p" > (< / span >
< span class = "n" > s< / span >
< span class = "k" > for< / span > < span class = "n" > s< / span > < span class = "ow" > in< / span > < span class = "p" > [< / span > < span class = "o" > *< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "vm" > __dict__< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "nb" > dir< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > default_settings< / span > < span class = "p" > )]< / span >
< span class = "k" > if< / span > < span class = "n" > s< / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _deleted< / span >
< span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > is_overridden< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > setting< / span > < span class = "p" > ):< / span >
< span class = "n" > deleted< / span > < span class = "o" > =< / span > < span class = "n" > setting< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > _deleted< / span >
< span class = "n" > set_locally< / span > < span class = "o" > =< / span > < span class = "n" > setting< / span > < span class = "ow" > in< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "vm" > __dict__< / span >
< span class = "n" > set_on_default< / span > < span class = "o" > =< / span > < span class = "nb" > getattr< / span > < span class = "p" > (< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > default_settings< / span > < span class = "p" > ,< / span > < span class = "s2" > " is_overridden" < / span > < span class = "p" > ,< / span > < span class = "k" > lambda< / span > < span class = "n" > s< / span > < span class = "p" > :< / span > < span class = "kc" > False< / span >
< span class = "p" > )(< / span > < span class = "n" > setting< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > deleted< / span > < span class = "ow" > or< / span > < span class = "n" > set_locally< / span > < span class = "ow" > or< / span > < span class = "n" > set_on_default< / span >
< span class = "k" > def< / span > < span class = "fm" > __repr__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "k" > return< / span > < span class = "s2" > " < < / span > < span class = "si" > %(cls)s< / span > < span class = "s2" > > " < / span > < span class = "o" > %< / span > < span class = "p" > {< / span >
< span class = "s2" > " cls" < / span > < span class = "p" > :< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "vm" > __class__< / span > < span class = "o" > .< / span > < span class = "vm" > __name__< / span > < span class = "p" > ,< / span >
< span class = "p" > }< / span >
< span class = "n" > settings< / span > < span class = "o" > =< / span > < span class = "n" > LazySettings< / span > < span class = "p" > ()< / span >
< / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../../genindex.html" title = "General Index"
>index< / a > < / li >
< li class = "right" >
< a href = "../../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
2023-10-19 20:22:27 +00:00
< li class = "nav-item nav-item-0" > < a href = "../../index.html" > Evennia 2.x< / a > » < / li >
2022-11-14 22:43:45 +01:00
< li class = "nav-item nav-item-1" > < a href = "../index.html" > Module code< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > django.conf< / a > < / li >
< / ul >
< / div >
2023-10-19 20:22:27 +00:00
2022-11-14 22:43:45 +01:00
< div class = "footer" role = "contentinfo" >
2023-10-19 20:22:27 +00:00
© Copyright 2023, The Evennia developer community.
2022-11-14 22:43:45 +01:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
< / div >
< / body >
< / html >