SharePoint API: better support for addressing resources by resource path, unit test fix to wait until Team create operation is completed

Author: [email protected]

examples/sharepoint/folders/copy_folder.py

@@ -3,11 +3,11 @@
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_user_credentials)
 
-source_folder_url = "/sites/team/Shared Documents/Archive"
-target_folder_url = "/sites/team/Shared Documents/Archive2012"
+source_folder_url = "/sites/team/Shared Documents/Archive2012"
+target_folder_url = "/sites/team/Shared Documents/Archive2013"
 
 
 source_folder = ctx.web.get_folder_by_server_relative_url(source_folder_url)
-target_folder = source_folder.copy_to(target_folder_url).get().execute_query()
-print(f"File copied into {target_folder.serverRelativeUrl}")
+target_folder = source_folder.move_to_by_path(target_folder_url).get().execute_query()
+print(f"File copied into {target_folder.server_relative_path.DecodedUrl}")
 

office365/runtime/client_object.py

@@ -100,9 +100,12 @@ def set_property(self, name, value, persist_changes=True):
         if isinstance(prop_type, ClientObject) or isinstance(prop_type, ClientValue) and value is not None:
             if isinstance(value, list):
                 [prop_type.set_property(i, v, persist_changes) for i, v in enumerate(value)]
-            else:
+                self._properties[name] = prop_type
+            elif isinstance(value, dict):
                 [prop_type.set_property(k, v, persist_changes) for k, v in value.items()]
-            self._properties[name] = prop_type
+                self._properties[name] = prop_type
+            else:
+                self._properties[name] = value
         else:
             self._properties[name] = value
         return self

office365/sharepoint/files/file.py

@@ -10,6 +10,7 @@
 from office365.sharepoint.files.file_version_collection import FileVersionCollection
 from office365.sharepoint.listitems.listitem import ListItem
 from office365.sharepoint.webparts.limited_webpart_manager import LimitedWebPartManager
+from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
 
 class AbstractFile(BaseEntity):
@@ -369,6 +370,13 @@ def serverRelativeUrl(self):
         """
         return self.properties.get("ServerRelativeUrl", None)
 
+    @property
+    def server_relative_path(self):
+        """Gets the server-relative Path of the list folder.
+        :rtype: SPResPath or None
+        """
+        return self.properties.get("ServerRelativePath", SPResPath(None))
+
     @property
     def length(self):
         """Gets the file size.
@@ -471,6 +479,9 @@ def set_property(self, name, value, persist_changes=True):
             if name == "ServerRelativeUrl":
                 self._resource_path = ResourcePathServiceOperation(
                     "GetFileByServerRelativeUrl", [value], ResourcePath("Web"))
+            elif name == "ServerRelativePath":
+                self._resource_path = ResourcePathServiceOperation("getFolderByServerRelativePath", [value],
+                                                                   ResourcePath("Web"))
             elif name == "UniqueId":
                 self._resource_path = ResourcePathServiceOperation(
                     "GetFileById", [value], ResourcePath("Web"))

office365/sharepoint/folders/folder.py

@@ -15,6 +15,7 @@
 from office365.sharepoint.storagemetrics.storage_metrics import StorageMetrics
 from office365.sharepoint.utilities.move_copy_options import MoveCopyOptions
 from office365.sharepoint.utilities.move_copy_util import MoveCopyUtil
+from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
 
 class Folder(BaseEntity):
@@ -128,9 +129,29 @@ def _copy_folder():
             opts = MoveCopyOptions(keep_both=keep_both, reset_author_and_created_on_copy=reset_author_and_created)
             MoveCopyUtil.copy_folder(self.context, self._build_full_url(self.serverRelativeUrl),
                                      self._build_full_url(new_relative_url), opts)
+
         self.ensure_property("ServerRelativeUrl", _copy_folder)
         return target_folder
 
