SharePoint API: support for documentset entity (create method)

Author: vvgrem@gmail.com

examples/sharepoint/lists_and_items/read_attachments.py

@@ -1,11 +1,12 @@
 import os
 import tempfile
 
+
 from settings import settings
 
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.sharepoint.client_context import ClientContext
-from office365.sharepoint.listitems.caml import CamlQuery
+from office365.sharepoint.listitems.caml.caml_query import CamlQuery
 
 download_path = tempfile.mkdtemp()
 
@@ -14,7 +15,10 @@
 ctx = ClientContext(settings['url']).with_credentials(client_creds)
 
 list_obj = ctx.web.lists.get_by_title("Tasks123")
-items = list_obj.get_items(CamlQuery.create_all_items_query())
+#items = list_obj.get_items(CamlQuery.create_all_items_query())
+#items = list_obj.get_items()
+items = list_obj.items
+ctx.load(items, ["ID", "UniqueId", "FileRef", "LinkFilename", "Title", "Attachments"])
 ctx.execute_query()
 for item in items:
     if item.properties['Attachments']:  # 1. determine whether ListItem contains attachments
@@ -28,3 +32,4 @@
             with open(download_file_name, 'wb') as fh:
                 content = attachment_file.read()
                 fh.write(content)
+                print(f"{attachment_file.server_relative_url} has been downloaded")

generator/builders/property_builder.py

@@ -0,0 +1,5 @@
+import ast
+
+
+class PropertyBuilder(ast.NodeTransformer):
+    pass

generator/builders/type_builder.py

@@ -19,7 +19,7 @@ def generic_visit(self, node):
     def build(self, schema):
         result = dict(status=None, output_file=None, source_tree=None)
         if schema['state'] == 'attached':
-            result.output_file = schema['file']
+            result["output_file"] = schema['file']
             with open(schema['file']) as f:
                 result["source_tree"] = ast.parse(f.read())
             result["status"] = "updated"

generator/templates/complex_type.py

@@ -2,4 +2,6 @@
 
 
 class ComplexType(ClientValue):
-    pass
+
+    def __init__(self):
+        super().__init__()

office365/onedrive/file_upload.py

@@ -1,9 +1,9 @@
 import os
 
+from office365.actions.upload_content_query import UploadContentQuery
 from office365.onedrive.driveItemUploadableProperties import DriveItemUploadableProperties
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
-from office365.actions.upload_content_query import UploadContentQuery
 
 
 def read_in_chunks(file_object, chunk_size=1024):

office365/sharepoint/documentmanagement/__init__.py

@@ -0,0 +1,32 @@
+from office365.runtime.http.http_method import HttpMethod
+from office365.runtime.http.request_options import RequestOptions
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class DocumentSet(BaseEntity):
+
+    @staticmethod
+    def create(context, parentFolder, name, ctid="0x0120D520"):
+        """Creates a new DocumentSet object.
+
+        :type context: office365.sharepoint.client_context.ClientContext
+        :type parentFolder: office365.sharepoint.folders.folder.Folder
+        :type name: str
+        :type ctid: office365.sharepoint.contenttypes.content_type_id.ContentTypeId
+        """
+        result = DocumentSet(context)
+
+        def _create_doc_set():
+
+            url = r"{0}/_vti_bin/listdata.svc/{1}".format(context.base_url,
+                                                          parentFolder.properties["Name"].replace(" ", ""))
+            request = RequestOptions(url)
+            request.method = HttpMethod.Post
+            folder_url = parentFolder.serverRelativeUrl + '/' + name
+            request.set_header('Slug', '{0}|{1}'.format(folder_url, ctid))
+            response = context.execute_request_direct(request)
+            json = response.json()
+            context.pending_request().map_json(json, result)
+
+        parentFolder.ensure_properties(["ServerRelativeUrl", "Name"], _create_doc_set)
+        return result

office365/sharepoint/documentmanagement/document_set.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_object import ClientObject
+
+
+class SocialRestActor(ClientObject):
+    pass

office365/sharepoint/social/__init__.py

@@ -1,5 +1,17 @@
 from office365.runtime.client_object import ClientObject
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 
 
 class UserProfile(ClientObject):
-    pass
+
+    def create_personal_site_enque(self, isInteractive):
+        """
+        Enqueues creating a personal site for this user, which can be used to share documents, web pages,
+            and other files.
+
+        :type isInteractive: bool
+        """
+        payload = {"isInteractive": isInteractive}
+        qry = ServiceOperationQuery(self, "CreatePersonalSiteEnque", None, payload, None, None)
+        self.context.add_query(qry)
+        return self

office365/sharepoint/social/socialRestActor.py

@@ -1,7 +1,6 @@
 from unittest import TestCase
 
 import adal
-
 from settings import settings
 
 from office365.graph_client import GraphClient

office365/sharepoint/userprofiles/userProfile.py

@@ -0,0 +1,30 @@
+from tests import random_seed
+from tests.sharepoint.sharepoint_case import SPTestCase
+
+from office365.sharepoint.documentmanagement.document_set import DocumentSet
+from office365.sharepoint.lists.list import List
+from office365.sharepoint.lists.list_creation_information import ListCreationInformation
+from office365.sharepoint.lists.list_template_type import ListTemplateType
+
+
+class TestSharePointDocumentSet(SPTestCase):
+    target_lib = None  # type: List
+
+    @classmethod
+    def setUpClass(cls):
+        super(TestSharePointDocumentSet, cls).setUpClass()
+        cls.target_lib = cls.ensure_list(cls.client.web,
+                                         ListCreationInformation(
+                                             "Archive Documents N%s" % random_seed,
+                                             None,
+                                             ListTemplateType.DocumentLibrary))
+
+    @classmethod
+    def tearDownClass(cls):
+        cls.target_lib.delete_object().execute_query()
+
+    def test1_create_document_set(self):
+        name = "DocSet"
+        doc_set = DocumentSet.create(self.client, self.target_lib.rootFolder, name)
+        self.client.execute_query()
+        self.assertEqual(doc_set.properties["Name"], name)

tests/graph_case.py

@@ -1,6 +1,7 @@
-from office365.sharepoint.userprofiles.profileLoader import ProfileLoader
 from tests.sharepoint.sharepoint_case import SPTestCase
 
+from office365.sharepoint.userprofiles.profileLoader import ProfileLoader
+
 
 class TestUserProfile(SPTestCase):
     profile_loader = None  # type: ProfileLoader
@@ -12,3 +13,7 @@ def test1_get_profile_loader(self):
     def test2_get_profile_loader(self):
         user_profile = self.__class__.profile_loader.get_user_profile().execute_query()
         self.assertIsNotNone(user_profile.properties["AccountName"])
+
+    def test3_create_personal_site(self):
+        user_profile = self.__class__.profile_loader.get_user_profile()
+        user_profile.create_personal_site_enque(True).execute_query()

tests/sharepoint/test_document_set.py

@@ -51,7 +51,7 @@ def test5_get_primary_channel(self):
         primary_channel = self.__class__.target_team.primaryChannel.get().execute_query()
         self.assertIsNotNone(primary_channel.resource_path)
 
-    #def test6_get_channel_files_location(self):
+    # def test6_get_channel_files_location(self):
     #    drive_item = self.__class__.target_channel.filesFolder.get().execute_query()
     #    self.assertIsNotNone(drive_item.resource_path)