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

office365/sharepoint/webhooks/subscription.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from typing import Optional
 
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.sharepoint.entity import Entity
@@ -9,41 +10,32 @@ class Subscription(Entity):
 
     @property
     def application_id(self):
-        """
-        Identifier of the application used to create the subscription.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Identifier of the application used to create the subscription."""
         return self.properties.get("applicationId", None)
 
     @property
     def notification_url(self):
-        """
-        Gets endpoint that will be called when an event occurs.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Gets endpoint that will be called when an event occurs."""
         return self.properties.get("notificationUrl", None)
 
     @notification_url.setter
     def notification_url(self, value):
-        """
-        Sets endpoint that will be called when an event occurs.
-        """
+        # type: (str) -> None
+        """Sets endpoint that will be called when an event occurs."""
         self.set_property("notificationUrl", value)
 
     @property
     def expiration_datetime(self):
-        """
-        Gets endpoint that will be called when an event occurs.
-
-        :rtype: str
-        """
+        # type: () -> Optional[datetime]
+        """Gets endpoint that will be called when an event occurs."""
         return self.properties.get("expirationDateTime", None)
 
     @expiration_datetime.setter
     def expiration_datetime(self, value):
-        """
-        Sets endpoint that will be called when an event occurs.
-        """
+        # type: (datetime|str) -> None
+        """Sets endpoint that will be called when an event occurs."""
         if isinstance(value, datetime):
             self.set_property("expirationDateTime", value.isoformat())
         else:

office365/sharepoint/webparts/webpart.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -9,11 +11,11 @@ class WebPart(Entity):
 
     @property
     def zone_index(self):
+        # type: () -> Optional[int]
         """
         An integer that specifies the relative position of a Web Part in a Web Part zone.
         Web Parts are positioned from the smallest to the largest zone index. If two or more Web Parts have the
         same zone index they are positioned adjacent to each other in an undefined order
-        :rtype: int or None
         """
         return self.properties.get("ZoneIndex", None)
 