+    def copy_to_by_path(self, new_relative_path, keep_both=False, reset_author_and_created=False):
+        """Copies the folder with files to the destination Path.
+
+        :type new_relative_path: str
+        :type keep_both: bool
+        :type reset_author_and_created: bool
+        """
+
+        target_folder = Folder(self.context)
+        target_folder.set_property("ServerRelativePath", SPResPath(new_relative_path))
+
+        def _copy_folder():
+            opts = MoveCopyOptions(keep_both=keep_both, reset_author_and_created_on_copy=reset_author_and_created)
+            MoveCopyUtil.copy_folder_by_path(self.context, self._build_full_url(self.server_relative_path.DecodedUrl),
+                                             self._build_full_url(new_relative_path), opts)
+
+        self.ensure_property("ServerRelativePath", _copy_folder)
+        return target_folder
+
     def move_to(self, new_relative_url, retain_editor_and_modified=False):
         """Moves the folder with files to the destination URL.
 
@@ -148,6 +169,24 @@ def _move_folder():
         self.ensure_property("ServerRelativeUrl", _move_folder)
         return target_folder
 
+    def move_to_by_path(self, new_relative_path, retain_editor_and_modified=False):
+        """Moves the folder with files to the destination Path.
+
+        :type new_relative_path: str
+        :type retain_editor_and_modified: bool
+        """
+        target_folder = Folder(self.context)
+        target_folder.set_property("ServerRelativePath", SPResPath(new_relative_path))
+
+        def _move_folder():
+            MoveCopyUtil.move_folder_by_path(self.context, self._build_full_url(self.server_relative_path.DecodedUrl),
+                                             self._build_full_url(new_relative_path),
+                                             MoveCopyOptions(
+                                                 retain_editor_and_modified_on_move=retain_editor_and_modified))
+
+        self.ensure_property("ServerRelativePath", _move_folder)
+        return target_folder
+
     @property
     def storage_metrics(self):
         return self.properties.get("StorageMetrics",
@@ -162,11 +201,9 @@ def list_item_all_fields(self):
     @property
     def files(self):
         """Get a file collection"""
-        if self.is_property_available('Files'):
-            return self.properties["Files"]
-        else:
-            from office365.sharepoint.files.file_collection import FileCollection
-            return FileCollection(self.context, ResourcePath("Files", self.resource_path))
+        from office365.sharepoint.files.file_collection import FileCollection
+        return self.properties.get("Files",
+                                   FileCollection(self.context, ResourcePath("Files", self.resource_path)))
 
     @property
     def folders(self):
@@ -242,10 +279,18 @@ def serverRelativeUrl(self):
         """
         return self.properties.get("ServerRelativeUrl", None)
 
+    @property
+    def server_relative_path(self):
+        """Gets the server-relative Path of the list folder.
+        :rtype: SPResPath or None
+        """
+        return self.properties.get("ServerRelativePath", SPResPath(None))
+
     def get_property(self, name):
         property_mapping = {
             "ListItemAllFields": self.list_item_all_fields,
-            "ParentFolder": self.parent_folder
+            "ParentFolder": self.parent_folder,
+            "ServerRelativePath": self.server_relative_path
         }
         if name in property_mapping:
             return property_mapping[name]
@@ -258,6 +303,9 @@ def set_property(self, name, value, persist_changes=True):
         if name == "ServerRelativeUrl":
             self._resource_path = ResourcePathServiceOperation("getFolderByServerRelativeUrl", [value],
                                                                ResourcePath("Web"))
+        elif name == "ServerRelativePath":
+            self._resource_path = ResourcePathServiceOperation("getFolderByServerRelativePath", [value],
+                                                               ResourcePath("Web"))
         elif name == "UniqueId":
             self._resource_path = ResourcePathServiceOperation("getFolderById", [value], ResourcePath("Web"))
         return self

office365/sharepoint/sites/site.py

@@ -12,6 +12,7 @@
 from office365.sharepoint.sites.sph_site import SPHSite
 from office365.sharepoint.webs.web import Web
 from office365.sharepoint.webs.web_template_collection import WebTemplateCollection
+from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
 
 class Site(BaseEntity):
