signals.py 7.2 KB

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