signals.py 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. import os
  2. import time
  3. import warnings
  4. from asgiref.local import Local
  5. from django.apps import apps
  6. from django.core.exceptions import ImproperlyConfigured
  7. from django.core.signals import setting_changed
  8. from django.db import connections, router
  9. from django.db.utils import ConnectionRouter
  10. from django.dispatch import Signal, receiver
  11. from django.utils import timezone
  12. from django.utils.formats import FORMAT_SETTINGS, reset_format_cache
  13. from django.utils.functional import empty
  14. from django.utils.module_loading import import_string
  15. template_rendered = Signal()
  16. # Most setting_changed receivers are supposed to be added below,
  17. # except for cases where the receiver is related to a contrib app.
  18. # Settings that may not work well when using 'override_settings' (#19031)
  19. COMPLEX_OVERRIDE_SETTINGS = {"DATABASES"}
  20. @receiver(setting_changed)
  21. def clear_cache_handlers(*, setting, **kwargs):
  22. if setting == "CACHES":
  23. from django.core.cache import caches, close_caches
  24. close_caches()
  25. caches._settings = caches.settings = caches.configure_settings(None)
  26. caches._connections = Local()
  27. @receiver(setting_changed)
  28. def update_installed_apps(*, setting, **kwargs):
  29. if setting == "INSTALLED_APPS":
  30. # Rebuild any AppDirectoriesFinder instance.
  31. from django.contrib.staticfiles.finders import get_finder
  32. get_finder.cache_clear()
  33. # Rebuild management commands cache
  34. from django.core.management import get_commands
  35. get_commands.cache_clear()
  36. # Rebuild get_app_template_dirs cache.
  37. from django.template.utils import get_app_template_dirs
  38. get_app_template_dirs.cache_clear()
  39. # Rebuild translations cache.
  40. from django.utils.translation import trans_real
  41. trans_real._translations = {}
  42. @receiver(setting_changed)
  43. def update_connections_time_zone(*, setting, **kwargs):
  44. if setting == "TIME_ZONE":
  45. # Reset process time zone
  46. if hasattr(time, "tzset"):
  47. if kwargs["value"]:
  48. os.environ["TZ"] = kwargs["value"]
  49. else:
  50. os.environ.pop("TZ", None)
  51. time.tzset()
  52. # Reset local time zone cache
  53. timezone.get_default_timezone.cache_clear()
  54. # Reset the database connections' time zone
  55. if setting in {"TIME_ZONE", "USE_TZ"}:
  56. for conn in connections.all(initialized_only=True):
  57. try:
  58. del conn.timezone
  59. except AttributeError:
  60. pass
  61. try:
  62. del conn.timezone_name
  63. except AttributeError:
  64. pass
  65. conn.ensure_timezone()
  66. @receiver(setting_changed)
  67. def clear_routers_cache(*, setting, **kwargs):
  68. if setting == "DATABASE_ROUTERS":
  69. router.routers = ConnectionRouter().routers
  70. @receiver(setting_changed)
  71. def reset_template_engines(*, setting, **kwargs):
  72. if setting in {
  73. "TEMPLATES",
  74. "DEBUG",
  75. "INSTALLED_APPS",
  76. }:
  77. from django.template import engines
  78. try:
  79. del engines.templates
  80. except AttributeError:
  81. pass
  82. engines._templates = None
  83. engines._engines = {}
  84. from django.template.engine import Engine
  85. Engine.get_default.cache_clear()
  86. from django.forms.renderers import get_default_renderer
  87. get_default_renderer.cache_clear()
  88. @receiver(setting_changed)
  89. def storages_changed(*, setting, **kwargs):
  90. from django.contrib.staticfiles.storage import staticfiles_storage
  91. from django.core.files.storage import default_storage, storages
  92. if setting in (
  93. "STORAGES",
  94. "STATIC_ROOT",
  95. "STATIC_URL",
  96. ):
  97. try:
  98. del storages.backends
  99. except AttributeError:
  100. pass
  101. storages._backends = None
  102. storages._storages = {}
  103. default_storage._wrapped = empty
  104. staticfiles_storage._wrapped = empty
  105. @receiver(setting_changed)
  106. def clear_serializers_cache(*, setting, **kwargs):
  107. if setting == "SERIALIZATION_MODULES":
  108. from django.core import serializers
  109. serializers._serializers = {}
  110. @receiver(setting_changed)
  111. def language_changed(*, setting, **kwargs):
  112. if setting in {"LANGUAGES", "LANGUAGE_CODE", "LOCALE_PATHS"}:
  113. from django.utils.translation import trans_real
  114. trans_real._default = None
  115. trans_real._active = Local()
  116. if setting in {"LANGUAGES", "LOCALE_PATHS"}:
  117. from django.utils.translation import trans_real
  118. trans_real._translations = {}
  119. trans_real.check_for_language.cache_clear()
  120. @receiver(setting_changed)
  121. def localize_settings_changed(*, setting, **kwargs):
  122. if setting in FORMAT_SETTINGS or setting == "USE_THOUSAND_SEPARATOR":
  123. reset_format_cache()
  124. # RemovedInDjango51Warning.
  125. @receiver(setting_changed)
  126. def file_storage_changed(*, setting, **kwargs):
  127. if setting == "DEFAULT_FILE_STORAGE":
  128. from django.conf import DEFAULT_STORAGE_ALIAS
  129. from django.core.files.storage import default_storage, storages
  130. try:
  131. del storages.backends
  132. except AttributeError:
  133. pass
  134. storages._storages[DEFAULT_STORAGE_ALIAS] = import_string(kwargs["value"])()
  135. default_storage._wrapped = empty
  136. @receiver(setting_changed)
  137. def complex_setting_changed(*, enter, setting, **kwargs):
  138. if enter and setting in COMPLEX_OVERRIDE_SETTINGS:
  139. # Considering the current implementation of the signals framework,
  140. # this stacklevel shows the line containing the override_settings call.
  141. warnings.warn(
  142. f"Overriding setting {setting} can lead to unexpected behavior.",
  143. stacklevel=5,
  144. )
  145. @receiver(setting_changed)
  146. def root_urlconf_changed(*, setting, **kwargs):
  147. if setting == "ROOT_URLCONF":
  148. from django.urls import clear_url_caches, set_urlconf
  149. clear_url_caches()
  150. set_urlconf(None)
  151. @receiver(setting_changed)
  152. def static_storage_changed(*, setting, **kwargs):
  153. if setting in {
  154. "STATICFILES_STORAGE",
  155. "STATIC_ROOT",
  156. "STATIC_URL",
  157. }:
  158. from django.contrib.staticfiles.storage import staticfiles_storage
  159. staticfiles_storage._wrapped = empty
  160. # RemovedInDjango51Warning.
  161. if setting == "STATICFILES_STORAGE":
  162. from django.conf import STATICFILES_STORAGE_ALIAS
  163. from django.core.files.storage import storages
  164. try:
  165. del storages.backends
  166. except AttributeError:
  167. pass
  168. storages._storages[STATICFILES_STORAGE_ALIAS] = import_string(kwargs["value"])()
  169. @receiver(setting_changed)
  170. def static_finders_changed(*, setting, **kwargs):
  171. if setting in {
  172. "STATICFILES_DIRS",
  173. "STATIC_ROOT",
  174. }:
  175. from django.contrib.staticfiles.finders import get_finder
  176. get_finder.cache_clear()
  177. @receiver(setting_changed)
  178. def auth_password_validators_changed(*, setting, **kwargs):
  179. if setting == "AUTH_PASSWORD_VALIDATORS":
  180. from django.contrib.auth.password_validation import (
  181. get_default_password_validators,
  182. )
  183. get_default_password_validators.cache_clear()
  184. @receiver(setting_changed)
  185. def user_model_swapped(*, setting, **kwargs):
  186. if setting == "AUTH_USER_MODEL":
  187. apps.clear_cache()
  188. try:
  189. from django.contrib.auth import get_user_model
  190. UserModel = get_user_model()
  191. except ImproperlyConfigured:
  192. # Some tests set an invalid AUTH_USER_MODEL.
  193. pass
  194. else:
  195. from django.contrib.auth import backends
  196. backends.UserModel = UserModel
  197. from django.contrib.auth import forms
  198. forms.UserModel = UserModel
  199. from django.contrib.auth.handlers import modwsgi
  200. modwsgi.UserModel = UserModel
  201. from django.contrib.auth.management.commands import changepassword
  202. changepassword.UserModel = UserModel
  203. from django.contrib.auth import views
  204. views.UserModel = UserModel