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

office365/sharepoint/lists/list.py

@@ -1,5 +1,6 @@
+import os
 from datetime import datetime
-from typing import Optional
+from typing import AnyStr, Optional
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -7,6 +8,7 @@ from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.changes.collection import ChangeCollection
+from office365.sharepoint.changes.log_item_query import ChangeLogItemQuery
 from office365.sharepoint.changes.query import ChangeQuery
 from office365.sharepoint.changes.token import ChangeToken
 from office365.sharepoint.contenttypes.collection import ContentTypeCollection
@@ -133,9 +135,7 @@ class List(SecurableObject):
         return return_type
 
     def get_metadata_navigation_settings(self):
-        """
-        Retrieves the configured metadata navigation settings for the list.
-        """
+        """Retrieves the configured metadata navigation settings for the list."""
         from office365.sharepoint.navigation.metadata_settings import (
             MetadataNavigationSettings,
         )
@@ -153,12 +153,10 @@ class List(SecurableObject):
         return return_type
 
     def get_sharing_settings(self):
-        """
-        Retrieves a sharing settings for a List
-        """
+        """Retrieves a sharing settings for a List"""
         return_type = ObjectSharingSettings(self.context)
 
-        def _list_loaded():
+        def _get_sharing_settings():
             from office365.sharepoint.webs.web import Web
 
             list_abs_path = SPResPath.create_absolute(
@@ -168,7 +166,7 @@ class List(SecurableObject):
                 self.context, str(list_abs_path), return_type=return_type
             )
 
-        self.ensure_property("RootFolder", _list_loaded)
+        self.ensure_property("RootFolder", _get_sharing_settings)
         return return_type
 
     def get_site_script(self, options=None):
@@ -190,9 +188,7 @@ class List(SecurableObject):
         return return_type
 
     def get_all_rules(self):
-        """
-        Retrieves rules of a List
-        """
+        """Retrieves rules of a List"""
         return_type = ClientResult(self.context, ClientValueCollection(SPListRule))
         qry = ServiceOperationQuery(self, "GetAllRules", None, None, None, return_type)
         self.context.add_query(qry)
@@ -390,11 +386,10 @@ class List(SecurableObject):
         return return_type
 
     def get_list_item_changes_since_token(self, query):
+        # type: (ChangeLogItemQuery) -> ClientResult[AnyStr]
         """
         Returns the changes made to the list since the date and time specified in the change token defined
         by the query input parameter.
-
-        :type query: office365.sharepoint.changes.log_item_query.ChangeLogItemQuery
         """
         return_type = ClientResult(self.context, bytes())
         payload = {"query": query}
@@ -437,7 +432,6 @@ class List(SecurableObject):
         :param str description: A string that contains the description for the list template.
         :param str name: A string that contains the title for the list template.
         :param str file_name: A string that contains the file name for the list template with an .stp extension.
-        :return:
         """
         payload = {
             "strFileName": file_name,
@@ -460,11 +454,10 @@ class List(SecurableObject):
         )
 
     def get_web_dav_url(self, source_url):
+        # type: (str) -> ClientResult[str]
         """
         Gets the trusted URL for opening the folder in Explorer view.
-
         :param str source_url: The URL of the current folder the user is in.
-        :return: ClientResult
         """
 
         return_type = ClientResult(self.context, str())
@@ -476,10 +469,8 @@ class List(SecurableObject):
         return return_type
 
     def get_items(self, caml_query=None):
-        """Returns a collection of items from the list based on the specified query.
-
-        :type caml_query: CamlQuery
-        """
+        # type: (CamlQuery) -> ListItemCollection
+        """Returns a collection of items from the list based on the specified query."""
         if not caml_query:
             caml_query = CamlQuery.create_all_items_query()
         return_type = ListItemCollection(self.context, self.items.resource_path)
@@ -585,14 +576,29 @@ class List(SecurableObject):
         return return_type
 
     def get_item_by_id(self, item_id):
-        """Returns the list item with the specified list item identifier.
-        :type item_id: int
-        """
+        # type: (int) -> ListItem
+        """Returns the list item with the specified list item identifier."""
         return ListItem(
             self.context,
             ServiceOperationPath("getItemById", [item_id], self.resource_path),
         )
 
+    def get_item_by_url(self, url):
+        # type: (str) -> ListItem
+        """Returns the list item with the specified site or server relative url."""
+        return_type = ListItem(self.context)
+        self.items.add_child(return_type)
+
+        def _after_loaded(item):
+            [return_type.set_property(k, v, False) for k, v in item.properties.items()]
+
+        def _get_item_by_url():
+            path = os.path.join(self.root_folder.serverRelativeUrl, url)
+            self.items.get_by_url(path).after_execute(_after_loaded, execute_first=True)
+
+        self.ensure_property("RootFolder", _get_item_by_url)
+        return return_type
+
     def get_view(self, view_id):
         """Returns the list view with the specified view identifier.
         :type view_id: str
