Office365-REST-Python-Client 2.5.5__py3-none-any.whl → 2.5.6__py3-none-any.whl

office365/runtime/odata/v3/batch_request.py

@@ -1,7 +1,7 @@
 import json
 import re
 from email.message import Message
-from typing import Iterator, Tuple
+from typing import AnyStr, Iterator, List, Tuple
 
 import requests
 from requests import Response
@@ -40,12 +40,8 @@ class ODataBatchV3Request(ODataRequest):
             super(ODataBatchV3Request, self).process_response(sub_resp, sub_qry)
 
     def _extract_response(self, response, query):
-        # type: (requests.Response, BatchQuery) -> Iterator[Tuple[ClientQuery, Response]]
-        """Parses a multipart/mixed response body from the position defined by the context.
-
-        :type response: requests.Response
-        :type query: office365.runtime.queries.batch.BatchQuery
-        """
+        # type: (Response, BatchQuery) -> Iterator[Tuple[ClientQuery, Response]]
+        """Parses a multipart/mixed response body from the position defined by the context."""
         content_type = response.headers["Content-Type"].encode("ascii")
         http_body = b"Content-Type: " + content_type + b"\r\n\r\n" + response.content
 
@@ -59,11 +55,8 @@ class ODataBatchV3Request(ODataRequest):
                 yield qry, self._deserialize_response(raw_response)
 
     def _prepare_payload(self, query):
-        """
-        Serializes a batch request body.
-
-        :type query: office365.runtime.queries.batch.BatchQuery
-        """
+        # type: (BatchQuery) -> AnyStr
+        """Serializes a batch request body."""
         main_message = Message()
         main_message.add_header("Content-Type", "multipart/mixed")
         main_message.set_boundary(query.current_boundary)
@@ -89,9 +82,8 @@ class ODataBatchV3Request(ODataRequest):
 
     @staticmethod
     def _normalize_headers(headers_raw):
-        """
-        :type headers_raw: list[str]
-        """
+        # type: (List[str]) -> CaseInsensitiveDict
+        """ """
         headers = {}
         for header_line in headers_raw:
             k, v = header_line.split(":", 1)

office365/runtime/odata/v4/batch_request.py

@@ -1,22 +1,22 @@
 import json
+from typing import Any, Dict, Iterator, List, Optional, Tuple
 
-import requests
+from requests import Response
 from requests.structures import CaseInsensitiveDict
 
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.odata.request import ODataRequest
+from office365.runtime.queries.batch import BatchQuery
+from office365.runtime.queries.client_query import ClientQuery
 
 
 class ODataV4BatchRequest(ODataRequest):
     """JSON batch request"""
 
     def build_request(self, query):
-        """
-        Builds a batch request
-
-        :type query: office365.runtime.queries.batch.BatchQuery
-        """
+        # type: (BatchQuery) -> RequestOptions
+        """Builds a batch request"""
         request = RequestOptions(query.url)
         request.method = HttpMethod.Post
         request.ensure_header("Content-Type", "application/json")
@@ -25,24 +25,19 @@ class ODataV4BatchRequest(ODataRequest):
         return request
 
     def process_response(self, response, query):
-        """Parses an HTTP response.
-
-        :type response: requests.Response
-        :type query: office365.runtime.queries.batch.BatchQuery
-        """
+        # type: (Response, BatchQuery) -> None
+        """Parses an HTTP response."""
         for sub_qry, sub_resp in self._extract_response(response, query):
             sub_resp.raise_for_status()
             super(ODataV4BatchRequest, self).process_response(sub_resp, sub_qry)
 
     @staticmethod
     def _extract_response(response, query):
-        """
-        :type response: requests.Response
-        :type query: office365.runtime.queries.batch.BatchQuery
-        """
+        # type: (Response, BatchQuery) -> Iterator[Tuple[ClientQuery, Response]]
+        """ """
         json_responses = response.json()
         for json_resp in json_responses["responses"]:
-            resp = requests.Response()
+            resp = Response()
             resp.status_code = int(json_resp["status"])
             resp.headers = CaseInsensitiveDict(json_resp["headers"])
             resp._content = json.dumps(json_resp["body"]).encode("utf-8")
@@ -65,11 +60,8 @@ class ODataV4BatchRequest(ODataRequest):
 
     @staticmethod
     def _normalize_request(query, query_id, depends_on=None):
