new prefer timezone set for protocols

Added prefer header when replying to messages

fixed some imports and styling

Author: Alejandro Casanovas

O365/account.py

@@ -1,6 +1,6 @@
 from typing import Type, Tuple, Optional, Callable
 from .connection import Connection, Protocol, MSGraphProtocol, MSOffice365Protocol
-from .utils import ME_RESOURCE, consent
+from .utils import ME_RESOURCE, consent_input_token
 
 
 class Account:
@@ -81,7 +81,7 @@ def is_authenticated(self) -> bool:
         return token is not None and not token.is_expired
 
     def authenticate(self, *, scopes: Optional[list] = None,
-                     handle_consent: Callable = consent.consent_input_token, **kwargs) -> bool:
+                     handle_consent: Callable = consent_input_token, **kwargs) -> bool:
         """ Performs the oauth authentication flow using the console resulting in a stored token.
         It uses the credentials passed on instantiation.
         Returns True if succeded otherwise False.

O365/connection.py

@@ -16,7 +16,7 @@
 from stringcase import pascalcase, camelcase, snakecase
 from tzlocal import get_localzone
 from zoneinfo import ZoneInfoNotFoundError, ZoneInfo
-from .utils import ME_RESOURCE, BaseTokenBackend, FileSystemTokenBackend, Token
+from .utils import ME_RESOURCE, BaseTokenBackend, FileSystemTokenBackend, Token, get_windows_tz
 import datetime as dt
 
 log = logging.getLogger(__name__)
@@ -100,20 +100,12 @@ def __init__(self, *, protocol_url: Optional[str] = None,
         self.use_default_casing: bool = True if casing_function is None else False
         self.casing_function: Callable = casing_function or camelcase
 
+        # get_localzone() from tzlocal will try to get the system local timezone and if not will return UTC
+        self._timezone: ZoneInfo = get_localzone()
+
         if timezone:
-            if isinstance(timezone, str):
-                # convert string to ZoneInfo
-                try:
-                    timezone = ZoneInfo(timezone)
-                except ZoneInfoNotFoundError as e:
-                    log.error(f'Timezone {timezone} could not be found.')
-                    raise e
-            else:
-                if not isinstance(timezone, ZoneInfo):
-                    raise ValueError(f'The timezone parameter must be either a string or a valid ZoneInfo instance.')
+            self.timezone = timezone  # property setter will convert this timezone to ZoneInfo if a string is provided
 
-        # get_localzone() from tzlocal will try to get the system local timezone and if not will return UTC
-        self.timezone: ZoneInfo = timezone or get_localzone()
         self.max_top_value: int = 500  # Max $top parameter value
 
         # define any keyword that can be different in this protocol
@@ -122,6 +114,28 @@ def __init__(self, *, protocol_url: Optional[str] = None,
         #  outlook = #Microsoft.OutlookServices.FileAttachment')
         self.keyword_data_store: dict = {}
 
+    @property
+    def timezone(self):
+        return self._timezone
+
+    @timezone.setter
+    def timezone(self, timezone: Union[str, ZoneInfo]):
+        self._update_timezone(timezone)
+
+    def _update_timezone(self, timezone: Union[str, ZoneInfo]):
+        """Sets the timezone. This is not done in the setter as you can't call super from a overriden setter """
+        if isinstance(timezone, str):
+            # convert string to ZoneInfo
+            try:
+                timezone = ZoneInfo(timezone)
+            except ZoneInfoNotFoundError as e:
+                log.error(f'Timezone {timezone} could not be found.')
+                raise e
+        else:
+            if not isinstance(timezone, ZoneInfo):
+                raise ValueError(f'The timezone parameter must be either a string or a valid ZoneInfo instance.')
+        self._timezone = timezone
+
     def get_service_keyword(self, keyword: str) -> str:
         """ Returns the data set to the key in the internal data-key dict
 
@@ -226,12 +240,16 @@ def __init__(self, api_version='v1.0', default_resource=None,
 
         self.keyword_data_store['message_type'] = 'microsoft.graph.message'
         self.keyword_data_store['event_message_type'] = 'microsoft.graph.eventMessage'
-        self.keyword_data_store[
-            'file_attachment_type'] = '#microsoft.graph.fileAttachment'
-        self.keyword_data_store[
-            'item_attachment_type'] = '#microsoft.graph.itemAttachment'
+        self.keyword_data_store['file_attachment_type'] = '#microsoft.graph.fileAttachment'
+        self.keyword_data_store['item_attachment_type'] = '#microsoft.graph.itemAttachment'
+        self.keyword_data_store['prefer_timezone_header'] = f'outlook.timezone="{get_windows_tz(self._timezone)}"'
         self.max_top_value = 999  # Max $top parameter value
 
+    @Protocol.timezone.setter
+    def timezone(self, timezone: Union[str, ZoneInfo]):
+        super()._update_timezone(timezone)
+        self.keyword_data_store['prefer_timezone_header'] = f'outlook.timezone="{get_windows_tz(self._timezone)}"'
+
 
 class MSOffice365Protocol(Protocol):
     """ A Microsoft Office 365 Protocol Implementation