@@ -629,10 +635,9 @@ class List(SecurableObject):
         return return_type
 
     def reserve_list_item_id(self):
-        """
-        Reserves the returned list item identifier for the idempotent creation of a list item.
-        """
-        return_type = ClientResult(self.context, int())  # type: ClientResult[int]
+        # type: () -> ClientResult[int]
+        """Reserves the returned list item identifier for the idempotent creation of a list item."""
+        return_type = ClientResult(self.context, int())
         qry = ServiceOperationQuery(
             self, "ReserveListItemId", None, None, None, return_type
         )
@@ -672,8 +677,7 @@ class List(SecurableObject):
     @property
     def id(self):
         # type: () -> Optional[str]
-        """
-        Gets a value that specifies the list identifier."""
+        """Gets a value that specifies the list identifier."""
         return self.properties.get("Id", None)
 
     @property
@@ -691,25 +695,19 @@ class List(SecurableObject):
     @property
     def allow_content_types(self):
         # type: () -> Optional[bool]
-        """
-        Specifies whether the list supports content types.
-        """
+        """Specifies whether the list supports content types."""
         return self.properties.get("AllowContentTypes", None)
 
     @property
     def allow_deletion(self):
         # type: () -> Optional[bool]
-        """
-        Specifies whether the list could be deleted.
-        """
+        """Specifies whether the list could be deleted."""
         return self.properties.get("AllowDeletion", None)
 
     @property
     def base_template(self):
         # type: () -> Optional[int]
-        """
-        Specifies the list server template of the list.
-        """
+        """Specifies the list server template of the list."""
         return self.properties.get("BaseTemplate", None)
 
     @property
@@ -740,16 +738,12 @@ class List(SecurableObject):
     @property
     def default_display_form_url(self):
         # type: () -> Optional[str]
-        """
-        Specifies the location of the default display form for the list.
-        """
+        """Specifies the location of the default display form for the list."""
         return self.properties.get("DefaultDisplayFormUrl", None)
 
     @property
     def default_view_path(self):
-        """
-        Specifies the server-relative URL of the default view for the list.
-        """
+        """Specifies the server-relative URL of the default view for the list."""
         return self.properties.get("DefaultViewPath", SPResPath())
 
     @property
@@ -803,9 +797,7 @@ class List(SecurableObject):
     @property
     def default_edit_form_url(self):
         # type: () -> Optional[str]
-        """
-        Gets a value that specifies the URL of the edit form to use for list items in the list.
-        """
+        """Gets a value that specifies the URL of the edit form to use for list items in the list."""
         return self.properties.get("DefaultEditFormUrl", None)
 
     @property
@@ -871,9 +863,7 @@ class List(SecurableObject):
     @property
     def enable_folder_creation(self):
         # type: () -> Optional[bool]
-        """
-        Specifies whether new list folders can be added to the list.
-        """
+        """Specifies whether new list folders can be added to the list."""
         return self.properties.get("EnableFolderCreation", None)
 
     @enable_folder_creation.setter
@@ -884,17 +874,13 @@ class List(SecurableObject):
     @property
     def enable_minor_versions(self):
         # type: () -> Optional[bool]
-        """
-        Specifies whether minor versions are enabled for the list.
-        """
+        """Specifies whether minor versions are enabled for the list."""
         return self.properties.get("EnableMinorVersions", None)
 
     @property
     def enable_moderation(self):
         # type: () -> Optional[bool]
-        """
-        Specifies whether content approval is enabled for the list.
-        """
+        """Specifies whether content approval is enabled for the list."""
         return self.properties.get("EnableModeration", None)
 
     @property
@@ -905,9 +891,7 @@ class List(SecurableObject):
     @property
     def enable_versioning(self):
         # type: () -> Optional[bool]
-        """
-        Specifies whether content approval is enabled for the list.
-        """
+        """Specifies whether content approval is enabled for the list."""
         return self.properties.get("EnableVersioning", None)
 
     @property

office365/sharepoint/portal/groups/service.py

@@ -1,40 +1,36 @@
 import random
+from typing import AnyStr
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.http.http_method import HttpMethod
+from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
 class GroupService(Entity):
-    def __init__(self, context, resource_path=None):
-        super(GroupService, self).__init__(context, resource_path)
-
-    def get_group_image(self, group_id, image_hash=None, image_color=None):
-        """
-        :param str group_id:
-        :param int or None image_hash:
-        :param str or None image_color:
-        """
-        return_type = ClientResult(self.context)
+    def get_group_image(
+        self, group_id, image_hash=None, image_color=None, return_type=None
+    ):
+        # type: (str, str, str, ClientResult) -> ClientResult[AnyStr]
+        if return_type is None:
+            return_type = ClientResult(self.context)
         if image_hash is None:
             image_hash = random.getrandbits(64)
         qry = ServiceOperationQuery(
             self, "GetGroupImage", None, None, None, return_type
         )
 
