signals.py 8.0 KB

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