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

office365/sharepoint/client_context.py

@@ -81,7 +81,7 @@ class ClientContext(ClientRuntimeContext):
         thumbprint,
         cert_path=None,
         private_key=None,
-        scopes=None
+        scopes=None,
     ):
         # type: (str, str, str, Optional[str], Optional[str], Optional[List[str]]) -> Self
         """
@@ -136,7 +136,12 @@ class ClientContext(ClientRuntimeContext):
         return self
 
     def with_user_credentials(
-        self, username, password, allow_ntlm=False, browser_mode=False, environment='commercial'
+        self,
+        username,
+        password,
+        allow_ntlm=False,
+        browser_mode=False,
+        environment="commercial",
     ):
         # type: (str, str, bool, bool, Optional[str]) -> Self
         """
@@ -152,11 +157,13 @@ class ClientContext(ClientRuntimeContext):
             UserCredential(username, password),
             allow_ntlm=allow_ntlm,
             browser_mode=browser_mode,
-            environment=environment
+            environment=environment,
         )
         return self
 
-    def with_client_credentials(self, client_id, client_secret, environment='commercial'):
+    def with_client_credentials(
+        self, client_id, client_secret, environment="commercial"
+    ):
         # type: (str, str, Optional[str]) -> Self
         """
         Initializes a client to acquire a token via client credentials (SharePoint App-Only)
@@ -170,12 +177,11 @@ class ClientContext(ClientRuntimeContext):
             defaults to 'commercial'.
         """
         self.authentication_context.with_credentials(
-            ClientCredential(client_id, client_secret),
-            environment=environment
+            ClientCredential(client_id, client_secret), environment=environment
         )
         return self
 
-    def with_credentials(self, credentials, environment='commercial'):
+    def with_credentials(self, credentials, environment="commercial"):
         # type: (UserCredential|ClientCredential, Optional[str]) -> Self
         """
         Initializes a client to acquire a token via user or client credentials
@@ -183,7 +189,9 @@ class ClientContext(ClientRuntimeContext):
         :param str environment: The Office 365 Cloud Environment endpoint used for authentication
             defaults to 'commercial'.
         """
-        self.authentication_context.with_credentials(credentials, environment=environment)
+        self.authentication_context.with_credentials(
+            credentials, environment=environment
+        )
         return self
 
     def execute_batch(self, items_per_batch=100, success_callback=None):
@@ -204,9 +212,7 @@ class ClientContext(ClientRuntimeContext):
         return self
 
     def pending_request(self):
-        """
-        Provides access to underlying request instance
-        """
+        """Provides access to underlying request instance"""
         if self._pending_request is None:
             self._pending_request = ODataRequest(JsonLightFormat())
             self._pending_request.beforeExecute += self._authenticate_request
@@ -220,9 +226,7 @@ class ClientContext(ClientRuntimeContext):
         request.set_header("X-RequestDigest", self._ctx_web_info.FormDigestValue)
 
     def _get_context_web_information(self):
