Debian Codegraph @

django/test/signals.py

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