office365/sharepoint/webs/modernize_homepage_result.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -6,7 +8,6 @@ class ModernizeHomepageResult(Entity):
 
     @property
     def can_modernize_homepage(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """"""
         return self.properties.get("CanModernizeHomepage", None)

office365/sharepoint/webs/regional_settings.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.sites.language_collection import LanguageCollection
@@ -9,40 +11,30 @@ class RegionalSettings(Entity):
 
     @property
     def collation(self):
+        # type: () -> Optional[int]
         """
         Specifies the collation order of the site (2), which indicates an additional sorting order that SHOULD
         be processed by any back-end database server associated with the site (2). The collation method is an
         implementation-specific capability of the front-end Web server and back-end database server.
-
-        :rtype: int or None
         """
         return self.properties.get("Collation", None)
 
     @property
     def date_format(self):
-        """
-        Gets the date format that is used on the server.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets the date format that is used on the server."""
         return self.properties.get("DateFormat", None)
 
     @property
     def locale_id(self):
-        """
-        Gets the locale identifier in use on the server.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets the locale identifier in use on the server."""
         return self.properties.get("LocaleId", None)
 
     @property
     def work_days(self):
-        """
-        Gets a number that represents the work days of Web site calendars.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets a number that represents the work days of Web site calendars."""
         return self.properties.get("WorkDays", None)
 
     @property

office365/sharepoint/webs/template.py

@@ -1,80 +1,80 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
 class WebTemplate(Entity):
     """Specifies a site definition or a site template that is used to instantiate a site."""
 
+    def __str__(self):
+        return self.title or self.entity_type_name
+
     def __repr__(self):
         return self.name
 
     @property
     def description(self):
-        """Gets a value that specifies the description of the list template.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies the description of the list template."""
         return self.properties.get("Description", None)
 
     @property
     def display_category(self):
+        # type: () -> Optional[str]
         """
         Specifies the display name for the category that this site definition configuration or site template is
         a part of.
-        :rtype: str or None
         """
         return self.properties.get("DisplayCategory", None)
 
     @property
     def image_url(self):
+        # type: () -> Optional[str]
         """
         Specifies the URL for the image that is associated with the site definition configuration or site template.
-        :rtype: str or None
         """
         return self.properties.get("ImageUrl", None)
 
     @property
     def is_hidden(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the site definition configuration is displayed in the user interface for creating new sites
-        :rtype: bool or None
         """
         return self.properties.get("IsHidden", None)
 
     @property
     def is_root_web_only(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the site definition configuration or site template can only be applied to the top-level site
         in the site collection.
-        :rtype: bool or None
         """
         return self.properties.get("IsRootWebOnly", None)
 
     @property
     def is_sub_web_only(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the site definition configuration or site template can only be applied to subsites
         created within the site collection.
-        :rtype: bool or None
         """
         return self.properties.get("IsSubWebOnly", None)
 
     @property
     def lcid(self):
-        """
-        Specifies the LCID for the site definition configuration or site template.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Specifies the LCID for the site definition configuration or site template."""
         return self.properties.get("Lcid", None)
 
     @property
     def name(self):
-        """Gets a value that specifies the display name of the list template.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a value that specifies the display name of the list template."""
         return self.properties.get("Name", None)
 
     @property
     def title(self):
-        """Specifies the display name for the site definition configuration or site template.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the display name for the site definition configuration or site template."""
         return self.properties.get("Title", None)

office365/sharepoint/webs/theme_info.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
@@ -23,14 +25,12 @@ class ThemeInfo(Entity):
 
     @property
     def accessible_description(self):
-        """Specifies the accessible description for this theme.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the accessible description for this theme."""
         return self.properties.get("AccessibleDescription", None)
 
     @property
     def theme_background_image_uri(self):
-        """Specifies the URI of the background image for this theme.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the URI of the background image for this theme."""
         return self.properties.get("ThemeBackgroundImageUri", None)

office365/sharepoint/webs/web.py

@@ -1068,9 +1068,7 @@ class Web(SecurableObject):
         return return_type
 
     def increment_site_client_tag(self):
-        """
-        Increments the client cache control number for this site collection.
-        """
+        """Increments the client cache control number for this site collection."""
         qry = ServiceOperationQuery(self, "IncrementSiteClientTag")
         self.context.add_query(qry)
         return self
@@ -1080,7 +1078,6 @@ class Web(SecurableObject):
         Applies the specified site definition or site template to the website that has no template applied to it.
 
         :param str web_template: The name of the site definition or the file name of the site template to be applied.
-        :return:
         """
         qry = ServiceOperationQuery(
             self, "ApplyWebTemplate", {"webTemplate": web_template}
@@ -1089,9 +1086,7 @@ class Web(SecurableObject):
         return self
 
     def get_custom_list_templates(self):
-        """
-        Specifies the collection of custom list templates for a given site.
-        """
+        """Specifies the collection of custom list templates for a given site."""
         return_type = ListTemplateCollection(self.context)
         qry = ServiceOperationQuery(
             self, "GetCustomListTemplates", None, None, None, return_type
@@ -1283,12 +1278,19 @@ class Web(SecurableObject):
         :param str email_subject: The email subject.
         :param str email_body: The email subject.
         """
+
         return_type = SharingResult(self.context)
 
-        def _share(picker_result, group):
-            # type: (ClientResult[str], Group) -> None
+        def _share(picker_result):
+            # type: (ClientResult[str]) -> None
+            groups = {
+                ExternalSharingSiteOption.View: self.associated_visitor_group,
+                ExternalSharingSiteOption.Edit: self.associated_member_group,
+                ExternalSharingSiteOption.Owner: self.associated_owner_group,
+            }  # type: dict[ExternalSharingSiteOption, Group]
+
             picker_input = "[{0}]".format(picker_result.value)
-            role_value = "group:{groupId}".format(groupId=group.id)
+            role_value = "group:{groupId}".format(groupId=groups[share_option].id)
             Web.share_object(
                 self.context,
                 self.url,
@@ -1304,15 +1306,9 @@ class Web(SecurableObject):
             )
 
         def _web_resolved():
-            groups = {
-                ExternalSharingSiteOption.View: self.associated_visitor_group,
-                ExternalSharingSiteOption.Edit: self.associated_member_group,
-                ExternalSharingSiteOption.Owner: self.associated_owner_group,
-            }  # type: dict[ExternalSharingSiteOption, Group]
-
             ClientPeoplePickerWebServiceInterface.client_people_picker_resolve_user(
                 self.context, user_principal_name
-            ).after_execute(_share, groups[share_option])
+            ).after_execute(_share)
 
         self.ensure_properties(
             [
@@ -1974,9 +1970,7 @@ class Web(SecurableObject):
     @property
     def site_users(self):
         # type: () -> UserCollection
-        """
-        Specifies the collection of users in the site collection that contains the site
-        """
+        """Specifies the collection of users in the site collection that contains the site"""
         return self.properties.get(
             "SiteUsers",
             UserCollection(self.context, ResourcePath("siteUsers", self.resource_path)),
@@ -2185,9 +2179,8 @@ class Web(SecurableObject):
 
     @property
     def quick_launch_enabled(self):
-        """Gets a value that specifies whether the Quick Launch area is enabled on the site.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a value that specifies whether the Quick Launch area is enabled on the site."""
         return self.properties.get("QuickLaunchEnabled", None)
 
     @property

office365/teams/members/aad_user_conversation.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.teams.members.conversation import ConversationMember
 
@@ -7,10 +9,8 @@ class AadUserConversationMember(ConversationMember):
 
     @property
     def user_id(self):
-        """
-        The guid of the user.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The guid of the user."""
         return self.properties.get("userId", None)
 
     @property

office365/teams/operations/async_operation.py

@@ -38,9 +38,7 @@ class TeamsAsyncOperation(Entity):
         """
 
         def _poll_for_status(polling_number):
-            """
-            :type polling_number: int
-            """
+            # type: (int) -> None
             if polling_number > max_polling_count:
                 if callable(failure_callback):
                     failure_callback(self)
@@ -48,16 +46,16 @@ class TeamsAsyncOperation(Entity):
                     raise TypeError("The maximum polling count has been reached")
 
             def _verify_status(return_type):
-                if self.status != status_type:
+                if return_type.status != status_type:
                     time.sleep(polling_interval_secs)
                     _poll_for_status(polling_number + 1)
                 else:
                     if callable(success_callback):
-                        success_callback(self)
+                        success_callback(return_type)
 
-            self.context.load(self, after_loaded=_verify_status)
+            self.get().after_execute(_verify_status, execute_first=True)
 
-        self.ensure_property("id", _poll_for_status, 1)
+        _poll_for_status(1)
         return self
 
     @property

office365/runtime/paths/item.py

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