Minor refactoring for ensure_folder_path method (#292) SharePoint API batch fixes

Author: vvgrem@gmail.com

examples/sharepoint/webs/__init__.py

@@ -1,9 +1,7 @@
 import uuid
 
 from office365.runtime.queries.client_query import ClientQuery
-from office365.runtime.queries.create_entity_query import CreateEntityQuery
 from office365.runtime.queries.read_entity_query import ReadEntityQuery
-from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 
 
 def create_boundary(prefix, compact=False):
@@ -41,10 +39,13 @@ def add(self, query):
         self._queries.append(query)
 
     def get(self, index):
-        result = [qry for qry in self._queries
-                  if isinstance(qry, ReadEntityQuery)
-                  or isinstance(qry, CreateEntityQuery)
-                  or isinstance(qry, ServiceOperationQuery)]
+        result = [qry for qry in self.change_sets if qry.return_type is not None] + \
+                 [qry for qry in self._queries if isinstance(qry, ReadEntityQuery)]
+
+        # result = [qry for qry in self._queries
+        #          if isinstance(qry, ReadEntityQuery)
+        #          or isinstance(qry, CreateEntityQuery)
+        #          or isinstance(qry, ServiceOperationQuery)]
         return result[index]
 
     @property

generator/metadata/SharePoint.xml

@@ -1,3 +1,5 @@
+import os
+
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.queries.create_entity_query import CreateEntityQuery
 from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
@@ -15,6 +17,22 @@ def get(self):
         """
         return super(FolderCollection, self).get()
 
+    def ensure_folder_path(self, path):
+        """
+        Function to create a folder
+        :type path: string
+        :param path: relative server URL (path) to a folder
+        """
+
+        url_component = os.path.normpath(path).split(os.path.sep)
+        url_component = [part for part in url_component if part]  # ensure no empty elements
+        if not url_component:
+            raise NotADirectoryError("Wrong relative URL provided")
+        child_folder = self
+        for url_part in url_component:
+            child_folder = child_folder.add(url_part)
+        return child_folder
+
     def add(self, server_relative_url):
         """Adds the folder that is located at the specified URL to the collection.
 

office365/runtime/queries/batch_query.py

@@ -20,7 +20,7 @@ def __init__(self, context):
 
     def get_site_secondary_administrators(self, site_id):
         """
-        Returns the current site collection administrators
+        Gets site collection administrators
 
         :type site_id: str
         """
@@ -31,6 +31,20 @@ def get_site_secondary_administrators(self, site_id):
         self.context.add_query(qry)
         return return_type
 
+    def set_site_secondary_administrators(self, site_id, emails, names):
+        """
+        Sets site collection administrators
+
+        :type names: list[str]
+        :type emails: list[str]
+        :type site_id: str
+        """
+        payload = SecondaryAdministratorsFieldsData(emails, names, site_id)
+        qry = ServiceOperationQuery(self, "SetSiteSecondaryAdministrators", None, payload,
+                                    "secondaryAdministratorsFieldsData", None)
+        self.context.add_query(qry)
+        return self
+
     def register_hub_site(self, site_url):
         """
         Registers an existing site as a hub site.
@@ -84,13 +98,6 @@ def remove_deleted_site(self, site_url):
     def restore_deleted_site(self, site_url):
         pass
 
-    def set_site_secondary_administrators(self, data):
-        """
-
-        :type data: SecondaryAdministratorsFieldsData
-        """
-        pass
-
     def get_site_properties_by_url(self, url, include_detail):
         """
 

office365/sharepoint/folders/folder_collection.py

@@ -208,18 +208,7 @@ def ensure_folder_path(self, path):
             :type path: string
             :param path: relative server URL (path) to a folder
         """
-
-        url_component = os.path.normpath(path).split(os.path.sep)
-        url_component = [part for part in url_component if part]  # ensure no empty elements
-        if not url_component:
-            raise NotADirectoryError("Wrong relative URL provided")
-
-        folder = self.get_folder_by_server_relative_url(url_component[0])
-        for url_part in url_component[1:]:
-            folder = folder.add(url_part)
-
-        self.context.execute_query()  # need to execute now, otherwise folders are created in "after_execute_query"
-        return folder
+        return self.root_folder.folders.ensure_folder_path(path)
 
     def ensure_user(self, login_name):
         """Checks whether the specified logon name belongs to a valid user of the website, and if the logon name does
@@ -679,6 +668,11 @@ def recycleBin(self):
                                    RecycleBinItemCollection(self.context,
                                                             ResourcePath("RecycleBin", self.resource_path)))
 
+    @property
+    def root_folder(self):
+        """Get a root folder"""
+        return self.properties.get("RootFolder", Folder(self.context, ResourcePath("RootFolder", self.resource_path)))
+
     def set_property(self, name, value, persist_changes=True):
         super(Web, self).set_property(name, value, persist_changes)
         # fallback: create a new resource path

office365/sharepoint/tenant/administration/tenant.py

@@ -48,7 +48,14 @@ def test4_get_site_secondary_administrators(self):
         self.client.execute_query()
         self.assertIsNotNone(result)
 
-    # def test5_create_site(self):
+    # def test5_set_site_secondary_administrators(self):
+    #    target_site = self.client.site.get()
+    #    target_user = self.client.web.ensure_user("jdoe@mediadev8.onmicrosoft.com")
+    #    self.client.execute_batch()
+    #    self.tenant.set_site_secondary_administrators(target_site.id, [target_user.login_name],[target_user.login_name])
+    #    self.client.execute_query()
+
+    # def test6_create_site(self):
     #    current_user = self.client.web.currentUser
     #    self.client.load(current_user)
     #    self.client.execute_query()
@@ -58,20 +65,20 @@ def test4_get_site_secondary_administrators(self):
     #    self.client.execute_query()
     #    self.assertIsNotNone(site_props)
 
-    # def test6_get_site_by_url(self):
+    # def test7_get_site_by_url(self):
     #    site_props = self.tenant.get_site_properties_by_url(self.__class__.target_site_url, False)
     #    self.client.execute_query()
     #    self.assertIsNotNone(site_props.properties['SiteUrl'], self.__class__.target_site_url)
     #    self.__class__.target_site_props = site_props
 
-    # def test7_update_site(self):
+    # def test8_update_site(self):
     #    site_props_to_update = self.__class__.target_site_props
     #    site_props_to_update.set_property('SharingCapability', SharingCapabilities.ExternalUserAndGuestSharing)
     #    site_props_to_update.update()
     #    self.client.execute_query()
     #    self.assertTrue(site_props_to_update.properties['Status'], 'Active')
 
-    # def test8_delete_site(self):
+    # def test9_delete_site(self):
     #    site_url = self.__class__.target_site_props.properties['SiteUrl']
     #    self.tenant.remove_site(site_url)
     #    self.client.execute_query()

office365/sharepoint/webs/web.py

@@ -128,3 +128,10 @@ def test_18_get_list_templates(self):
     def test_19_get_custom_list_templates(self):
         templates = self.client.web.get_custom_list_templates().execute_query()
         self.assertGreaterEqual(len(templates), 0)
+
+    def test20_ensure_folder_path(self):
+        folder_path = "/Shared Documents/Archive/2020/12"
+        folder_new_nested = self.client.web.ensure_folder_path(folder_path).execute_query()
+        folder_new_nested = self.client.web.get_folder_by_server_relative_url(folder_path).get().execute_query()
+        self.assertTrue(folder_new_nested.properties["Exists"])
+