@@ -190,6 +191,13 @@ def is_hub_site(self):
         """
         return self.properties.get("IsHubSite", None)
 
+    @property
+    def server_relative_path(self):
+        """Gets the server-relative Path of the Site.
+        :rtype: SPResPath or None
+        """
+        return self.properties.get("ServerRelativePath", SPResPath(None))
+
     @property
     def recycle_bin(self):
         """Get recycle bin"""

office365/sharepoint/types/resource_path.py

@@ -6,3 +6,10 @@ class ResourcePath(ClientValue):
     def __init__(self, decoded_url):
         super().__init__()
         self.DecodedUrl = decoded_url
+
+    @property
+    def entity_type_name(self):
+        return "SP.ResourcePath"
+
+    def __str__(self):
+        return f"DecodedUrl='{self.DecodedUrl}'"

office365/sharepoint/utilities/move_copy_util.py

@@ -1,6 +1,7 @@
 from office365.runtime.client_result import ClientResult
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
 
 class MoveCopyUtil(BaseEntity):
@@ -26,6 +27,27 @@ def copy_folder(context, srcUrl, destUrl, options):
         context.add_query(qry)
         return result
 
+    @staticmethod
+    def copy_folder_by_path(context, srcPath, destPath, options):
+        """
+
+        :param office365.sharepoint.utilities.move_copy_options.MoveCopyOptions options:
+        :param str srcPath:
+        :param str destPath:
+        :param office365.sharepoint.client_context.ClientContext context: client context
+        """
+        result = ClientResult(context)
+        util = MoveCopyUtil(context)
+        payload = {
+            "srcPath": SPResPath(srcPath),
+            "destPath": SPResPath(destPath),
+            "options": options
+        }
+        qry = ServiceOperationQuery(util, "CopyFolderByPath", None, payload, None, result)
+        qry.static = True
+        context.add_query(qry)
+        return result
+
     @staticmethod
     def move_folder(context, srcUrl, destUrl, options):
         """
@@ -45,3 +67,23 @@ def move_folder(context, srcUrl, destUrl, options):
         qry.static = True
         context.add_query(qry)
         return util
+
+    @staticmethod
+    def move_folder_by_path(context, srcPath, destPath, options):
+        """
+
+        :param office365.sharepoint.utilities.move_copy_options.MoveCopyOptions options:
+        :param str srcPath:
+        :param str destPath:
+        :param office365.sharepoint.client_context.ClientContext context: client context
+        """
+        util = MoveCopyUtil(context)
+        payload = {
+            "srcPath": SPResPath(srcPath),
+            "destPath": SPResPath(destPath),
+            "options": options
+        }
+        qry = ServiceOperationQuery(util, "MoveFolderByPath", None, payload, None, None)
+        qry.static = True
+        context.add_query(qry)
+        return util

office365/sharepoint/views/view.py

@@ -6,6 +6,7 @@
 from office365.sharepoint.contenttypes.content_type_id import ContentTypeId
 from office365.sharepoint.listitems.caml.caml_query import CamlQuery
 from office365.sharepoint.views.view_field_collection import ViewFieldCollection
+from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
 
 class View(BaseEntity):
@@ -110,15 +111,31 @@ def base_view_id(self):
         """Gets a value that specifies the base view identifier of the list view."""
         return self.properties.get('BaseViewId', None)
 
+    @property
+    def server_relative_path(self):
+        """Gets the server-relative Path of the View.
+        :rtype: SPResPath or None
+        """
+        return self.properties.get("ServerRelativePath", SPResPath(None))
+
     def get_property(self, name):
-        if name == "ViewFields":
-            return self.view_fields
-        elif name == "DefaultView":
-            return self.default_view
+        property_mapping = {
+            "ViewFields": self.view_fields,
+            "DefaultView": self.default_view,
+            "ServerRelativePath": self.server_relative_path
+        }
+        if name in property_mapping:
+            return property_mapping[name]
         else:
             return super(View, self).get_property(name)
 
     def set_property(self, name, value, persist_changes=True):
+        """
+
+        :type name: str
+        :type value: any
+        :type persist_changes: bool
+        """
         super(View, self).set_property(name, value, persist_changes)
         # fallback: create a new resource path
         if self._resource_path is None:

office365/sharepoint/webs/web.py

@@ -41,6 +41,7 @@
 from office365.sharepoint.webs.regional_settings import RegionalSettings
 from office365.sharepoint.webs.web_information_collection import WebInformationCollection
 from office365.sharepoint.webs.web_template_collection import WebTemplateCollection
+from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
 
 class Web(SecurableObject):
@@ -849,6 +850,13 @@ def ui_version(self):
         """
         return self.properties.get('UIVersion', None)
 
+    @property
+    def server_relative_path(self):
+        """Gets the server-relative Path of the Web.
+        :rtype: SPResPath or None
+        """
+        return self.properties.get("ServerRelativePath", SPResPath(None))
+
     def get_property(self, name):
         if name == "ContentTypes":
             return self.content_types

setup.py

@@ -10,7 +10,7 @@
 
 setup(
     name="Office365-REST-Python-Client",
-    version="2.3.4",
+    version="2.3.5",
     author="Vadim Gremyachev",
     author_email="[email protected]",
     maintainer="Konrad Gądek, Domenico Di Nicola",