-        def _modify_request(request):
-            """
-            :type request: office365.runtime.http.request_options.RequestOptions
-            """
+        def _create_request(request):
+            # type: (RequestOptions) -> None
             request.url += "?id='{0}'&hash={1}".format(group_id, image_hash)
             request.method = HttpMethod.Get
 
-        self.context.before_execute(_modify_request)
-        self.context.add_query(qry)
+        self.context.add_query(qry).before_execute(_create_request)
         return return_type
 
     def sync_group_properties(self):
+        """ """
         qry = ServiceOperationQuery(self, "SyncGroupProperties")
         self.context.add_query(qry)
         return self

office365/sharepoint/portal/groups/site_manager.py

@@ -120,7 +120,6 @@ class GroupSiteManager(ClientObject):
     ):
         """
         Get the teams in Microsoft Teams that the current user is a direct member of.
-
         :type get_logo_data: bool
         :type force_cache_update: bool
         """

office365/sharepoint/publishing/pages/metadata.py

@@ -15,6 +15,9 @@ if TYPE_CHECKING:
 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):
         # type: () -> Optional[str]
@@ -128,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

@@ -12,7 +12,6 @@ class SitePageMetadataCollection(EntityCollection[T]):
 
     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

@@ -216,16 +216,13 @@ class SitePage(SitePageMetadata):
     @property
     def layout_web_parts_content(self):
         # type: () -> Optional[str]
-        """
-        Gets the LayoutWebPartsContent field for the current Site Page.
-        """
+        """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.
-        """
+        # type: (str) -> None
+        """Sets the LayoutWebPartsContent field for the current Site Page."""
         self.set_property("LayoutWebpartsContent", value)
 
     @property

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/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/sharing/links/share_response.py

@@ -13,6 +13,9 @@ class ShareLinkResponse(ClientValue):
         """
         self.sharingLinkInfo = sharing_link_info
 
+    def __str__(self):
+        return self.sharingLinkInfo.Url
+
     @property
     def entity_type_name(self):
         return "SP.Sharing.ShareLinkResponse"

office365/sharepoint/sharing/result.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
@@ -13,63 +15,48 @@ class SharingResult(Entity):
 
     @property
     def url(self):
-        """Gets the URL of the securable object being shared.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the URL of the securable object being shared."""
         return self.properties.get("Url", None)
 
     @property
     def error_message(self):
-        """Gets an error message about the failure if sharing was unsuccessful.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets an error message about the failure if sharing was unsuccessful."""
         return self.properties.get("ErrorMessage", None)
 
     @property
     def name(self):
-        """
-        Gets the name of the securable object being shared.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the name of the securable object being shared."""
         return self.properties.get("Name", None)
 
     @property
     def icon_url(self):
-        """
-        Gets a URL to an icon that represents the securable object, if one exists.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets a URL to an icon that represents the securable object, if one exists."""
         return self.properties.get("IconUrl", None)
 
     @property
     def status_code(self):
+        # type: () -> Optional[int]
         """
         Gets the enumeration value which summarizes the result of the sharing operation.
-
-        :rtype: int or None
         """
         return self.properties.get("StatusCode", None)
 
     @property
     def permissions_page_relative_url(self):
-        """
-        Gets the relative URL of the page that shows permissions.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets the relative URL of the page that shows permissions."""
         return self.properties.get("PermissionsPageRelativeUrl", None)
 
     @property
     def invited_users(self):
+        # type: () ->  ClientValueCollection[SPInvitationCreationResult]
         """
         Gets a list of SPInvitationCreationResult (section 3.2.5.325) objects representing the external users being
         invited to have access.
-
-        :rtype: ClientValueCollection
         """
         return self.properties.get(
             "InvitedUsers", ClientValueCollection(SPInvitationCreationResult)
@@ -77,20 +64,13 @@ class SharingResult(Entity):
 
     @property
     def uniquely_permissioned_users(self):
-        """
-
-        :rtype: ClientValueCollection
-        """
+        # type: () ->  ClientValueCollection[UserSharingResult]
         return self.properties.get(
             "UniquelyPermissionedUsers", ClientValueCollection(UserSharingResult)
         )
 
     @property
     def groups_shared_with(self):
-        """
-
-        :rtype: ClientValueCollection
-        """
         return self.properties.get(
             "GroupsSharedWith",
             GroupCollection(
@@ -100,11 +80,8 @@ class SharingResult(Entity):
 
     @property
     def users_added_to_group(self):
-        """
-        Gets the list of users being added to the SharePoint permissions group.
-
-        :rtype: ClientValueCollection
-        """
+        # type: () ->  ClientValueCollection[UserSharingResult]
+        """Gets the list of users being added to the SharePoint permissions group."""
         return self.properties.get(
             "UsersAddedToGroup", ClientValueCollection(UserSharingResult)
         )
@@ -124,5 +101,5 @@ class SharingResult(Entity):
         if self._resource_path is None:
             if name == "Name":
                 pass
-                # self._resource_path = ResourcePath(value, self._parent_collection.resource_path)
+                # self._resource_path = ResourcePath(value, self.parent_collection.resource_path)
         return self