File: test_ewsdatetime.py

package info (click to toggle)
python-exchangelib 5.5.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 12,084 kB
  • sloc: python: 25,351; sh: 6; makefile: 5
file content (285 lines) | stat: -rw-r--r-- 12,618 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
import datetime
import unittest
import zoneinfo

import dateutil.tz
import pytz
import requests_mock

from exchangelib.errors import NaiveDateTimeNotAllowed, UnknownTimeZone
from exchangelib.ewsdatetime import UTC, EWSDate, EWSDateTime, EWSTimeZone
from exchangelib.util import CONNECTION_ERRORS
from exchangelib.winzone import (
    CLDR_TO_MS_TIMEZONE_MAP,
    CLDR_WINZONE_OTHER_VERSION,
    CLDR_WINZONE_TYPE_VERSION,
    CLDR_WINZONE_URL,
    generate_map,
)

from .common import TimedTestCase, get_settings


class EWSDateTimeTest(TimedTestCase):
    def test_super_methods(self):
        tz = EWSTimeZone("Europe/Copenhagen")
        self.assertIsInstance(EWSDateTime.now(), EWSDateTime)
        self.assertIsInstance(EWSDateTime.now(tz=tz), EWSDateTime)
        self.assertIsInstance(EWSDateTime.utcnow(), EWSDateTime)
        self.assertIsInstance(EWSDateTime.fromtimestamp(123456789), EWSDateTime)
        self.assertIsInstance(EWSDateTime.fromtimestamp(123456789, tz=tz), EWSDateTime)
        self.assertIsInstance(EWSDateTime.utcfromtimestamp(123456789), EWSDateTime)

    def test_ewsdatetime(self):
        # Test a static timezone
        tz = EWSTimeZone("Etc/GMT-5")
        dt = EWSDateTime(2000, 1, 2, 3, 4, 5, 678901, tzinfo=tz)
        self.assertIsInstance(dt, EWSDateTime)
        self.assertIsInstance(dt.tzinfo, EWSTimeZone)
        self.assertEqual(dt.tzinfo.ms_id, tz.ms_id)
        self.assertEqual(dt.tzinfo.ms_name, tz.ms_name)
        self.assertEqual(str(dt), "2000-01-02 03:04:05.678901+05:00")
        self.assertEqual(repr(dt), "EWSDateTime(2000, 1, 2, 3, 4, 5, 678901, tzinfo=EWSTimeZone(key='Etc/GMT-5'))")

        # Test a DST timezone
        tz = EWSTimeZone("Europe/Copenhagen")
        dt = EWSDateTime(2000, 1, 2, 3, 4, 5, 678901, tzinfo=tz)
        self.assertIsInstance(dt, EWSDateTime)
        self.assertIsInstance(dt.tzinfo, EWSTimeZone)
        self.assertEqual(dt.tzinfo.ms_id, tz.ms_id)
        self.assertEqual(dt.tzinfo.ms_name, tz.ms_name)
        self.assertEqual(str(dt), "2000-01-02 03:04:05.678901+01:00")
        self.assertEqual(
            repr(dt), "EWSDateTime(2000, 1, 2, 3, 4, 5, 678901, tzinfo=EWSTimeZone(key='Europe/Copenhagen'))"
        )

        # Test from_string
        with self.assertRaises(NaiveDateTimeNotAllowed):
            EWSDateTime.from_string("2000-01-02T03:04:05")
        self.assertEqual(
            EWSDateTime.from_string("2000-01-02T03:04:05+01:00"), EWSDateTime(2000, 1, 2, 2, 4, 5, tzinfo=UTC)
        )
        self.assertEqual(EWSDateTime.from_string("2000-01-02T03:04:05Z"), EWSDateTime(2000, 1, 2, 3, 4, 5, tzinfo=UTC))
        self.assertIsInstance(EWSDateTime.from_string("2000-01-02T03:04:05+01:00"), EWSDateTime)
        self.assertIsInstance(EWSDateTime.from_string("2000-01-02T03:04:05Z"), EWSDateTime)

        # Test addition, subtraction, summertime etc
        self.assertIsInstance(dt + datetime.timedelta(days=1), EWSDateTime)
        self.assertIsInstance(dt - datetime.timedelta(days=1), EWSDateTime)
        self.assertIsInstance(dt - EWSDateTime.now(tz=tz), datetime.timedelta)
        self.assertIsInstance(EWSDateTime.now(tz=tz), EWSDateTime)

        # Test various input for from_datetime()
        self.assertEqual(
            dt,
            EWSDateTime.from_datetime(
                datetime.datetime(2000, 1, 2, 3, 4, 5, 678901, tzinfo=EWSTimeZone("Europe/Copenhagen"))
            ),
        )
        self.assertEqual(
            dt,
            EWSDateTime.from_datetime(
                datetime.datetime(2000, 1, 2, 3, 4, 5, 678901, tzinfo=zoneinfo.ZoneInfo("Europe/Copenhagen"))
            ),
        )
        self.assertEqual(
            dt,
            EWSDateTime.from_datetime(
                datetime.datetime(2000, 1, 2, 3, 4, 5, 678901, tzinfo=dateutil.tz.gettz("Europe/Copenhagen"))
            ),
        )
        self.assertEqual(
            dt,
            EWSDateTime.from_datetime(
                datetime.datetime(2000, 1, 2, 3, 4, 5, 678901, tzinfo=pytz.timezone("Europe/Copenhagen"))
            ),
        )

        self.assertEqual(dt.ewsformat(), "2000-01-02T03:04:05.678901+01:00")
        utc_tz = EWSTimeZone("UTC")
        self.assertEqual(dt.astimezone(utc_tz).ewsformat(), "2000-01-02T02:04:05.678901Z")
        # Test summertime
        dt = EWSDateTime(2000, 8, 2, 3, 4, 5, 678901, tzinfo=tz)
        self.assertEqual(dt.astimezone(utc_tz).ewsformat(), "2000-08-02T01:04:05.678901Z")

        # Test in-place add and subtract
        dt = EWSDateTime(2000, 1, 2, 3, 4, 5, tzinfo=tz)
        dt += datetime.timedelta(days=1)
        self.assertIsInstance(dt, EWSDateTime)
        self.assertEqual(dt, EWSDateTime(2000, 1, 3, 3, 4, 5, tzinfo=tz))
        dt = EWSDateTime(2000, 1, 2, 3, 4, 5, tzinfo=tz)
        dt -= datetime.timedelta(days=1)
        self.assertIsInstance(dt, EWSDateTime)
        self.assertEqual(dt, EWSDateTime(2000, 1, 1, 3, 4, 5, tzinfo=tz))

        # Test ewsformat() failure
        dt = EWSDateTime(2000, 1, 2, 3, 4, 5)
        with self.assertRaises(ValueError):
            dt.ewsformat()
        # Test wrong tzinfo type
        with self.assertRaises(TypeError):
            EWSDateTime(2000, 1, 2, 3, 4, 5, tzinfo=pytz.timezone("Europe/Copenhagen"))
        with self.assertRaises(TypeError):
            EWSDateTime.from_datetime(EWSDateTime(2000, 1, 2, 3, 4, 5))

        # Test isoformat
        dt = EWSDateTime(2000, 1, 2, 3, 4, 5, tzinfo=tz)
        fmt = dt.isoformat()
        self.assertEqual(fmt, "2000-01-02T03:04:05+01:00")
        dt = EWSDateTime.fromisoformat(fmt)
        self.assertEqual(dt, EWSDateTime(2000, 1, 2, 3, 4, 5, tzinfo=tz))