@@ -261,18 +279,18 @@ def __init__(self, api_version='v2.0', default_resource=None,
                          protocol_scope_prefix=self._oauth_scope_prefix,
                          **kwargs)
 
-        self.keyword_data_store[
-            'message_type'] = 'Microsoft.OutlookServices.Message'
-        self.keyword_data_store[
-            'event_message_type'] = 'Microsoft.OutlookServices.EventMessage'
-        self.keyword_data_store[
-            'file_attachment_type'] = '#Microsoft.OutlookServices.' \
-                                      'FileAttachment'
-        self.keyword_data_store[
-            'item_attachment_type'] = '#Microsoft.OutlookServices.' \
-                                      'ItemAttachment'
+        self.keyword_data_store['message_type'] = 'Microsoft.OutlookServices.Message'
+        self.keyword_data_store['event_message_type'] = 'Microsoft.OutlookServices.EventMessage'
+        self.keyword_data_store['file_attachment_type'] = '#Microsoft.OutlookServices.FileAttachment'
+        self.keyword_data_store['item_attachment_type'] = '#Microsoft.OutlookServices.ItemAttachment'
+        self.keyword_data_store['prefer_timezone_header'] = f'outlook.timezone="{get_windows_tz(self.timezone)}"'
         self.max_top_value = 999  # Max $top parameter value
 
+    @Protocol.timezone.setter
+    def timezone(self, timezone: Union[str, ZoneInfo]):
+        super()._update_timezone(timezone)
+        self.keyword_data_store['prefer_timezone_header'] = f'outlook.timezone="{get_windows_tz(self._timezone)}"'
+
 
 class MSBusinessCentral365Protocol(Protocol):
     """ A Microsoft Business Central Protocol Implementation
@@ -314,12 +332,16 @@ def __init__(self, api_version='v1.0', default_resource=None, environment=None,
 
         self.keyword_data_store['message_type'] = 'microsoft.graph.message'
         self.keyword_data_store['event_message_type'] = 'microsoft.graph.eventMessage'
-        self.keyword_data_store[
-            'file_attachment_type'] = '#microsoft.graph.fileAttachment'
-        self.keyword_data_store[
-            'item_attachment_type'] = '#microsoft.graph.itemAttachment'
+        self.keyword_data_store['file_attachment_type'] = '#microsoft.graph.fileAttachment'
+        self.keyword_data_store['item_attachment_type'] = '#microsoft.graph.itemAttachment'
+        self.keyword_data_store['prefer_timezone_header'] = f'outlook.timezone="{get_windows_tz(self.timezone)}"'
         self.max_top_value = 999  # Max $top parameter value
 
+    @Protocol.timezone.setter
+    def timezone(self, timezone: Union[str, ZoneInfo]):
+        super()._update_timezone(timezone)
+        self.keyword_data_store['prefer_timezone_header'] = f'outlook.timezone="{get_windows_tz(self._timezone)}"'
+
 
 class Connection:
     """ Handles all communication (requests) between the app and the server """

O365/message.py

@@ -623,7 +623,7 @@ def single_value_extended_properties(self):
         return self.__single_value_extended_properties
 
     def to_api_data(self, restrict_keys=None):
-        """ Returns a dict representation of this message prepared to be send
+        """ Returns a dict representation of this message prepared to be sent
         to the cloud
 
         :param restrict_keys: a set of keys to restrict the returned
@@ -749,7 +749,10 @@ def reply(self, to_all=True):
             url = self.build_url(
                 self._endpoints.get('create_reply').format(id=self.object_id))
 
-        response = self.con.post(url)
+        # set prefer timezone header to protocol timezone
+        headers = {'Prefer': self.protocol.get_service_keyword('prefer_timezone_header')}
+        response = self.con.post(url, headers=headers)
+
         if not response:
             return None
 

O365/utils/__init__.py

@@ -5,5 +5,5 @@
 from .utils import NEXT_LINK_KEYWORD, ME_RESOURCE, USERS_RESOURCE
 from .utils import OneDriveWellKnowFolderNames, Pagination, Query
 from .token import BaseTokenBackend, Token, FileSystemTokenBackend, FirestoreBackend, AWSS3Backend, AWSSecretsBackend, EnvTokenBackend
-from .windows_tz import IANA_TO_WIN, WIN_TO_IANA
-from . import consent
+from .windows_tz import get_iana_tz, get_windows_tz
+from .consent import consent_input_token

O365/utils/attachment.py

@@ -10,6 +10,7 @@
 UPLOAD_SIZE_LIMIT_SIMPLE = 1024 * 1024 * 3  # 3 MB
 DEFAULT_UPLOAD_CHUNK_SIZE = 1024 * 1024 * 3
 
+
 class AttachableMixin:
     def __init__(self, attachment_name_property=None, attachment_type=None):
         """ Defines the functionality for an object to be attachable.