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

office365/sharepoint/principal/users/user.py

@@ -1,8 +1,11 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.alerts.collection import AlertCollection
 from office365.sharepoint.principal.principal import Principal
 from office365.sharepoint.principal.users.id_info import UserIdInfo
+from office365.sharepoint.userprofiles.person_properties import PersonProperties
 
 
 class User(Principal):
@@ -14,18 +17,16 @@ class User(Principal):
 
         return_type = Site(self.context)
 
-        def _user_loaded():
-            from office365.sharepoint.userprofiles.people_manager import PeopleManager
-
-            people_manager = PeopleManager(self.context)
-            person_props = people_manager.get_properties_for(self.login_name)
+        def _person_props_loaded(person_props):
+            # type: (PersonProperties) -> None
+            return_type.set_property("__siteUrl", person_props.personal_url)
 
-            def _person_props_loaded(resp):
-                return_type.set_property("__siteUrl", person_props.personal_url)
+        def _get_properties_for():
+            self.context.people_manager.get_properties_for(
+                self.login_name
+            ).after_execute(_person_props_loaded)
 
-            self.context.after_execute(_person_props_loaded)
-
-        self.ensure_property("LoginName", _user_loaded)
+        self.ensure_property("LoginName", _get_properties_for)
         return return_type
 
     def get_recent_files(self, top=100):
@@ -86,9 +87,8 @@ class User(Principal):
 
     @property
     def is_site_admin(self):
-        """Gets a Boolean value that specifies whether the user is a site collection administrator.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets a Boolean value that specifies whether the user is a site collection administrator."""
         return self.properties.get("IsSiteAdmin", None)
 
     @property
@@ -99,51 +99,45 @@ class User(Principal):
 
     @property
     def email(self):