-        """
-        :type query: office365.runtime.queries.client_query.ClientQuery
-        :type query_id: str
-        :type depends_on:  list[str] or None
-        """
+        # type: (ClientQuery, str, Optional[List[str]]) -> Dict[str, Any]
+        """ """
         request = query.build_request()
         allowed_props = ["id", "method", "headers", "url", "body"]
         request_json = dict(

office365/runtime/types/event_handler.py

@@ -35,7 +35,7 @@ class EventHandler:
 
     def notify(self, *args, **kwargs):
         # type: (Any, Any) -> None
-        for listener in self._listeners:
+        for listener in self._listeners[:]:
             if self._once:
                 self._listeners.remove(listener)
             listener(*args, **kwargs)

office365/search/entity.py

@@ -38,8 +38,9 @@ class SearchEntity(Entity):
             # 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:
+        def _process_response(result):
+            # type: (ClientResult[ClientValueCollection[SearchResponse]]) -> None
+            for item in result.value:
                 for hcs in item.hitsContainers:
                     [_patch_hit(hit) for hit in hcs.hits]
 

office365/sharepoint/activities/facets/delete.py

@@ -9,4 +9,4 @@ class DeleteFacet(ClientValue):
 
     @property
     def entity_type_name(self):
-        return "Microsoft.SharePoint.Activities.CreateFacet"
+        return "Microsoft.SharePoint.Activities.DeleteFacet"

office365/sharepoint/activities/tracked_item_service.py

@@ -3,15 +3,14 @@ from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.activities.tracked_item_updates_request import (
     TrackedItemUpdatesRequest,
 )
+from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.entity import Entity
 
 
 class TrackedItemService(Entity):
     @staticmethod
     def get_tracked_item_updates_for_user(context):
-        """
-        :type context: office365.sharepoint.client_context.ClientContext
-        """
+        # type: (ClientContext) -> ClientResult[str]
         return_type = ClientResult(context)
         payload = {"request": TrackedItemUpdatesRequest()}
         qry = ServiceOperationQuery(

office365/sharepoint/administration/web_application.py

@@ -1,5 +1,8 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.sites.site import Site
@@ -8,10 +11,8 @@ from office365.sharepoint.sites.site import Site
 class WebApplication(Entity):
     @staticmethod
     def lookup(context, request_uri):
-        """
-        :type context
-        :type request_uri str
-        """
+        # type:  (ClientContext, str) -> WebApplication
+        """ """
         return_type = WebApplication(context)
         payload = {"requestUri": request_uri}
         qry = ServiceOperationQuery(
@@ -22,13 +23,13 @@ class WebApplication(Entity):
 
     @property
     def outbound_mail_sender_address(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """ """
         return self.properties.get("OutboundMailSenderAddress", None)
 
     @property
     def sites(self):
+        # type: () -> EntityCollection[Site]
         return self.properties.get(
             "Sites",
             EntityCollection(

office365/sharepoint/audit/audit.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -8,11 +10,10 @@ class Audit(Entity):
 
     @property
     def allow_designer(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether a designer can be used on this site collection.
         See Microsoft.SharePoint.Client.Web.AllowDesignerForCurrentUser, which is the scalar property used
         to determine the behavior for the current user. The default, if not disabled on the Web application, is "true".
-
-        :rtype: bool or None
         """
         return self.properties.get("AllowDesigner", None)

office365/sharepoint/changes/alert.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.changes.change import Change
 
 
@@ -6,7 +8,6 @@ class ChangeAlert(Change):
 
     @property
     def alert_id(self):
-        """Identifies the changed alert.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Identifies the changed alert."""
         return self.properties.get("AlertId", None)

office365/sharepoint/changes/collection.py

@@ -9,15 +9,12 @@ class ChangeCollection(EntityCollection[Change]):
         super(ChangeCollection, self).__init__(context, Change, resource_path)
 
     def set_property(self, key, value, persist_changes=False):
-        self.resolve_change_type(value)
+        self._resolve_change_type(value)
         super(ChangeCollection, self).set_property(key, value)
 
-    def resolve_change_type(self, properties):
-        """
-        Resolves a change type
-
-        :type properties: dict
-        """
+    def _resolve_change_type(self, properties):
+        # type: (dict) -> None
+        """Resolves a change type"""
         from office365.sharepoint.changes.alert import ChangeAlert
         from office365.sharepoint.changes.content_type import ChangeContentType
         from office365.sharepoint.changes.field import ChangeField
@@ -27,10 +24,10 @@ class ChangeCollection(EntityCollection[Change]):
         from office365.sharepoint.changes.user import ChangeUser
         from office365.sharepoint.changes.web import ChangeWeb
 
-        if "ListId" in properties and "WebId" in properties:
-            self._item_type = ChangeList
-        elif "ItemId" in properties and "ListId" in properties:
+        if "ItemId" in properties and "ListId" in properties:
             self._item_type = ChangeItem
+        elif "ListId" in properties and "WebId" in properties:
+            self._item_type = ChangeList
         elif "WebId" in properties:
             self._item_type = ChangeWeb
         elif "UserId" in properties:

office365/sharepoint/changes/content_type.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.changes.change import Change
 
 
@@ -6,8 +8,6 @@ class ChangeContentType(Change):
 
     @property
     def content_type_id(self):
-        """Identifies the content type that has changed.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Identifies the content type that has changed."""
         return self.properties.get("ContentTypeId", None)

office365/sharepoint/changes/field.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.changes.change import Change
 
 
@@ -6,9 +8,6 @@ class ChangeField(Change):
 
     @property
     def field_id(self):
-        """ "
-        Identifies the changed field
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Identifies the changed field"""
         return self.properties.get("FieldId", None)

office365/sharepoint/changes/item.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.sharepoint.changes.change import Change
 from office365.sharepoint.contenttypes.content_type_id import ContentTypeId
@@ -9,19 +11,38 @@ class ChangeItem(Change):
 
     @property
     def activity_type(self):
-        """
-        Returns activity type defined in ChangeActivityType
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Returns activity type defined in ChangeActivityType"""
         return self.properties.get("ActivityType", None)
 
     @property
     def content_type_id(self):
-        """
-        Specifies an identifier for the content type
-        """
+        """Specifies an identifier for the content type"""
         return self.properties.get("ContentTypeId", ContentTypeId())
 
+    @property
+    def file_type(self):
+        # type: () -> Optional[str]
+        """Returns the list item’s file type."""
+        return self.properties.get("FileType", None)
+
+    @property
+    def item_id(self):
+        # type: () -> Optional[int]
+        """Identifies the changed item."""
+        return self.properties.get("ItemId", None)
+
+    @property
+    def is_recycle_bin_operation(self):
+        # type: () -> Optional[bool]
+        return self.properties.get("IsRecycleBinOperation", None)
+
+    @property
+    def server_relative_url(self):
+        # type: () -> Optional[str]
+        """Specifies the server-relative URL of the item."""
+        return self.properties.get("ServerRelativeUrl", None)
+
     @property
     def shared_by_user(self):
         """Return the sharedBy User Information in sharing action for change log."""
@@ -34,6 +55,12 @@ class ChangeItem(Change):
             "SharedWithUsers", ClientValueCollection(SharedWithUser)
         )
 
+    @property
+    def unique_id(self):
+        # type: () -> Optional[str]
+        """The Document identifier of the item."""
+        return self.properties.get("UniqueId", None)
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {

office365/sharepoint/changes/list.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.changes.change import Change
 
@@ -19,10 +21,8 @@ class ChangeList(Change):
 
     @property
     def list_id(self):
-        """
-        Identifies the changed list
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Identifies the changed list"""
         return self.properties.get("ListId", None)
 
     @property

office365/sharepoint/changes/user.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.changes.change import Change
 
 
@@ -6,21 +8,18 @@ class ChangeUser(Change):
 
     @property
     def activate(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether a user has changed from an inactive state to an active state.
 
         When a user is added to a site and only has browse permissions, the user is in an inactive state.
         However, once the user can author list items, add documents, be assigned tasks, or make any contribution
         to the site, the user is in an active state.
-
-        :rtype: bool or None
         """
         return self.properties.get("Activate", None)
 
     @property
     def user_id(self):
-        """Uniquely identifies the changed user.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Uniquely identifies the changed user."""
         return self.properties.get("UserId", None)

office365/sharepoint/clientsidecomponent/component_context_info.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -6,9 +8,8 @@ class ComponentContextInfo(Entity):
 
     @property
     def serialized_data(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """"""
         return self.properties.get("SerializedData", None)
 
     @property

office365/sharepoint/contentcenter/machinelearning/enabled.py

@@ -1,12 +1,13 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
 class SPMachineLearningEnabled(Entity):
     @property
     def is_syntex_payg_enabled(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """ """
         return self.properties.get("IsSyntexPAYGEnabled", None)
 
     @property

office365/sharepoint/contentcenter/machinelearning/hub.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -73,16 +75,14 @@ class SPMachineLearningHub(Entity):
 
     @property
     def is_default_content_center(self):
-        """
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """ """
         return self.properties.get("IsDefaultContentCenter", None)
 
     @property
     def machine_learning_capture_enabled(self):
-        """
-        :rtype: bool
-        """
+        # type: () -> Optional[bool]
+        """ """
         return self.properties.get("MachineLearningCaptureEnabled", None)
 
     @property

office365/sharepoint/contentcenter/machinelearning/models/collection.py

@@ -5,7 +5,7 @@ from office365.sharepoint.contentcenter.machinelearning.models.model import (
 from office365.sharepoint.entity_collection import EntityCollection
 
 
-class SPMachineLearningModelCollection(EntityCollection):
+class SPMachineLearningModelCollection(EntityCollection[SPMachineLearningModel]):
     def __init__(self, context, resource_path=None):
         super(SPMachineLearningModelCollection, self).__init__(
             context, SPMachineLearningModel, resource_path

office365/sharepoint/contenttypes/fieldlinks/collection.py

@@ -21,10 +21,8 @@ class FieldLinkCollection(EntityCollection):
         :param str or office365.sharepoint.fields.field.Field field: Specifies the internal name of the field or type
         """
 
-        def _create_and_add_query(field_internal_name):
-            """
-            :type field_internal_name: str
-            """
+        def _add(field_internal_name):
+            # type: (str) -> None
             return_type.set_property("FieldInternalName", field_internal_name)
             qry = CreateEntityQuery(self, return_type, return_type)
             self.context.add_query(qry)
@@ -34,11 +32,11 @@ class FieldLinkCollection(EntityCollection):
         if isinstance(field, Field):
 
             def _field_loaded():
-                _create_and_add_query(field.internal_name)
+                _add(field.internal_name)
 
             field.ensure_property("InternalName", _field_loaded)
         else:
-            _create_and_add_query(field)
+            _add(field)
         return return_type
 
     def get_by_id(self, _id):

office365/sharepoint/contenttypes/fieldlinks/field_link.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -6,46 +8,36 @@ class FieldLink(Entity):
 
     @property
     def id(self):
-        """
-        Gets a value that specifies the GUID of the FieldLink.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies the GUID of the FieldLink."""
         return self.properties.get("Id", None)
 
     @property
     def field_internal_name(self):
-        """Gets a value that specifies field internal name
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies field internal name"""
         return self.properties.get("FieldInternalName", None)
 
     @property
     def read_only(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """ """
         return self.properties.get("ReadOnly", None)
 
     @property
     def hidden(self):
-        """
-        Gets a value that specifies whether the field is displayed in forms that can be edited.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a value that specifies whether the field is displayed in forms that can be edited."""
         return self.properties.get("Hidden", None)
 
     @property
     def required(self):
-        """
-        Gets a value that specifies whether the field (2) requires a value.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a value that specifies whether the field (2) requires a value."""
         return self.properties.get("Required", None)
 
     @property
     def show_in_display_form(self):
-        """
-        A Boolean value that indicates whether this field is shown in the display form.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """A Boolean value that indicates whether this field is shown in the display form."""
         return self.properties.get("ShowInDisplayForm", None)

office365/sharepoint/entity.py

@@ -1,5 +1,9 @@
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Callable
 
+from typing_extensions import Self
+
+from office365.runtime.auth.client_credential import ClientCredential
+from office365.runtime.auth.user_credential import UserCredential
 from office365.runtime.client_object import ClientObject
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.update_entity import UpdateEntityQuery
@@ -11,11 +15,14 @@ if TYPE_CHECKING:
 class Entity(ClientObject):
     """SharePoint specific entity"""
 
+    def execute_batch(self, items_per_batch=100, success_callback=None):
+        # type: (int, Callable[[int], None]) -> Self
+        """Construct and submit to a server a batch request"""
+        return self.context.execute_batch(items_per_batch, success_callback)
+
     def with_credentials(self, credentials):
-        """
-        :type self: T
-        :type credentials:  UserCredential or ClientCredential
-        """
+        # type: (UserCredential|ClientCredential) -> Self
+        """ """
         self.context.with_credentials(credentials)
         return self
 

office365/sharepoint/entity_collection.py

@@ -12,9 +12,7 @@ T = TypeVar("T")
 
 
 class EntityCollection(ClientObjectCollection[T]):
-    """
-    SharePoint's entity set
-    """
+    """SharePoint's entity set"""
 
     def __init__(self, context, item_type, resource_path=None, parent=None):
         # type: (ClientContext, Type[T], Optional[ResourcePath], Optional[Entity]) -> None