#748: download_session fix, refactorings and type hints for event han…

…dler

examples/sharepoint/files/download_large.py

@@ -10,7 +10,7 @@ def print_download_progress(offset):
 
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-file_url = "Shared Documents/big_buck_bunny.mp4"
+file_url = "Shared Documents/Archive/big_buck_bunny.mp4"
 source_file = ctx.web.get_file_by_server_relative_path(file_url)
 local_file_name = os.path.join(tempfile.mkdtemp(), os.path.basename(file_url))
 with open(local_file_name, "wb") as local_file:

office365/runtime/odata/v4/upload_session_request.py

@@ -3,7 +3,6 @@
 from office365.runtime.client_request import ClientRequest
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
-from office365.runtime.types.event_handler import EventHandler
 
 
 class UploadSessionRequest(ClientRequest):
@@ -15,7 +14,6 @@ def __init__(self, file_object, chunk_size, chunk_uploaded=None):
         """
         super(UploadSessionRequest, self).__init__()
         self._file_object = file_object
-        self.chunk_uploaded = EventHandler(True)
         self._chunk_size = chunk_size
         self._chunk_uploaded = chunk_uploaded
         self._range_start = 0

office365/runtime/types/event_handler.py

@@ -1,19 +1,29 @@
+import types
+from typing import Callable
+
+from typing_extensions import Self
+
+
 class EventHandler:
     def __init__(self, once=False):
+        # type: (bool) -> None
         self._listeners = []
         self._once = once
 
-    def __contains__(self, e):
-        return e in self._listeners
+    def __contains__(self, listener):
+        # type: (Callable[..., None]) -> bool
+        return listener in self._listeners
 
     def __iter__(self):
         return iter(self._listeners)
 
     def __iadd__(self, listener):
+        # type: (Callable[..., None]) -> Self
         self._listeners.append(listener)
         return self
 
     def __isub__(self, listener):
+        # type: (Callable[..., None]) -> Self
         self._listeners.remove(listener)
         return self
 
@@ -25,3 +35,18 @@ def notify(self, *args, **kwargs):
             if self._once:
                 self._listeners.remove(listener)
             listener(*args, **kwargs)
+
+    @staticmethod
+    def is_builtin(listener):
+        # type: (Callable[..., None]) -> bool
+        from office365.runtime.client_request import ClientRequest
+        from office365.runtime.client_runtime_context import ClientRuntimeContext
+
+        if isinstance(listener, types.MethodType):
+            return isinstance(listener.__self__, ClientRequest) or isinstance(
+                listener.__self__, ClientRuntimeContext
+            )
+        if isinstance(listener, types.FunctionType):
+            return listener.__module__ == ClientRuntimeContext.__module__
+        else:
+            raise ValueError("Invalid listener type")

office365/sharepoint/client_context.py

@@ -13,6 +13,7 @@
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.update_entity import UpdateEntityQuery
+from office365.runtime.types.event_handler import EventHandler
 from office365.sharepoint.portal.sites.status import SiteStatus
 from office365.sharepoint.publishing.pages.service import SitePageService
 from office365.sharepoint.request_user_context import RequestUserContext
@@ -201,9 +202,10 @@ def _get_context_web_information(self):
         Returns an ContextWebInformation object that specifies metadata about the site
         """
         client = ODataRequest(JsonLightFormat())
+        client.beforeExecute += self._authenticate_request
         for e in self.pending_request().beforeExecute:
-            client.beforeExecute += e
-        client.beforeExecute -= self._build_modification_query
+            if not EventHandler.is_builtin(e):
+                client.beforeExecute += e
         request = RequestOptions("{0}/contextInfo".format(self.service_root_url()))
         request.method = HttpMethod.Post
         response = client.execute_request_direct(request)

office365/sharepoint/files/file.py

@@ -1,7 +1,6 @@
 import datetime
 
 from office365.runtime.client_result import ClientResult
-from office365.runtime.compat import is_string_type
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.paths.resource_path import ResourcePath
@@ -22,13 +21,8 @@
 from office365.sharepoint.permissions.irm.file_settings import (
     InformationRightsManagementFileSettings,
 )
-from office365.sharepoint.permissions.irm.settings import (
-    InformationRightsManagementSettings,
-)
 from office365.sharepoint.principal.users.user import User
 from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
-from office365.sharepoint.utilities.move_copy_options import MoveCopyOptions
-from office365.sharepoint.utilities.move_copy_util import MoveCopyUtil
 from office365.sharepoint.utilities.upload_status import UploadStatus
 from office365.sharepoint.utilities.wopi_frame_action import SPWOPIFrameAction
 from office365.sharepoint.webparts.limited_manager import LimitedWebPartManager