Office365-REST-Python-Client 2.5.1__py3-none-any.whl → 2.5.3__py3-none-any.whl

office365/runtime/odata/request.py

@@ -63,9 +63,7 @@ class ODataRequest(ClientRequest):
                 return_type.set_property("__value", response.content)
         else:
             if isinstance(json_format, JsonLightFormat):
-                if isinstance(query, ServiceOperationQuery) or isinstance(
-                    query, FunctionQuery
-                ):
+                if isinstance(query, (ServiceOperationQuery, FunctionQuery)):
                     json_format.function = query.name
 
             self.map_json(response.json(), return_type, json_format)
@@ -129,7 +127,7 @@ class ODataRequest(ClientRequest):
 
         def _normalize_payload(payload):
             # type: (ClientObject|ClientValue|dict|list) -> dict|list
-            if isinstance(payload, ClientObject) or isinstance(payload, ClientValue):
+            if isinstance(payload, (ClientObject, ClientValue)):
                 return payload.to_json(self._default_json_format)
             elif isinstance(payload, dict):
                 return {

office365/runtime/odata/type.py

@@ -1,5 +1,7 @@
 import datetime
+import inspect
 import uuid
+from typing import Type
 
 
 class ODataType(object):
@@ -60,6 +62,11 @@ class ODataType(object):
         :param str value: Represents date and time with values ranging from 12:00:00 midnight, January 1, 1753 A.D.
             through 11:59:59 P.M, December 9999 A.D.
         """
+        if value is None:
+            return None
+        elif isinstance(value, datetime.datetime):
+            return value
+
         known_formats = [
             "%Y-%m-%dT%H:%M:%SZ",
             "%Y-%m-%dT%H:%M:%S.%fZ",
@@ -90,6 +97,16 @@ class ODataType(object):
         else:
             return ODataType.primitive_types.get(client_type, None)
 
+    @staticmethod
+    def resolve_enum_key(enum_type, value):
+        # type: (Type, int) -> str
+        return next(
+            iter(
+                [item[0] for item in inspect.getmembers(enum_type) if item[1] == value]
+            ),
+            None,
+        )
+
     def add_property(self, prop_schema):
         """
         :type prop_schema:  office365.runtime.odata.property.ODataProperty

office365/runtime/odata/v4/upload_session_request.py

@@ -1,62 +1,57 @@
 import os
+import typing
+from typing import Callable
+
+import requests
+from typing_extensions import Self
 
 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.queries.upload_session import UploadSessionQuery
 
 
 class UploadSessionRequest(ClientRequest):
     def __init__(self, file_object, chunk_size, chunk_uploaded=None):
-        """
-        :type file_object: typing.IO
-        :type chunk_size: int
-        :type chunk_uploaded: (int) -> None
-        """
+        # type: (typing.IO, int, Callable[[int], None]) -> None
         super(UploadSessionRequest, self).__init__()
         self._file_object = file_object
         self._chunk_size = chunk_size
         self._chunk_uploaded = chunk_uploaded
-        self._range_start = 0
-        self._range_end = 0
+        self._range_data = None
 
     def build_request(self, query):
-        """
-        :type query: office365.runtime.queries.upload_session.UploadSessionQuery
-        """
-        range_data = self._read_next()
+        # type: (UploadSessionQuery) -> Self
         request = RequestOptions(query.upload_session_url)
         request.method = HttpMethod.Put
-        request.set_header("Content-Length", str(len(range_data)))
+        request.set_header("Content-Length", str(len(self._range_data)))
         request.set_header(
             "Content-Range",
             "bytes {0}-{1}/{2}".format(
-                self._range_start, self._range_end - 1, self.file_size
+                self.range_start, self.range_end - 1, self.file_size
             ),
         )
         request.set_header("Accept", "*/*")
-        request.data = range_data
+        request.data = self._range_data
         return request
 
     def process_response(self, response, query):
-        """
-        :type response: requests.Response
-        :type query: office365.runtime.queries.upload_session.UploadSessionQuery
-        """
+        # type: (requests.Response, UploadSessionQuery) -> None
         response.raise_for_status()
         if callable(self._chunk_uploaded):
             self._chunk_uploaded(self.range_end)
-        if self.has_pending_read:
-            self.execute_query(query)
 
-    def _read_next(self):
-        self._range_start = self._file_object.tell()
-        content = self._file_object.read(self._chunk_size)
-        self._range_end = self._file_object.tell()
-        return content
+    def execute_query(self, query):
+        # type: (UploadSessionQuery) -> None
+        for self._range_data in self._read_next():
+            super(UploadSessionRequest, self).execute_query(query)
 
-    @property
-    def has_pending_read(self):
-        return self._range_end < self.file_size
+    def _read_next(self):
+        while True:
+            content = self._file_object.read(self._chunk_size)
+            if not content:
+                break
+            yield content
 
     @property
     def file_size(self):
@@ -64,8 +59,10 @@ class UploadSessionRequest(ClientRequest):
 
     @property
     def range_start(self):
-        return self._range_start
+        if self.range_end == 0:
+            return 0
+        return self.range_end - len(self._range_data)
 
     @property
     def range_end(self):
-        return self._range_end
+        return self._file_object.tell()

office365/runtime/paths/appid.py

@@ -7,7 +7,7 @@ class AppIdPath(ResourcePath):
 
     @property
     def segment(self):
-        return "(appId='{0}')".format(self.key)
+        return "(appId='{0}')".format(self._key)
 
     @property
     def delimiter(self):

office365/runtime/{odata/url_builder.py → paths/builder.py}

@@ -1,18 +1,33 @@
 import json
+import re
+from typing import TYPE_CHECKING
 
 from office365.runtime.client_value import ClientValue
 from office365.runtime.compat import is_string_type
+from office365.runtime.paths.resource_path import ResourcePath
 
+if TYPE_CHECKING:
+    from office365.runtime.paths.service_operation import ServiceOperationPath
 
-class ODataUrlBuilder(object):
+
+class ODataPathBuilder(object):
     @staticmethod
-    def build_segment(path):
-        """
-        Constructs url for path segment
+    def parse_url(path_str):
+        # type: (str) -> ResourcePath
+        """Parses path from a string"""
+        segments = [n for n in re.split(r"[('')]|/", path_str) if n]
+        if not segments:
+            raise TypeError("Invalid path")
+        path = None
+        for segment in segments:
+            path = ResourcePath(segment, path)
+        return path
 
-        :type path: office365.runtime.paths.service_operation.ServiceOperationPath
-        """
-        url = path.key or ""
+    @staticmethod
+    def build_segment(path):
+        # type: (ServiceOperationPath) -> str
+        """Constructs url for path segment"""
+        url = path.name or ""
         if isinstance(path.parameters, ClientValue):
             url += "(@v)?@v={0}".format(json.dumps(path.parameters.to_json()))
         elif path.parameters is not None:
@@ -20,7 +35,7 @@ class ODataUrlBuilder(object):
             if isinstance(path.parameters, dict):
                 url += ",".join(
                     [
-                        "%s=%s" % (key, ODataUrlBuilder._encode_method_value(value))
+                        "%s=%s" % (key, ODataPathBuilder._encode_method_value(value))
                         for (key, value) in path.parameters.items()
                         if value is not None
                     ]
@@ -28,7 +43,7 @@ class ODataUrlBuilder(object):
             else:
                 url += ",".join(
                     [
-                        "%s" % (ODataUrlBuilder._encode_method_value(value))
+                        "%s" % (ODataPathBuilder._encode_method_value(value))
                         for (i, value) in enumerate(path.parameters)
                         if value is not None
                     ]

office365/runtime/paths/item.py

@@ -1,6 +1,8 @@
-from office365.runtime.paths.entity import EntityPath
+from office365.runtime.paths.v4.entity import EntityPath
 
 
 class ItemPath(EntityPath):
+    """ """
+
     def __init__(self, parent=None):
         super(ItemPath, self).__init__(None, parent, parent)

office365/runtime/paths/resource_path.py

@@ -1,18 +1,21 @@
+from typing import Iterator
+
+
 class ResourcePath(object):
     """OData resource path"""
 
-    def __init__(self, key, parent=None):
-        """
-        :type key: int or str
-        :type parent: ResourcePath or None
-        """
+    def __init__(self, key=None, parent=None):
+        # type: (int|str, "ResourcePath") -> None
         self._key = key
         self._parent = parent
 
-    def patch(self, key, inplace=False):
+    def patch(self, key):
+        if self._key is None:
+            self._key = key
         return self
 
     def __iter__(self):
+        # type: () -> Iterator["ResourcePath"]
         current = self
         while current:
             yield current
@@ -25,11 +28,8 @@ class ResourcePath(object):
         return self.to_url()
 
     def to_url(self):
-        """
-        Builds url
-
-        :rtype: str
-        """
+        # type: () -> str
+        """Builds url"""
         segments = []
         for path in self:
             segments.insert(0, path.segment)
@@ -43,11 +43,7 @@ class ResourcePath(object):
 
     @property
     def segment(self):
-        return str(self.key)
-
-    @property
-    def key(self):
-        return self._key
+        return str(self._key)
 
     @property
     def delimiter(self):

office365/runtime/paths/service_operation.py

@@ -1,4 +1,5 @@
-from office365.runtime.odata.url_builder import ODataUrlBuilder
+from office365.runtime.client_value import ClientValue
+from office365.runtime.paths.builder import ODataPathBuilder
 from office365.runtime.paths.resource_path import ResourcePath
 
 
@@ -6,17 +7,17 @@ class ServiceOperationPath(ResourcePath):
     """Path to address Service Operations which represents simple functions exposed by an OData service"""
 
     def __init__(self, name, parameters=None, parent=None):
-        """
-        :type parameters: list or dict or office365.runtime.client_value.ClientValue or None
-        :type name: str
-        :type parent: office365.runtime.paths.resource_path.ResourcePath
-        """
+        # type: (str, list|dict|ClientValue, ResourcePath) -> None
         super(ServiceOperationPath, self).__init__(name, parent)
         self._parameters = parameters
 
     @property
     def segment(self):
-        return ODataUrlBuilder.build_segment(self)
+        return ODataPathBuilder.build_segment(self)
+
+    @property
+    def name(self):
+        return self._key
 
     @property
     def parameters(self):

office365/runtime/paths/{key.py → v3/entity.py}

@@ -1,16 +1,16 @@
 from office365.runtime.paths.resource_path import ResourcePath
 
 
-class KeyPath(ResourcePath):
+class EntityPath(ResourcePath):
     """Path for addressing a single entity by key"""
 
     @property
     def segment(self):
-        if self.key is None:
+        if self._key is None:
             return "(<key>)"
-        elif isinstance(self.key, int):
-            return "({0})".format(self.key)
-        return "('{0}')".format(self.key)
+        elif isinstance(self._key, int):
+            return "({0})".format(self._key)
+        return "('{0}')".format(self._key)
 
     @property
     def delimiter(self):

office365/runtime/paths/{entity.py → v4/entity.py}

@@ -12,23 +12,25 @@ class EntityPath(ResourcePath):
 
     @property
     def collection(self):
+        from office365.onedrive.internal.paths.children import ChildrenPath
+
+        if self._collection is None:
+            if isinstance(self.parent, ChildrenPath):
+                self._collection = self.parent.collection
+            else:
+                self._collection = self.parent
         return self._collection
 
     @property
     def segment(self):
-        return str(self.key or "<key>")
+        return str(self._key or "<key>")
 
-    def patch(self, key, inplace=False):
+    def patch(self, key):
         """
         Patches path
-
         :type key: str or None
-        :type inplace: bool
         """
-        if inplace:
-            self._key = key
-            self._parent = self.collection
-            self.__class__ = ResourcePath
-            return self
-        else:
-            return ResourcePath(key, self.collection)
+        self._key = key
+        self._parent = self.collection
+        self.__class__ = EntityPath
+        return self

office365/runtime/queries/function.py

@@ -3,7 +3,7 @@ from office365.runtime.queries.client_query import ClientQuery
 
 
 class FunctionQuery(ClientQuery):
-    """ "Service operation query"""
+    """Function query"""
 
     def __init__(
         self, binding_type, method_name=None, method_params=None, return_type=None

office365/runtime/types/event_handler.py

@@ -47,9 +47,7 @@ class EventHandler:
         from office365.runtime.client_runtime_context import ClientRuntimeContext
 
         if isinstance(listener, types.MethodType):
-            return isinstance(listener.__self__, ClientRequest) or isinstance(
-                listener.__self__, ClientRuntimeContext
-            )
+            return isinstance(listener.__self__, (ClientRequest, ClientRuntimeContext))
         if isinstance(listener, types.FunctionType):
             return listener.__module__ == ClientRuntimeContext.__module__
         else:

office365/search/entity.py

@@ -31,28 +31,35 @@ class SearchEntity(Entity):
         payload = {"requests": ClientValueCollection(SearchRequest, [search_request])}
         return_type = ClientResult(self.context, ClientValueCollection(SearchResponse))
         qry = ServiceOperationQuery(self, "query", None, payload, None, return_type)
-        self.context.add_query(qry)
+
+        def _patch_hit(search_hit):
+            pass
+            # resource = Entity(self.context)
+            # self.context.pending_request().map_json(search_hit.resource, resource)
+            # search_hit.set_property("resource", resource)
+
+        def _process_response():
+            for item in return_type.value:
+                for hcs in item.hitsContainers:
+                    [_patch_hit(hit) for hit in hcs.hits]
+
+        self.context.add_query(qry).after_query_execute(_process_response)
         return return_type
 
     def query_messages(self, query_string):
-        """Searches Outlook messages.
-        Alias to query method
-
+        """Searches Outlook messages. Alias to query method
         :param str query_string: Contains the query terms.
         """
         return self.query(query_string, entity_types=[EntityType.message])
 
     def query_events(self, query_string):
         """Searches Outlook calendar events. Alias to query method
-
         :param str query_string: Contains the query terms.
         """
         return self.query(query_string, entity_types=[EntityType.event])
 
     def query_drive_items(self, query_string):
-        """Searches OneDrive items.
-        Alias to query method
-
+        """Searches OneDrive items. Alias to query method
         :param str query_string: Contains the query terms.
         """
         return self.query(query_string, entity_types=[EntityType.driveItem])

office365/search/external/external.py

@@ -9,6 +9,7 @@ class External(Entity):
 
     @property
     def connections(self):
+        # type: () -> EntityCollection[ExternalConnection]
         """Get a list of the externalConnection objects and their properties."""
         return self.properties.get(
             "connections",

office365/search/sort_property.py

@@ -12,3 +12,6 @@ class SortProperty(ClientValue):
         """
         self.isDescending = is_descending
         self.name = name
+
+    def __repr__(self):
+        return "{0} {1}".format(self.name, "DESC" if self.isDescending else "ASC")

office365/sharepoint/attachments/attachment.py

@@ -1,5 +1,6 @@
-from typing import Optional
+from typing import AnyStr, Optional
 
+from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.internal.queries.upload_file import create_upload_file_query
@@ -17,6 +18,7 @@ class Attachment(Entity):
         """
 
         def _save_content(return_type):
+            # type: (ClientResult[AnyStr]) -> None
             file_object.write(return_type.value)
 
         def _download_file_by_path():

office365/sharepoint/attachments/collection.py

@@ -1,3 +1,5 @@
+from typing import AnyStr
+
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.attachments.attachment import Attachment
@@ -45,6 +47,7 @@ class AttachmentCollection(EntityCollection[Attachment]):
         return return_type
 
     def add_using_path(self, decoded_url, content_stream):
+        # type: (str, AnyStr) -> Attachment
         """
         Adds the attachment represented by the file name and stream in the specified parameter to the list item.
 

office365/sharepoint/changes/change.py

@@ -1,10 +1,19 @@
+import datetime
+from typing import Optional
+
+from office365.runtime.odata.type import ODataType
 from office365.sharepoint.changes.token import ChangeToken
+from office365.sharepoint.changes.type import ChangeType
 from office365.sharepoint.entity import Entity
 
 
 class Change(Entity):
     """Base class for a change. installation."""
 
+    @property
+    def change_type_name(self):
+        return ODataType.resolve_enum_key(ChangeType, self.change_type)
+
     @property
     def change_token(self):
         """
@@ -22,6 +31,7 @@ class Change(Entity):
 
     @property
     def site_id(self):
+        # type: () -> Optional[str]
         """
         Returns the Id of the site of the changed item
         """
@@ -29,10 +39,11 @@ class Change(Entity):
 
     @property
     def time(self):
+        # type: () -> datetime.datetime
         """
         Gets a value that specifies the time that the object was modified.
         """
-        return self.properties.get("Time", None)
+        return self.properties.get("Time", datetime.datetime.min)
 
     def get_property(self, name, default_value=None):
         if default_value is None:

office365/sharepoint/changes/collection.py

@@ -2,7 +2,7 @@ from office365.sharepoint.changes.change import Change
 from office365.sharepoint.entity_collection import EntityCollection
 
 
-class ChangeCollection(EntityCollection):
+class ChangeCollection(EntityCollection[Change]):
     """Represents a collection of Change objects"""
 
     def __init__(self, context, resource_path=None):

office365/sharepoint/changes/list.py

@@ -9,6 +9,9 @@ class ChangeList(Change):
     The RelativeTime and RootFolderUrl properties are not included in the default scalar property set for this type.
     """
 
+    def __repr__(self):
+        return "List: {0}".format(self.list_id)
+
     @property
     def base_template(self):
         """An SP.ListTemplateType object that returns the list template type of the list."""

office365/sharepoint/changes/token.py

@@ -23,3 +23,7 @@ class ChangeToken(ClientValue):
 
     def __repr__(self):
         return self.StringValue or ""
+
+    @property
+    def entity_type_name(self):
+        return "SP.ChangeToken"