Event set start and end dates won't force timezone to be protocol timezone

Author: Alejandro Casanovas

O365/calendar.py

@@ -1,6 +1,7 @@
 import calendar
 import datetime as dt
 import logging
+from zoneinfo import ZoneInfo
 
 # noinspection PyPep8Naming
 from bs4 import BeautifulSoup as bs
@@ -551,10 +552,9 @@ def __init__(self, parent, response_status):
                 self.response_time = None
             if self.response_time:
                 try:
-                    self.response_time = parse(self.response_time).astimezone(
-                        self.protocol.timezone)
+                    self.response_time = parse(self.response_time).astimezone(self.protocol.timezone)
                 except OverflowError:
-                    log.debug("Couldn't parse event response time: {}".format(self.response_time))
+                    log.debug(f"Couldn't parse event response time: {self.response_time}")
                     self.response_time = None
         else:
             self.response_time = None
@@ -1066,8 +1066,9 @@ def start(self, value):
         if value.tzinfo is None:
             # localize datetime
             value = value.replace(tzinfo=self.protocol.timezone)
-        elif value.tzinfo != self.protocol.timezone:
-            value = value.astimezone(self.protocol.timezone)
+        else:
+            if not isinstance(value.tzinfo, ZoneInfo):
+                raise ValueError('TimeZone data must be set using ZoneInfo objects')
         self.__start = value
         if not self.end:
             self.end = self.__start + dt.timedelta(minutes=30)
@@ -1093,8 +1094,9 @@ def end(self, value):
         if value.tzinfo is None:
             # localize datetime
             value = value.replace(tzinfo=self.protocol.timezone)
-        elif value.tzinfo != self.protocol.timezone:
-            value = value.astimezone(self.protocol.timezone)
+        else:
+            if not isinstance(value.tzinfo, ZoneInfo):
+                raise ValueError('TimeZone data must be set using ZoneInfo objects')
         self.__end = value
         self._track_changes.add(self._cc('end'))
 
