Merge pull request #292 from beliaev-maksim/beliaev_create_folders

added possibility to create folder tree + example + fix

Author: vgrem

examples/sharepoint/folders/create_folders.py

@@ -0,0 +1,23 @@
+from settings import settings
+
+from office365.runtime.auth.user_credential import UserCredential
+from office365.sharepoint.client_context import ClientContext
+
+credentials = UserCredential(settings['user_credentials']['username'],
+                             settings['user_credentials']['password'])
+ctx = ClientContext(settings['url']).with_credentials(credentials)
+
+# create one folder only
+target_folder = "/Shared Documents/test_folder"
+target_folder = ctx.web.get_folder_by_server_relative_url(target_folder)
+target_folder.add("new_folder")
+ctx.execute_query()  # have to execute
+
+# create relative folder tree, no execution required
+target_folder = "/Shared Documents/test_folder/20201116/1133/test"
+target_folder = ctx.web.ensure_folder_path(target_folder)
+
+
+
+
+

office365/sharepoint/webs/web.py

@@ -1,3 +1,5 @@
+import os
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.queries.client_query import ClientQuery
@@ -189,11 +191,33 @@ def get_folder_by_server_relative_url(self, url):
         """Returns the folder object located at the specified server-relative URL.
         :type url: str
         """
+        if url.startswith("/"):
+            url = url[1:]
+
         return Folder(
             self.context,
             ResourcePathServiceOperation("getFolderByServerRelativeUrl", [url], self.resource_path)
         )
 
+    def ensure_folder_path(self, path):
+        """
+            Function to create folder tree
+            :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
+
     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
         not already exist, adds it to the website.