-        """
-        Returns an ContextWebInformation object that specifies metadata about the site
-        """
+        """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:
@@ -278,9 +282,7 @@ class ClientContext(ClientRuntimeContext):
 
     def _build_modification_query(self, request):
         # type: (RequestOptions) -> None
-        """
-        Constructs SharePoint specific modification OData request
-        """
+        """Constructs SharePoint specific modification OData request"""
         if request.method == HttpMethod.Post:
             self._ensure_form_digest(request)
         # set custom SharePoint control headers
@@ -366,9 +368,7 @@ class ClientContext(ClientRuntimeContext):
 
     @property
     def context_info(self):
-        """
-        Returns an ContextWebInformation object that specifies metadata about the site
-        """
+        """Returns an ContextWebInformation object that specifies metadata about the site"""
         if self._ctx_web_info is None:
             self._ctx_web_info = ContextWebInformation()
         return self._ctx_web_info

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

office365/sharepoint/eventreceivers/definition.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -7,24 +9,18 @@ class EventReceiverDefinition(Entity):
 
     @property
     def receiver_assembly(self):
-        """Specifies the strong name of the assembly that is used for the event receiver.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the strong name of the assembly that is used for the event receiver."""
         return self.properties.get("ReceiverAssembly", None)
 
     @property
     def receiver_class(self):
-        """Specifies the strong name of the assembly that is used for the event receiver.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the strong name of the assembly that is used for the event receiver."""
         return self.properties.get("ReceiverClass", None)
 
     @property
     def receiver_url(self):
-        """Gets the URL of the receiver for the event.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the URL of the receiver for the event."""
         return self.properties.get("ReceiverUrl", None)

office365/sharepoint/features/collection.py

@@ -4,7 +4,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.features.feature import Feature
 
 
-class FeatureCollection(EntityCollection):
+class FeatureCollection(EntityCollection[Feature]):
     """Represents a collection of Feature resources."""
 
     def __init__(self, context, resource_path=None, parent=None):
@@ -31,15 +31,12 @@ class FeatureCollection(EntityCollection):
             return ServiceOperationQuery(self, "Add", None, payload, None, return_type)
 
         def _create_if_not_activated(f):
-            """
-            :type f: Feature
-            """
+            # type: (Feature) -> None
             if not f.properties:
                 self.context.add_query(_create_query())
 
         if verify_if_activated:
-            feature = self.get_by_id(feature_id)
-            self.context.load(feature, after_loaded=_create_if_not_activated)
+            self.get_by_id(feature_id).get().after_execute(_create_if_not_activated)
         else:
             self.context.add_query(_create_query())
 

office365/sharepoint/features/definitions/definition.py

@@ -1,12 +1,15 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
 class FeatureDefinition(Entity):
     """Contains the base definition of a feature, including its name, ID, scope, and version."""
 
+    def __str__(self):
+        return self.display_name or self.entity_type_name
+
     @property
     def display_name(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
         return self.properties.get("DisplayName", None)

office365/sharepoint/fields/calculated.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.fields.field import Field
 
 
@@ -11,26 +13,18 @@ class FieldCalculated(Field):
 
     @property
     def currency_locale_id(self):
-        """
-        Gets the locale ID that is used for currency on the Web site.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets the locale ID that is used for currency on the Web site."""
         return self.properties.get("CurrencyLocaleId", None)
 
     @property
     def formula(self):
-        """
-        Specifies the formula for the field
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the formula for the field"""
         return self.properties.get("Formula", None)
 
     @formula.setter
     def formula(self, val):
-        """Sets a value that specifies the Formula.
-
-        :type val: str
-        """
+        # type: (str) -> None
+        """Sets a value that specifies the Formula."""
         self.set_property("Formula", val)

office365/sharepoint/fields/collection.py

@@ -1,3 +1,5 @@
+from typing import TYPE_CHECKING, Optional
+
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -7,12 +9,20 @@ from office365.sharepoint.fields.creation_information import FieldCreationInform
 from office365.sharepoint.fields.date_time import FieldDateTime
 from office365.sharepoint.fields.field import Field
 from office365.sharepoint.fields.geolocation import FieldGeolocation
+from office365.sharepoint.fields.number import FieldNumber
+from office365.sharepoint.fields.text import FieldText
 from office365.sharepoint.fields.type import FieldType
+from office365.sharepoint.fields.url import FieldUrl
 from office365.sharepoint.fields.xmlSchemaFieldCreationInformation import (
     XmlSchemaFieldCreationInformation,
 )
 from office365.sharepoint.taxonomy.field import TaxonomyField
 from office365.sharepoint.taxonomy.sets.set import TermSet
+from office365.sharepoint.taxonomy.stores.store import TermStore
+
+if TYPE_CHECKING:
+    from office365.sharepoint.lists.list import List
+    from office365.sharepoint.webs.web import Web
 
 
 class FieldCollection(EntityCollection[Field]):
@@ -39,6 +49,7 @@ class FieldCollection(EntityCollection[Field]):
         return return_type
 
     def add_datetime(self, title, description=None):
+        # type: (str, Optional[str]) -> FieldDateTime
         """
         Creates DateTime field
         :param str title: Specifies the display name of the field
@@ -50,10 +61,11 @@ class FieldCollection(EntityCollection[Field]):
                 description=description,
                 field_type_kind=FieldType.DateTime,
             )
-        )  # type: FieldDateTime
+        )
         return return_type
 
     def add_geolocation_field(self, title, description=None):
+        # type: (str, Optional[str]) -> FieldGeolocation
         """
         Creates Geolocation field
 
@@ -66,13 +78,29 @@ class FieldCollection(EntityCollection[Field]):
                 description=description,
                 field_type_kind=FieldType.Geolocation,
             )
-        )  # type: FieldGeolocation
+        )
+        return return_type
+
+    def add_number(self, title, description=None):
+        # type: (str, Optional[str]) -> FieldNumber
+        """
+        Creates Number field
+        :param str title: Specifies the display name of the field
+        :param str or None description: Specifies the description of the field
+        """
+        return_type = self.add(
+            FieldCreationInformation(
+                title=title,
+                description=description,
+                field_type_kind=FieldType.Number,
+            )
+        )
         return return_type
 
     def add_url_field(self, title, description=None):
+        # type: (str, Optional[str]) -> FieldUrl
         """
         Creates Url field
