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

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/directory/helper.py

@@ -1,6 +1,7 @@
 from office365.runtime.client_result import ClientResult
 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.directory.members_info import MembersInfo
 from office365.sharepoint.directory.membership_result import MembershipResult
 from office365.sharepoint.directory.my_groups_result import MyGroupsResult
@@ -32,6 +33,7 @@ class SPHelper(Entity):
 
     @staticmethod
     def check_site_availability(context, site_url):
+        # type: (ClientContext, str) -> ClientResult[bool]
         """
         :param str site_url: Site Url
         :param office365.sharepoint.client_context.ClientContext context: SharePoint context

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

@@ -36,8 +36,7 @@ class FeatureCollection(EntityCollection[Feature]):
                 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,21 @@ 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.user import FieldUser
 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 +50,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 +62,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 +79,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:
         """
@@ -95,13 +124,12 @@ class FieldCollection(EntityCollection[Field]):
         :param str title: Specifies the display name of the field.
         """
         from office365.sharepoint.fields.lookup import FieldLookup
+        from office365.sharepoint.lists.list import List  # noqa
 
         return_type = FieldLookup(self.context)
 
         def _add_lookup_field(lookup_list_id):
-            """
-            :type lookup_list_id: str
-            """
+            # type: (str) -> None
             if allow_multiple_values:
                 field_schema = """
                         <Field Type="LookupMulti" Mult="TRUE" DisplayName="{title}" Required="FALSE" Hidden="TRUE" \
@@ -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():
@@ -150,6 +176,7 @@ class FieldCollection(EntityCollection[Field]):
         return self.add_field(create_field_info)
 
     def add_user_field(self, title):
+        # type: (str) -> FieldUser
         """
         Creates a User field
 
@@ -158,11 +185,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 +271,7 @@ class FieldCollection(EntityCollection[Field]):
         else:
 
             def _term_store_loaded(term_store):
+                # type: (TermStore) -> None
                 TaxonomyField.create(
                     self,
                     name,
@@ -254,9 +281,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 +315,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 +337,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

office365/sharepoint/fields/field.py

@@ -69,7 +69,6 @@ class Field(Entity):
 
         :type context: office365.sharepoint.client_context.ClientContext
         :type field_parameters: office365.sharepoint.fields.creation_information.FieldCreationInformation
-        :return: Field
         """
         field_type = Field.resolve_field_type(field_parameters.FieldTypeKind)
         field = field_type(context)
@@ -124,19 +123,14 @@ class Field(Entity):
 
     @property
     def id(self):
-        """
-        Gets a value that specifies the field identifier.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies the field identifier."""
         return self.properties.get("Id", None)
 
     @property
     def auto_indexed(self):
-        """
-        Gets a Boolean value that specifies whether the field is auto-indexed.
-        :rtype: str or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a Boolean value that specifies whether the field is auto-indexed."""
         return self.properties.get("AutoIndexed", None)
 
     @property
@@ -200,17 +194,13 @@ class Field(Entity):
     @property
     def internal_name(self):
         # type: () -> Optional[str]
-        """
-        Gets a value that specifies the field internal name.
-        """
+        """Gets a value that specifies the field internal name."""
         return self.properties.get("InternalName", None)
 
     @property
     def can_be_deleted(self):
         # type: () -> Optional[bool]
-        """
-        Gets a value that specifies whether the field can be deleted
-        """
+        """Gets a value that specifies whether the field can be deleted"""
         return self.properties.get("CanBeDeleted", None)
 
     @property

office365/sharepoint/fields/lookup.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.fields.field import Field
 
 
@@ -6,38 +8,38 @@ class FieldLookup(Field):
 
     @property
     def allow_multiple_values(self):
-        """Gets a value that specifies whether the lookup field allows multiple values.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a value that specifies whether the lookup field allows multiple values."""
         return self.properties.get("AllowMultipleValues", None)
 
     @allow_multiple_values.setter
     def allow_multiple_values(self, value):
+        # type: (bool) -> None
         """Sets a value that specifies whether the lookup field allows multiple values."""
         self.set_property("AllowMultipleValues", value)
 
     @property
     def lookup_web_id(self):
-        """Gets the ID of the Web site that contains the list that is the source of this field's value.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the ID of the Web site that contains the list that is the source of this field's value."""
         return self.properties.get("LookupWebId", None)
 
     @lookup_web_id.setter
     def lookup_web_id(self, val):
-        """Sets the ID of the Web site that contains the list that is the source of this field's value.
-        :rtype: str or None
-        """
+        # type: (str) -> None
+        """Sets the ID of the Web site that contains the list that is the source of this field's value."""
         self.set_property("LookupWebId", val, True)
 
     @property
     def lookup_list(self):
+        # type: () -> Optional[str]
         """Gets value that specifies the list identifier of the list that contains the field to use as the lookup
         values."""
         return self.properties.get("LookupList", None)
 
     @lookup_list.setter
     def lookup_list(self, val):
+        # type: (str) -> None
         """Sets a value that specifies the list identifier of the list that contains the field to use as
         the lookup values."""
         self.set_property("LookupList", val, True)

office365/sharepoint/fields/multi_choice.py

@@ -1,32 +1,28 @@
+from typing import Optional
+
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.fields.field import Field
 
 
 class FieldMultiChoice(Field):
-    """Specifies a field (2) that contains one or more values from a set of specified values."""
+    """Specifies a field that contains one or more values from a set of specified values."""
 
     @property
     def fill_in_choice(self):
+        # type: () -> Optional[bool]
         """
-        Specifies whether the field (2) can accept values other than those specified in
+        Specifies whether the field can accept values other than those specified in
         Microsoft.Sharepoint.Client.FieldMultiChoice.Choices, as specified in section 3.2.5.51.1.1.2.
-
-        :rtype: bool or None
         """
         return self.properties.get("FillInChoice", None)
 
     @property
     def mappings(self):
-        """
-        Specifies the internal values corresponding to Choices.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the internal values corresponding to Choices."""
         return self.properties.get("Mappings", None)
 
     @property
     def choices(self):
-        """
-        Specifies values that are available for selection in the field
-        """
+        """Specifies values that are available for selection in the field"""
         return self.properties.get("Choices", StringCollection())

office365/sharepoint/fields/multi_line_text.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.fields.field import Field
 
 
@@ -8,30 +10,24 @@ class FieldMultiLineText(Field):
 
     @property
     def allow_hyperlink(self):
-        """
-        Gets a value that specifies whether a hyperlink is allowed as a value of the field.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a value that specifies whether a hyperlink is allowed as a value of the field."""
         return self.properties.get("AllowHyperlink", None)
 
     @allow_hyperlink.setter
     def allow_hyperlink(self, val):
-        """
-        Sets a value that specifies whether a hyperlink is allowed as a value of the field.
-        """
+        # type: (bool) -> None
+        """Sets a value that specifies whether a hyperlink is allowed as a value of the field."""
         self.set_property("AllowHyperlink", val)
 
     @property
     def number_of_lines(self):
-        """
-        Gets the number of lines to display in the field.
-        :return:
-        """
+        # type: () -> Optional[int]
+        """Gets the number of lines to display in the field."""
         return self.properties.get("NumberOfLines", None)
 
     @number_of_lines.setter
     def number_of_lines(self, val):
-        """
-        Set the number of lines to display in the field.
-        """
+        # type: (int) -> None
+        """Set the number of lines to display in the field."""
         self.set_property("NumberOfLines", val)