class EWSTimeZoneTest(TimedTestCase):
    def test_magic(self):
        hash(EWSTimeZone("Europe/Copenhagen"))

    def test_ewstimezone(self):
        # Test autogenerated translations
        tz = EWSTimeZone("Europe/Copenhagen")
        self.assertIsInstance(tz, EWSTimeZone)
        self.assertEqual(tz.key, "Europe/Copenhagen")
        self.assertEqual(tz.ms_id, "Romance Standard Time")
        # self.assertEqual(EWSTimeZone('Europe/Copenhagen').ms_name, '')  # EWS works fine without the ms_name

        # Test localzone()
        tz = EWSTimeZone.localzone()
        self.assertIsInstance(tz, EWSTimeZone)

        # Test common helpers
        tz = EWSTimeZone("UTC")
        self.assertIsInstance(tz, EWSTimeZone)
        self.assertEqual(tz.key, "UTC")
        self.assertEqual(tz.ms_id, "UTC")
        tz = EWSTimeZone("GMT")
        self.assertIsInstance(tz, EWSTimeZone)
        self.assertEqual(tz.key, "GMT")
        self.assertEqual(tz.ms_id, "UTC")

        # Test mapper contents. Latest map from unicode.org has 394 entries
        self.assertGreater(len(EWSTimeZone.IANA_TO_MS_MAP), 300)
        for k, v in EWSTimeZone.IANA_TO_MS_MAP.items():
            self.assertIsInstance(k, str)
            self.assertIsInstance(v, tuple)
            self.assertEqual(len(v), 2)
            self.assertIsInstance(v[0], str)

        # Test timezone unknown by ZoneInfo
        with self.assertRaises(UnknownTimeZone) as e:
            EWSTimeZone("UNKNOWN")
        self.assertEqual(e.exception.args[0], "No time zone found with key UNKNOWN")

        # Test timezone known by IANA but with no Winzone mapping
        orig = EWSTimeZone.IANA_TO_MS_MAP["Africa/Tripoli"]
        try:
            with self.assertRaises(UnknownTimeZone) as e:
                del EWSTimeZone.IANA_TO_MS_MAP["Africa/Tripoli"]
                EWSTimeZone("Africa/Tripoli")
            self.assertEqual(e.exception.args[0], "No Windows timezone name found for timezone 'Africa/Tripoli'")
        finally:
            EWSTimeZone.IANA_TO_MS_MAP["Africa/Tripoli"] = orig

        # Test __eq__ with non-EWSTimeZone compare
        self.assertFalse(EWSTimeZone("GMT") == zoneinfo.ZoneInfo("UTC"))

        # Test from_ms_id() with non-standard MS ID
        self.assertEqual(EWSTimeZone("Europe/Copenhagen"), EWSTimeZone.from_ms_id("Europe/Copenhagen"))

    def test_from_timezone(self):
        self.assertEqual(EWSTimeZone("Europe/Copenhagen"), EWSTimeZone.from_timezone(EWSTimeZone("Europe/Copenhagen")))
        self.assertEqual(
            EWSTimeZone("Europe/Copenhagen"), EWSTimeZone.from_timezone(zoneinfo.ZoneInfo("Europe/Copenhagen"))
        )
        self.assertEqual(
            EWSTimeZone("Europe/Copenhagen"), EWSTimeZone.from_timezone(dateutil.tz.gettz("Europe/Copenhagen"))
        )
        self.assertEqual(
            EWSTimeZone("Europe/Copenhagen"), EWSTimeZone.from_timezone(pytz.timezone("Europe/Copenhagen"))
        )

        self.assertEqual(EWSTimeZone("UTC"), EWSTimeZone.from_timezone(dateutil.tz.UTC))
        self.assertEqual(EWSTimeZone("UTC"), EWSTimeZone.from_timezone(datetime.timezone.utc))

    def test_generate(self):
        try:
            get_settings()
        except FileNotFoundError:
            # We don't actually need settings here, but it's a convenient way to separate unit and integration tests.
            # This test pulls in timezone maps from the Internet, which may cause the test case to break in the future.
            # Let's leave the unit test suite as stable as possible. Unit tests are what is run if you don't create a
            # settings.yml file.
            raise unittest.SkipTest(f"Skipping {self.__class__.__name__} - this is an integration test")
        try:
            type_version, other_version, tz_map = generate_map()
        except CONNECTION_ERRORS:
            # generate_map() requires access to unicode.org, which may be unavailable. Don't fail test, since this is
            # out of our control.
            return
        self.assertEqual(type_version, CLDR_WINZONE_TYPE_VERSION)
        self.assertEqual(other_version, CLDR_WINZONE_OTHER_VERSION)
        self.assertDictEqual(CLDR_TO_MS_TIMEZONE_MAP, tz_map)

        # Test IANA exceptions. This fails if available_timezones() returns timezones that we have not yet implemented.
        # If this fails in CI but not locally, you need to update the 'tzdata' package to the latest version.
        sanitized = list(t for t in zoneinfo.available_timezones() if not t.startswith("SystemV/") and t != "localtime")
        # TODO: IANA removed timezones that zoneinfo still has
        self.assertEqual(
            set(sanitized) - set(EWSTimeZone.IANA_TO_MS_MAP),
            {
                "America/Montreal",
                "America/Nipigon",
                "America/Pangnirtung",
                "America/Rainy_River",
                "America/Santa_Isabel",
                "America/Thunder_Bay",
                "America/Yellowknife",
                "Australia/Currie",
                "CST6CDT",
                "EST5EDT",
                "Europe/Uzhgorod",
                "Europe/Zaporozhye",
                "MST7MDT",
                "PST8PDT",
                "Pacific/Johnston",
            },
        )

    @requests_mock.mock()
    def test_generate_failure(self, m):
        m.get(CLDR_WINZONE_URL, status_code=500)
        with self.assertRaises(ValueError):
            generate_map()