-
         :param str title: Specifies the display name of the field
         :param str or None description:
         """
@@ -124,8 +152,6 @@ class FieldCollection(EntityCollection[Field]):
                     return_type=return_type,
                 )
 
-        from office365.sharepoint.lists.list import List
-
         if isinstance(lookup_list, List):
 
             def _lookup_list_loaded():
@@ -158,11 +184,10 @@ class FieldCollection(EntityCollection[Field]):
         return self.add_field(FieldCreationInformation(title, FieldType.User))
 
     def add_text_field(self, title):
+        # type: (str) -> FieldText
         """
         Creates a Text field
-
         :param str title: specifies the display name of the field
-        :rtype: office365.sharepoint.fields.text.FieldText
         """
         return self.add_field(FieldCreationInformation(title, FieldType.Text))
 
@@ -245,6 +270,7 @@ class FieldCollection(EntityCollection[Field]):
         else:
 
             def _term_store_loaded(term_store):
+                # type: (TermStore) -> None
                 TaxonomyField.create(
                     self,
                     name,
@@ -254,9 +280,10 @@ class FieldCollection(EntityCollection[Field]):
                     return_type=return_type,
                 )
 
-            self.context.load(
-                self.context.taxonomy.term_store, after_loaded=_term_store_loaded
+            self.context.load(self.context.taxonomy.term_store).after_query_execute(
+                _term_store_loaded
             )
+
         return return_type
 
     def create_field_as_xml(self, schema_xml, return_type=None):
@@ -287,7 +314,7 @@ class FieldCollection(EntityCollection[Field]):
         )
 
     def get_by_internal_name_or_title(self, value):
-        """Returns the first field (2) in the collection based on the internal name or the title specified
+        """Returns the first field in the collection based on the internal name or the title specified
         by the parameter.
 
         :param str value:  The title or internal name to look up the field (2) by.
@@ -309,3 +336,8 @@ class FieldCollection(EntityCollection[Field]):
             self.context,
             ServiceOperationPath("getByTitle", [title], self.resource_path),
         )
+
+    @property
+    def parent(self):
+        # type: () -> Web|List
+        return self._parent

office365/sharepoint/fields/computed.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.fields.field import Field
 
 
@@ -10,9 +12,6 @@ class FieldComputed(Field):
 
     @property
     def enable_lookup(self):
-        """
-        Specifies whether a lookup field can reference the field (2).
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether a lookup field can reference the field."""
         return self.properties.get("EnableLookup", None)

office365/sharepoint/fields/currency.py

@@ -1,24 +1,20 @@
+from typing import Optional
+
 from office365.sharepoint.fields.number import FieldNumber
 
 
 class FieldCurrency(FieldNumber):
-    """Specifies a field (2) that contains currency values. To set properties, call the Update method
+    """Specifies a field that contains currency values. To set properties, call the Update method
     (section 3.2.5.43.2.1.5)."""
 
     @property
     def currency_locale_id(self):
-        """
-        Gets the language code identifier (LCID) used to format the value of the field.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets the language code identifier (LCID) used to format the value of the field."""
         return self.properties.get("CurrencyLocaleId", None)
 
     @currency_locale_id.setter
     def currency_locale_id(self, value):
-        """
-        Sets the language code identifier (LCID) used to format the value of the field.
-
-        :type value: int
-        """
+        # type: (int) -> None
+        """Sets the language code identifier (LCID) used to format the value of the field."""
         self.set_property("CurrencyLocaleId", value)

office365/sharepoint/fields/date_time.py

@@ -9,18 +9,14 @@ class FieldDateTime(Field):
 
     @property
     def datetime_calendar_type(self):
-        """
-        Gets the calendar type of the field
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets the calendar type of the field"""
         return self.properties.get("DateTimeCalendarType", None)
 
     @datetime_calendar_type.setter
     def datetime_calendar_type(self, value):
-        """
-        Sets Gets the calendar type of the field
-        :type value: int
-        """
+        # type: (int) -> None
+        """Sets Gets the calendar type of the field"""
         self.set_property("DateTimeCalendarType", value)
 
     @property