+        # type: () -> Optional[str]
         """
         Specifies the e-mail address of the user.
         It MUST NOT be NULL. Its length MUST be equal to or less than 255.
-        :rtype: str or None
         """
         return self.properties.get("Email", None)
 
     @property
     def email_with_fallback(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
         return self.properties.get("EmailWithFallback", None)
 
     @property
     def expiration(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
         return self.properties.get("Expiration", None)
 
     @property
     def is_email_authentication_guest_user(self):
+        # type: () -> Optional[bool]
         """
         Indicates whether the User is a share by email guest user using time of access authentication.
         If this instance is an email authentication guest user, this value MUST be true, otherwise it MUST be false.
-        :rtype: bool or None
         """
         return self.properties.get("IsEmailAuthenticationGuestUser", None)
 
     @property
     def is_share_by_email_guest_user(self):
+        # type: () -> Optional[bool]
         """
         Gets a value indicating whether this User is a share by email guest user.
         If this instance is a share by email guest user, it's true; otherwise, false.
-        :rtype: bool or None
         """
         return self.properties.get("IsShareByEmailGuestUser", None)
 
     @property
     def user_principal_name(self):
-        """
-        User principal name of the user that initiated the sign-in.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """User principal name of the user that initiated the sign-in."""
         return self.properties.get("UserPrincipalName", None)
 
     def get_property(self, name, default_value=None):

office365/sharepoint/publishing/pages/collection.py

@@ -12,7 +12,7 @@ from office365.sharepoint.translation.status_collection import (
 )
 
 
-class SitePageCollection(SitePageMetadataCollection):
+class SitePageCollection(SitePageMetadataCollection[SitePage]):
     def __init__(self, context, resource_path=None):
         """Specifies a collection of site pages."""
         if resource_path is None:
@@ -85,10 +85,7 @@ class SitePageCollection(SitePageMetadataCollection):
 
     def get_by_name(self, name):
         """Gets the site page with the specified file name.
-
         :param str name: Specifies the name of the site page.
-
-        :rtype: SitePage
         """
         return self.single("FileName eq '{0}'".format(name))
 

office365/sharepoint/publishing/pages/metadata.py

@@ -1,18 +1,27 @@
+import datetime
+from typing import TYPE_CHECKING, Optional
+
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.publishing.pages.version_info import SitePageVersionInfo
 from office365.sharepoint.publishing.user_info import UserInfo
 
+if TYPE_CHECKING:
+    from office365.sharepoint.publishing.pages.metadata_collection import (
+        SitePageMetadataCollection,
+    )
+
 
 class SitePageMetadata(Entity):
     """Represents the core properties of a Site Page."""
 
+    def __repr__(self):
+        return self.file_name or self.absolute_url or self.entity_type_name
+
     @property
     def absolute_url(self):
-        """Gets the absolute Url of the Site Page.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the absolute Url of the Site Page."""
         return self.properties.get("AbsoluteUrl", None)
 
     @property
@@ -31,84 +40,64 @@ class SitePageMetadata(Entity):
 
     @property
     def comments_disabled(self):
-        """
-        Indicates if comments are disabled for the current Site Page.
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Indicates if comments are disabled for the current Site Page."""
         return self.properties.get("CommentsDisabled", None)
 
     @property
     def banner_image_url(self):
-        """Gets the banner image Url.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the banner image Url"""
         return self.properties.get("BannerImageUrl", None)
 
     @banner_image_url.setter
     def banner_image_url(self, value):
-        """Sets the banner image Url.
-
-        :type value: str
-        """
+        # type: (str) -> None
+        """Sets the banner image Url"""
         self.set_property("BannerImageUrl", value)
 
     @property
     def content_type_id(self):
-        """Gets the content type ID of the current Site Page.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the content type ID of the current Site Page."""
         return self.properties.get("ContentTypeId", None)
 
     @content_type_id.setter
     def content_type_id(self, value):
-        """Sets the content type ID of the current Site Page.
-
-        :type value: str
-        """
+        # type: (str) -> None
+        """Sets the content type ID of the current Site Page."""
         self.set_property("ContentTypeId", value)
 
     @property
     def description(self):
-        """Gets the description for the current Site Page.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the description for the current Site Page"""
         return self.properties.get("Description", None)
 
     @property
     def does_user_have_edit_permission(self):
-        """Indicates if the current user has edit permission to the Site Page.
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Indicates if the current user has edit permission to the Site Page."""
         return self.properties.get("DoesUserHaveEditPermission", None)
 
     @property
     def file_name(self):
-        """Gets the file name of the current Site Page.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the file name of the current Site Page."""
         return self.properties.get("FileName", None)
 
     @property
     def first_published(self):
+        # type: () -> Optional[datetime.datetime]
         """Datetime of when the site page was initially published.
         The server MUST return Datetime.MinValue (00:00:00:0000000 UTC) when the site page has never been published.
-
-        :rtype: str or None
         """
         return self.properties.get("FirstPublished", None)
 
     @property
     def is_page_checked_out_to_current_user(self):
-        """Indicates if the Site Page is checked out to the current user.
-
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Indicates if the Site Page is checked out to the current user."""
         return self.properties.get("IsPageCheckedOutToCurrentUser", None)
 
     @property
@@ -118,16 +107,12 @@ class SitePageMetadata(Entity):
 
     @property
     def parent_collection(self):
-        """
-        :rtype: office365.sharepoint.publishing.pages.metadata_collection.SitePageMetadataCollection
-        """
+        # type: () -> SitePageMetadataCollection
         return self._parent_collection
 
     @property
     def topic_header(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
         return self.properties.get("TopicHeader", None)
 
     @property
@@ -146,9 +131,11 @@ class SitePageMetadata(Entity):
         return super(SitePageMetadata, self).get_property(name, default_value)
 
     def set_property(self, name, value, persist_changes=True):
-        if self._resource_path is None:
-            if name == "Id":
+        if name == "Id":
+            if self._resource_path is None:
                 self._resource_path = self.parent_collection.get_by_id(
                     value
                 ).resource_path
+            else:
+                self._resource_path.patch(value)
         return super(SitePageMetadata, self).set_property(name, value, persist_changes)

office365/sharepoint/publishing/pages/metadata_collection.py

@@ -1,14 +1,17 @@
+from typing import TypeVar
+
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.publishing.pages.metadata import SitePageMetadata
 
+T = TypeVar("T")
+
 
-class SitePageMetadataCollection(EntityCollection):
+class SitePageMetadataCollection(EntityCollection[T]):
     """Specifies a collection of site pages."""
 
     def get_by_id(self, site_page_id):
         """Gets the site page with the specified ID.
-
         :param int site_page_id: Specifies the identifier of the site page.
         """
         return SitePageMetadata(

office365/sharepoint/publishing/pages/page.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value import ClientValue
 from office365.runtime.paths.resource_path import ResourcePath
@@ -163,7 +165,6 @@ class SitePage(SitePageMetadata):
     def publish(self):
         """
         Publishes a major version of the current Site Page.  Returns TRUE on success, FALSE otherwise.
-
         """
         return_type = ClientResult(self.context, bool())
         qry = ServiceOperationQuery(self, "Publish", None, None, None, return_type)
@@ -202,42 +203,31 @@ class SitePage(SitePageMetadata):
 
     @property
     def canvas_content(self):
-        """
-        Gets the CanvasContent1 for the current Site Page.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the CanvasContent1 for the current Site Page"""
         return self.properties.get("CanvasContent1", None)
 
     @canvas_content.setter
     def canvas_content(self, value):
-        """
-        Sets the CanvasContent1 for the current Site Page.
-
-        :rtype: str or None
-        """
+        # type: (str) -> None
+        """Sets the CanvasContent1 for the current Site Page"""
         self.set_property("CanvasContent1", value)
 
     @property
     def layout_web_parts_content(self):
-        """
-        Gets the LayoutWebPartsContent field for the current Site Page.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the LayoutWebPartsContent field for the current Site Page."""
         return self.properties.get("LayoutWebpartsContent", None)
 
     @layout_web_parts_content.setter
     def layout_web_parts_content(self, value):
-        """
-        Sets the LayoutWebPartsContent field for the current Site Page.
-
-        :rtype: str or None
-        """
+        # type: (str) -> None
+        """Sets the LayoutWebPartsContent field for the current Site Page."""
         self.set_property("LayoutWebpartsContent", value)
 
     @property
     def translations(self):
+        # type: () -> TranslationStatusCollection
         return self.properties.get(
             "Translations",
             TranslationStatusCollection(
@@ -247,4 +237,5 @@ class SitePage(SitePageMetadata):
 
     @property
     def entity_type_name(self):
+        # type: () -> str
         return "SP.Publishing.SitePage"

office365/sharepoint/publishing/pages/reposts/repost.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.publishing.pages.page import SitePage
 
 
@@ -7,23 +9,17 @@ class RepostPage(SitePage):
 
     @property
     def is_banner_image_url_external(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
         return self.properties.get("IsBannerImageUrlExternal", None)
 
     @property
     def original_source_item_id(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
         return self.properties.get("OriginalSourceItemId", None)
 
     @property
     def original_source_url(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
         return self.properties.get("OriginalSourceUrl", None)
 
     @property

office365/sharepoint/publishing/pages/service.py

@@ -1,3 +1,5 @@
+from typing import TYPE_CHECKING, Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -7,9 +9,13 @@ from office365.sharepoint.entity import Entity
 from office365.sharepoint.files.file import File
 from office365.sharepoint.publishing.file_picker_options import FilePickerOptions
 from office365.sharepoint.publishing.pages.collection import SitePageCollection
+from office365.sharepoint.publishing.pages.page import SitePage
 from office365.sharepoint.publishing.primary_city_time import PrimaryCityTime
 from office365.sharepoint.publishing.sites.communication.site import CommunicationSite
 
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
 
 class SitePageService(Entity):
     """Represents a set of APIs to use for managing site pages."""
@@ -22,6 +28,7 @@ class SitePageService(Entity):
 
     @property
     def pages(self):
+        # type: () -> SitePageCollection
         """Gets the SitePageCollection for the current web."""
         return self.properties.get(
             "pages",
@@ -44,53 +51,45 @@ class SitePageService(Entity):
         return "SP.Publishing.SitePageService"
 
     def create_page(self, title):
+        # type: (str) -> SitePage
         """Create a new sitePage in the site pages list in a site.
-
         :param str title: The title of Site Page
         """
-        return_type = self.pages.add()
-
-        def _draft_saved(resp):
-            """
-            :type resp: requests.Response
-            """
-            resp.raise_for_status()
-            return_type.get()
-
-        def _page_created(resp):
-            """
-            :type resp: requests.Response
-            """
-            resp.raise_for_status()
-            return_type.save_draft(title=title)
-            self.context.after_execute(_draft_saved)
-
-        self.context.after_execute(_page_created)
-        return return_type
+
+        def _page_created(return_type):
+            # type: (SitePage) -> None
+
+            def _draft_saved(result):
+                # type: (ClientResult[bool]) -> None
+                pass
+
+            return_type.save_draft(title=title).after_execute(
+                _draft_saved, execute_first=True
+            )
+
+        return self.pages.add().after_execute(_page_created).get()
 
     def create_and_publish_page(self, title):
         """
         Create and publish a new sitePage in the site pages list in a site.
-
         :param str title: The title of Site Page
         """
-        return_type = self.create_page(title)
 
-        def _page_created(resp):
-            """
-            :type resp: requests.Response
-            """
-            resp.raise_for_status()
-            return_type.publish()
+        def _page_created(return_type):
+            # type: (SitePage) -> None
 
-        self.context.after_execute(_page_created)
-        return return_type
+            def _page_published(result):
+                # type: (ClientResult[bool]) -> None
+                pass
+
+            return_type.publish().after_execute(_page_published)
+
+        return self.create_page(title).after_execute(_page_created)
 
     def can_create_page(self):
         """
         Checks if the current user has permission to create a site page on the site pages document library.
         MUST return true if the user has permission to create a site page, otherwise MUST return false.
-
         """
         return_type = ClientResult(self.context, bool())
         qry = ServiceOperationQuery(
@@ -113,10 +112,7 @@ class SitePageService(Entity):
 
     @staticmethod
     def get_current_user_memberships(context, scenario=None):
-        """
-        :param office365.sharepoint.client_context.ClientContext context: Client context
-        :param str scenario:
-        """
+        # type: (ClientContext, Optional[str]) -> ClientResult[StringCollection]
         return_type = ClientResult(context, StringCollection())
         svc = SitePageService(context)
         qry = ServiceOperationQuery(
@@ -127,9 +123,9 @@ class SitePageService(Entity):
 
     @staticmethod
     def get_time_zone(context, city_name):
+        # type: (ClientContext, str) -> PrimaryCityTime
         """
         Gets time zone data for specified city.
-
         :param office365.sharepoint.client_context.ClientContext context:
         :param str city_name: The name of the city.
         """
@@ -144,8 +140,8 @@ class SitePageService(Entity):
 
     @staticmethod
     def compute_file_name(context, title):
+        # type: (ClientContext, str) -> ClientResult[str]
         """
-
         :param office365.sharepoint.client_context.ClientContext context: Client context
         :param str title: The title of the page.
         """
@@ -164,10 +160,7 @@ class SitePageService(Entity):
 
     @staticmethod
     def is_file_picker_external_image_search_enabled(context):
-        """
-
-        :param office365.sharepoint.client_context.ClientContext context: Client context
-        """
+        # type: (ClientContext) -> ClientResult[bool]
         return_type = ClientResult(context)
         binding_type = SitePageService(context)
         qry = ServiceOperationQuery(
@@ -184,10 +177,7 @@ class SitePageService(Entity):
 
     @staticmethod
     def org_assets(context):
-        """
-
-        :param office365.sharepoint.client_context.ClientContext context: Client context
-        """
+        # type: (ClientContext) -> ClientResult[OrgAssets]
         return_type = ClientResult(context, OrgAssets())
         svc = SitePageService(context)
         qry = ServiceOperationQuery(
@@ -198,10 +188,7 @@ class SitePageService(Entity):
 
     @staticmethod
     def file_picker_tab_options(context):
-        """
-
-        :param office365.sharepoint.client_context.ClientContext context: Client context
-        """
+        # type: (ClientContext) -> ClientResult[FilePickerOptions]
         return_type = ClientResult(context, FilePickerOptions())
         svc = SitePageService(context)
         qry = ServiceOperationQuery(

office365/sharepoint/pushnotifications/collection.py

@@ -3,7 +3,9 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.pushnotifications.subscriber import PushNotificationSubscriber
 
 
-class PushNotificationSubscriberCollection(EntityCollection):
+class PushNotificationSubscriberCollection(
+    EntityCollection[PushNotificationSubscriber]
+):
     """Specifies the collection of push notification subscribers for the site"""
 
     def __init__(self, context, resource_path=None):

office365/sharepoint/recyclebin/item.py

@@ -1,5 +1,8 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.principal.users.user import User
@@ -30,17 +33,13 @@ class RecycleBinItem(Entity):
 
     @property
     def size(self):
-        """Gets a value that specifies the size of the Recycle Bin item in bytes.
-
-        :rtype: long or None
-        """
+        # type: () -> Optional[int]
+        """Gets a value that specifies the size of the Recycle Bin item in bytes."""
         return self.properties.get("Size", None)
 
     @property
     def author(self):
-        """
-        Gets a value that specifies the user who created the Recycle Bin item.
-        """
+        """Gets a value that specifies the user who created the Recycle Bin item."""
         return self.properties.get(
             "Author", User(self.context, ResourcePath("Author", self.resource_path))
         )
@@ -61,8 +60,11 @@ class RecycleBinItem(Entity):
     def set_property(self, name, value, persist_changes=True):
         super(RecycleBinItem, self).set_property(name, value, persist_changes)
         # fallback: create a new resource path
-        if self._resource_path is None:
-            if name == "Id" and self._parent_collection is not None:
+
+        if name == "Id":
+            if self._resource_path is None:
                 self._resource_path = ServiceOperationPath(
                     "GetById", [value], self._parent_collection.resource_path
                 )
+            else:
+                self._resource_path.patch(value)

office365/sharepoint/recyclebin/item_collection.py

@@ -5,7 +5,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.recyclebin.item import RecycleBinItem
 
 
-class RecycleBinItemCollection(EntityCollection):
+class RecycleBinItemCollection(EntityCollection[RecycleBinItem]):
     """Represents a collection of View resources."""
 
     def __init__(self, context, resource_path=None):