class EWSDateTest(TimedTestCase):
    def test_ewsdate(self):
        self.assertEqual(EWSDate(2000, 1, 1).ewsformat(), "2000-01-01")
        self.assertEqual(EWSDate.from_string("2000-01-01"), EWSDate(2000, 1, 1))
        self.assertEqual(EWSDate.from_string("2000-01-01Z"), EWSDate(2000, 1, 1))
        self.assertEqual(EWSDate.from_string("2000-01-01+01:00"), EWSDate(2000, 1, 1))
        self.assertEqual(EWSDate.from_string("2000-01-01-01:00"), EWSDate(2000, 1, 1))
        self.assertIsInstance(EWSDate(2000, 1, 2) - EWSDate(2000, 1, 1), datetime.timedelta)
        self.assertIsInstance(EWSDate(2000, 1, 2) + datetime.timedelta(days=1), EWSDate)
        self.assertIsInstance(EWSDate(2000, 1, 2) - datetime.timedelta(days=1), EWSDate)

        # Test in-place add and subtract
        dt = EWSDate(2000, 1, 2)
        dt += datetime.timedelta(days=1)
        self.assertIsInstance(dt, EWSDate)
        self.assertEqual(dt, EWSDate(2000, 1, 3))
        dt = EWSDate(2000, 1, 2)
        dt -= datetime.timedelta(days=1)
        self.assertIsInstance(dt, EWSDate)
        self.assertEqual(dt, EWSDate(2000, 1, 1))

        with self.assertRaises(TypeError):
            EWSDate.from_date(EWSDate(2000, 1, 2))

        self.assertEqual(EWSDate.fromordinal(730120), EWSDate(2000, 1, 1))

        # Test isoformat
        dt = EWSDate(2000, 1, 2)
        fmt = dt.isoformat()
        self.assertEqual(fmt, "2000-01-02")
        dt = EWSDate.fromisoformat(fmt)
        self.assertEqual(dt, EWSDate(2000, 1, 2))