Debian Codegraph @

tests/utils_tests/test_timezone.py

raw
1 import datetime
2 import zoneinfo
3 from unittest import mock
4
5 from django.test import SimpleTestCase, override_settings
6 from django.utils import timezone
7
8 PARIS_ZI = zoneinfo.ZoneInfo("Europe/Paris")
9 EAT = timezone.get_fixed_timezone(180) # Africa/Nairobi
10 ICT = timezone.get_fixed_timezone(420) # Asia/Bangkok
11 UTC = datetime.timezone.utc
12
13
14 class TimezoneTests(SimpleTestCase):
15 def test_default_timezone_is_zoneinfo(self):
16 self.assertIsInstance(timezone.get_default_timezone(), zoneinfo.ZoneInfo)
17
18 def test_now(self):
19 with override_settings(USE_TZ=True):
20 self.assertTrue(timezone.is_aware(timezone.now()))
21 with override_settings(USE_TZ=False):
22 self.assertTrue(timezone.is_naive(timezone.now()))
23
24 def test_localdate(self):
25 naive = datetime.datetime(2015, 1, 1, 0, 0, 1)
26 with self.assertRaisesMessage(
27 ValueError, "localtime() cannot be applied to a naive datetime"
28 ):
29 timezone.localdate(naive)
30 with self.assertRaisesMessage(
31 ValueError, "localtime() cannot be applied to a naive datetime"
32 ):
33 timezone.localdate(naive, timezone=EAT)
34
35 aware = datetime.datetime(2015, 1, 1, 0, 0, 1, tzinfo=ICT)
36 self.assertEqual(
37 timezone.localdate(aware, timezone=EAT), datetime.date(2014, 12, 31)
38 )
39 with timezone.override(EAT):
40 self.assertEqual(timezone.localdate(aware), datetime.date(2014, 12, 31))
41
42 with mock.patch("django.utils.timezone.now", return_value=aware):
43 self.assertEqual(
44 timezone.localdate(timezone=EAT), datetime.date(2014, 12, 31)
45 )
46 with timezone.override(EAT):
47 self.assertEqual(timezone.localdate(), datetime.date(2014, 12, 31))
48
49 def test_override(self):
50 default = timezone.get_default_timezone()
51 try:
52 timezone.activate(ICT)
53
54 with timezone.override(EAT):
55 self.assertIs(EAT, timezone.get_current_timezone())
56 self.assertIs(ICT, timezone.get_current_timezone())
57
58 with timezone.override(None):
59 self.assertIs(default, timezone.get_current_timezone())
60 self.assertIs(ICT, timezone.get_current_timezone())
61
62 timezone.deactivate()
63
64 with timezone.override(EAT):
65 self.assertIs(EAT, timezone.get_current_timezone())
66 self.assertIs(default, timezone.get_current_timezone())
67
68 with timezone.override(None):
69 self.assertIs(default, timezone.get_current_timezone())
70 self.assertIs(default, timezone.get_current_timezone())
71 finally:
72 timezone.deactivate()
73
74 def test_override_decorator(self):
75 default = timezone.get_default_timezone()
76
77 @timezone.override(EAT)
78 def func_tz_eat():
79 self.assertIs(EAT, timezone.get_current_timezone())
80
81 @timezone.override(None)
82 def func_tz_none():
83 self.assertIs(default, timezone.get_current_timezone())
84
85 try:
86 timezone.activate(ICT)
87
88 func_tz_eat()
89 self.assertIs(ICT, timezone.get_current_timezone())
90
91 func_tz_none()
92 self.assertIs(ICT, timezone.get_current_timezone())
93
94 timezone.deactivate()
95
96 func_tz_eat()
97 self.assertIs(default, timezone.get_current_timezone())
98
99 func_tz_none()
100 self.assertIs(default, timezone.get_current_timezone())
101 finally:
102 timezone.deactivate()
103
104 def test_override_string_tz(self):
105 with timezone.override("Asia/Bangkok"):
106 self.assertEqual(timezone.get_current_timezone_name(), "Asia/Bangkok")
107
108 def test_override_fixed_offset(self):
109 with timezone.override(datetime.timezone(datetime.timedelta(), "tzname")):
110 self.assertEqual(timezone.get_current_timezone_name(), "tzname")
111
112 def test_activate_invalid_timezone(self):
113 with self.assertRaisesMessage(ValueError, "Invalid timezone: None"):
114 timezone.activate(None)
115
116 def test_is_aware(self):
117 self.assertTrue(
118 timezone.is_aware(datetime.datetime(2011, 9, 1, 13, 20, 30, tzinfo=EAT))
119 )
120 self.assertFalse(timezone.is_aware(datetime.datetime(2011, 9, 1, 13, 20, 30)))
121
122 def test_is_naive(self):
123 self.assertFalse(
124 timezone.is_naive(datetime.datetime(2011, 9, 1, 13, 20, 30, tzinfo=EAT))
125 )
126 self.assertTrue(timezone.is_naive(datetime.datetime(2011, 9, 1, 13, 20, 30)))
127
128 def test_make_aware(self):
129 self.assertEqual(
130 timezone.make_aware(datetime.datetime(2011, 9, 1, 13, 20, 30), EAT),
131 datetime.datetime(2011, 9, 1, 13, 20, 30, tzinfo=EAT),
132 )
133 with self.assertRaises(ValueError):
134 timezone.make_aware(
135 datetime.datetime(2011, 9, 1, 13, 20, 30, tzinfo=EAT), EAT
136 )
137
138 def test_make_naive(self):
139 self.assertEqual(
140 timezone.make_naive(
141 datetime.datetime(2011, 9, 1, 13, 20, 30, tzinfo=EAT), EAT
142 ),
143 datetime.datetime(2011, 9, 1, 13, 20, 30),
144 )
145 self.assertEqual(
146 timezone.make_naive(
147 datetime.datetime(2011, 9, 1, 17, 20, 30, tzinfo=ICT), EAT
148 ),
149 datetime.datetime(2011, 9, 1, 13, 20, 30),
150 )
151
152 with self.assertRaisesMessage(
153 ValueError, "make_naive() cannot be applied to a naive datetime"
154 ):
155 timezone.make_naive(datetime.datetime(2011, 9, 1, 13, 20, 30), EAT)
156
157 def test_make_naive_no_tz(self):
158 self.assertEqual(
159 timezone.make_naive(datetime.datetime(2011, 9, 1, 13, 20, 30, tzinfo=EAT)),
160 datetime.datetime(2011, 9, 1, 5, 20, 30),
161 )
162
163 def test_make_aware_no_tz(self):
164 self.assertEqual(
165 timezone.make_aware(datetime.datetime(2011, 9, 1, 13, 20, 30)),
166 datetime.datetime(
167 2011, 9, 1, 13, 20, 30, tzinfo=timezone.get_fixed_timezone(-300)
168 ),
169 )
170
171 def test_make_aware2(self):
172 CEST = datetime.timezone(datetime.timedelta(hours=2), "CEST")
173 self.assertEqual(
174 timezone.make_aware(datetime.datetime(2011, 9, 1, 12, 20, 30), PARIS_ZI),
175 datetime.datetime(2011, 9, 1, 12, 20, 30, tzinfo=CEST),
176 )
177 with self.assertRaises(ValueError):
178 timezone.make_aware(
179 datetime.datetime(2011, 9, 1, 12, 20, 30, tzinfo=PARIS_ZI), PARIS_ZI
180 )
181
182 def test_make_naive_zoneinfo(self):
183 self.assertEqual(
184 timezone.make_naive(
185 datetime.datetime(2011, 9, 1, 12, 20, 30, tzinfo=PARIS_ZI), PARIS_ZI
186 ),
187 datetime.datetime(2011, 9, 1, 12, 20, 30),
188 )
189
190 self.assertEqual(
191 timezone.make_naive(
192 datetime.datetime(2011, 9, 1, 12, 20, 30, fold=1, tzinfo=PARIS_ZI),
193 PARIS_ZI,
194 ),
195 datetime.datetime(2011, 9, 1, 12, 20, 30, fold=1),
196 )
197
198 def test_make_aware_zoneinfo_ambiguous(self):
199 # 2:30 happens twice, once before DST ends and once after
200 ambiguous = datetime.datetime(2015, 10, 25, 2, 30)
201
202 std = timezone.make_aware(ambiguous.replace(fold=1), timezone=PARIS_ZI)
203 dst = timezone.make_aware(ambiguous, timezone=PARIS_ZI)
204
205 self.assertEqual(
206 std.astimezone(UTC) - dst.astimezone(UTC), datetime.timedelta(hours=1)
207 )
208 self.assertEqual(std.utcoffset(), datetime.timedelta(hours=1))
209 self.assertEqual(dst.utcoffset(), datetime.timedelta(hours=2))
210
211 def test_make_aware_zoneinfo_non_existent(self):
212 # 2:30 never happened due to DST
213 non_existent = datetime.datetime(2015, 3, 29, 2, 30)
214
215 std = timezone.make_aware(non_existent, PARIS_ZI)
216 dst = timezone.make_aware(non_existent.replace(fold=1), PARIS_ZI)
217
218 self.assertEqual(
219 std.astimezone(UTC) - dst.astimezone(UTC), datetime.timedelta(hours=1)
220 )
221 self.assertEqual(std.utcoffset(), datetime.timedelta(hours=1))
222 self.assertEqual(dst.utcoffset(), datetime.timedelta(hours=2))
223
224 def test_get_timezone_name(self):
225 """
226 The _get_timezone_name() helper must return the offset for fixed offset
227 timezones, for usage with Trunc DB functions.
228
229 The datetime.timezone examples show the current behavior.
230 """
231 tests = [
232 # datetime.timezone, fixed offset with and without `name`.
233 (datetime.timezone(datetime.timedelta(hours=10)), "UTC+10:00"),
234 (
235 datetime.timezone(datetime.timedelta(hours=10), name="Etc/GMT-10"),
236 "Etc/GMT-10",
237 ),
238 # zoneinfo, named and fixed offset.
239 (zoneinfo.ZoneInfo("Europe/Madrid"), "Europe/Madrid"),
240 (zoneinfo.ZoneInfo("Etc/GMT-10"), "+10"),
241 ]
242 for tz, expected in tests:
243 with self.subTest(tz=tz, expected=expected):
244 self.assertEqual(timezone._get_timezone_name(tz), expected)
245
246 def test_get_default_timezone(self):
247 self.assertEqual(timezone.get_default_timezone_name(), "America/Chicago")
248
249 def test_fixedoffset_timedelta(self):
250 delta = datetime.timedelta(hours=1)
251 self.assertEqual(timezone.get_fixed_timezone(delta).utcoffset(None), delta)
252
253 def test_fixedoffset_negative_timedelta(self):
254 delta = datetime.timedelta(hours=-2)
255 self.assertEqual(timezone.get_fixed_timezone(delta).utcoffset(None), delta)