@@ -1371,7 +1373,7 @@ def get_occurrences(self, start, end, *, limit=None, query=None, order_by=None,
         :rtype: list[Event] or Pagination
         """
         if self.event_type != EventType.SeriesMaster:
-            # you can only get occurrences if its a seriesMaster
+            # you can only get occurrences if it's a seriesMaster
             return []
 
         url = self.build_url(
@@ -1397,6 +1399,7 @@ def get_occurrences(self, start, end, *, limit=None, query=None, order_by=None,
         if start.tzinfo is None:
             # if it's a naive datetime, localize the datetime.
             start = start.replace(tzinfo=self.protocol.timezone)  # localize datetime into local tz
+        # TODO: convert to utc when quering?
         if start.tzinfo != dt.timezone.utc:
             start = start.astimezone(dt.timezone.utc)  # transform local datetime to utc
 
@@ -1406,6 +1409,7 @@ def get_occurrences(self, start, end, *, limit=None, query=None, order_by=None,
         if end.tzinfo is None:
             # if it's a naive datetime, localize the datetime.
             end = end.replace(tzinfo=self.protocol.timezone)  # localize datetime into local tz
+        # TODO: convert to utc when quering?
         if end.tzinfo != dt.timezone.utc:
             end = end.astimezone(dt.timezone.utc)  # transform local datetime to utc
 
@@ -1439,8 +1443,7 @@ def delete(self):
         if self.object_id is None:
             raise RuntimeError('Attempting to delete an unsaved event')
 
-        url = self.build_url(
-            self._endpoints.get('event').format(id=self.object_id))
+        url = self.build_url(self._endpoints.get('event').format(id=self.object_id))
 
         response = self.con.delete(url)
 
@@ -1458,16 +1461,13 @@ def save(self):
             # update event
             if not self._track_changes:
                 return True  # there's nothing to update
-            url = self.build_url(
-                self._endpoints.get('event').format(id=self.object_id))
+            url = self.build_url(self._endpoints.get('event').format(id=self.object_id))
             method = self.con.patch
             data = self.to_api_data(restrict_keys=self._track_changes)
         else:
             # new event
             if self.calendar_id:
-                url = self.build_url(
-                    self._endpoints.get('event_calendar').format(
-                        id=self.calendar_id))
+                url = self.build_url(self._endpoints.get('event_calendar').format(id=self.calendar_id))
             else:
                 url = self.build_url(self._endpoints.get('event_default'))
             method = self.con.post
@@ -1721,7 +1721,7 @@ def delete(self):
 
     def get_events(self, limit=25, *, query=None, order_by=None, batch=None,
                    download_attachments=False, include_recurring=True):
-        """ Get events from the this Calendar
+        """ Get events from this Calendar
 
         :param int limit: max no. of events to get. Over 999 uses batch.
         :param query: applies a OData filter to the request

O365/utils/utils.py

@@ -2,6 +2,7 @@
 import logging
 from collections import OrderedDict
 from enum import Enum
+from typing import Union, Dict
 from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
 
 from dateutil.parser import parse
@@ -419,10 +420,15 @@ def _cc(self, dict_key):
         """ Alias for protocol.convert_case """
         return self.protocol.convert_case(dict_key)
 
-    def _parse_date_time_time_zone(self, date_time_time_zone, is_all_day=False):
-        """ Parses and convert to protocol timezone a dateTimeTimeZone resource
+    def _parse_date_time_time_zone(self,
+                                   date_time_time_zone: Union[dict, str],
+                                   is_all_day: bool = False) -> Union[dt.datetime, None]:
+        """
+        Parses and convert to protocol timezone a dateTimeTimeZone resource
         This resource is a dict with a date time and a windows timezone
         This is a common structure on Microsoft apis so it's included here.
+
+        Returns a dt.datetime with the datime converted to protocol timezone
         """
         if date_time_time_zone is None:
             return None
@@ -432,12 +438,13 @@ def _parse_date_time_time_zone(self, date_time_time_zone, is_all_day=False):
             try:
                 timezone = get_iana_tz(date_time_time_zone.get(self._cc('timeZone'), 'UTC'))
             except ZoneInfoNotFoundError:
+                log.debug('TimeZone not found. Using protocol timezone instead.')
                 timezone = local_tz
             date_time = date_time_time_zone.get(self._cc('dateTime'), None)
             try:
                 date_time = parse(date_time).replace(tzinfo=timezone) if date_time else None
             except OverflowError as e:
-                log.debug('Could not parse dateTimeTimeZone: {}. Error: {}'.format(date_time_time_zone, str(e)))
+                log.debug(f'Could not parse dateTimeTimeZone: {date_time_time_zone}. Error: {e}')
                 date_time = None
 
             if date_time and timezone != local_tz:
@@ -450,14 +457,16 @@ def _parse_date_time_time_zone(self, date_time_time_zone, is_all_day=False):
             try:
                 date_time = parse(date_time_time_zone).replace(tzinfo=local_tz) if date_time_time_zone else None
             except Exception as e:
-                log.debug('Could not parse dateTimeTimeZone: {}. Error: {}'.format(date_time_time_zone, str(e)))
+                log.debug(f'Could not parse dateTimeTimeZone: {date_time_time_zone}. Error: {e}')
                 date_time = None
 
         return date_time
 
-    def _build_date_time_time_zone(self, date_time):
-        """ Converts a datetime to a dateTimeTimeZone resource """
+    def _build_date_time_time_zone(self, date_time: dt.datetime) -> Dict[str, str]:
+        """ Converts a datetime to a dateTimeTimeZone resource Dict[datetime, windows timezone] """
         timezone = None
+
+        # extract timezone ZoneInfo from provided datetime
         if date_time.tzinfo is not None:
             if isinstance(date_time.tzinfo, ZoneInfo):
                 timezone = date_time.tzinfo
@@ -471,6 +480,7 @@ def _build_date_time_time_zone(self, date_time):
             else:
                 raise ValueError("Unexpected tzinfo class. Can't convert to ZoneInfo.")
 
+        # convert ZoneInfo timezone (IANA) to a string windows timezone
         timezone = get_windows_tz(timezone or self.protocol.timezone)
 
         return {
@@ -960,6 +970,7 @@ def _parse_filter_word(self, word):
                 if word.tzinfo is None:
                     # if it's a naive datetime, localize the datetime.
                     word = word.replace(tzinfo=self.protocol.timezone)  # localize datetime into local tz
+                # TODO: remove UTC CONVERSION: not affected when quering calendar events
                 if word.tzinfo != dt.timezone.utc:
                     word = word.astimezone(
                         dt.timezone.utc)  # transform local datetime to utc