SharePoint API (list & portal namespace) improvements and bug fixes

Author: vgrem

examples/sharepoint/lists/get_data_as_stream.py

@@ -1,6 +1,7 @@
 """
 Returns a SharePoint List data
 """
+
 from office365.sharepoint.client_context import ClientContext
 from tests import test_client_credentials, test_team_site_url
 
@@ -22,7 +23,7 @@
 """
 
 
-result = (
-    ctx.web.get_list_data_as_stream("/Shared Documents", view_xml=view_xml).execute_query()
-)
+result = ctx.web.get_list_data_as_stream(
+    "/Shared Documents", view_xml=view_xml
+).execute_query()
 print(result.value)

examples/sharepoint/tenant/export_tenant_settings.py

@@ -1,11 +1,14 @@
 """ """
+
 from office365.sharepoint.client_context import ClientContext
 from tests import test_admin_credentials, test_admin_site_url
 
 admin_client = ClientContext(test_admin_site_url).with_credentials(
     test_admin_credentials
 )
-result = admin_client.tenant.export_to_csv(view_xml="<View/>", list_name="Style Library").execute_query()
+result = admin_client.tenant.export_to_csv(
+    view_xml="<View/>", list_name="Style Library"
+).execute_query()
 print(
     "Sites details have been exported into {0}{1}".format(
         test_admin_site_url, result.value

office365/runtime/csom/request.py

@@ -0,0 +1,11 @@
+from office365.runtime.client_request import ClientRequest
+
+
+class CsomRequest(ClientRequest):
+    """"""
+
+    def process_response(self, response, query):
+        pass
+
+    def build_request(self, query):
+        pass

office365/sharepoint/documentmanagement/document_id.py

@@ -31,22 +31,47 @@ def reset_docid_by_server_relative_path(self, decoded_url):
         self.context.add_query(qry)
         return self
 
-    def reset_docids_in_library(self, decoded_url, content_type_id):
+    def reset_doc_ids_in_library(self, decoded_url, content_type_id=None):
         """
         Performs the same function as ResetDocIdByServerRelativePath (section 3.1.5.10.2.1.1), but for every
         document in the specified document library.
 
         :param str decoded_url: Server relative path to the document library, for which all document identifiers
             MUST be reset to guarantee global uniqueness in the farm.
-        :param str content_type_id: The content type identifier.
+        :param str or None content_type_id: The content type identifier.
         """
-        payload = {"DecodedUrl": decoded_url, "contentTypeId": content_type_id}
+        payload = {"decodedUrl": decoded_url, "contentTypeId": content_type_id}
         qry = ServiceOperationQuery(
             self, "ResetDocIdsInLibrary", None, payload, None, None
         )
         self.context.add_query(qry)
         return self
 
+    def set_doc_id_site_prefix(
+        self, prefix, schedule_assignment, overwrite_existing_ids
+    ):
+        """
+        Allows to set or change the prefix used for Document IDs
+
+        :param str prefix:
+        :param bool schedule_assignment:
+        :param bool overwrite_existing_ids:
+        """
+        payload = {
+            "prefix": prefix,
+            "scheduleAssignment": schedule_assignment,
+            "overwriteExistingIds": overwrite_existing_ids,
+        }
+        qry = ServiceOperationQuery(
+            self, "SetDocIdSitePrefix", None, payload, None, None
+        )
+        self.context.add_query(qry)
+        return self
+
     @property
     def entity_type_name(self):
         return "SP.DocumentManagement.DocumentId"
+
+    @property
+    def entity_type_id(self):
+        return "fb7276a2-cd36-448b-8a60-a589205f5a8f"

office365/sharepoint/files/versions/event.py

@@ -32,3 +32,12 @@ def shared_with_users(self):
         return self.properties.get(
             "SharedWithUsers", ClientValueCollection(SharedWithUser)
         )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "SharedByUser": self.shared_by_user,
+                "SharedWithUsers": self.shared_with_users,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(FileVersionEvent, self).get_property(name, default_value)

office365/sharepoint/listitems/listitem.py

@@ -14,6 +14,7 @@
 from office365.sharepoint.fields.lookup_value import FieldLookupValue
 from office365.sharepoint.fields.multi_lookup_value import FieldMultiLookupValue
 from office365.sharepoint.fields.string_values import FieldStringValues
+from office365.sharepoint.fields.url_value import FieldUrlValue
 from office365.sharepoint.likes.liked_by_information import LikedByInformation
 from office365.sharepoint.listitems.compliance_info import ListItemComplianceInfo
 from office365.sharepoint.listitems.form_update_value import ListItemFormUpdateValue
@@ -507,12 +508,25 @@ def versions(self):
             ),
         )
 
+    @property
+    def doc_id(self):
+        # type: () -> Optional[str]
+        """Document ID fora document"""
+        return self.properties.get("OData__dlc_DocId", None)
+
+    @property
+    def doc_id_url(self):
+        # type: () -> Optional[FieldUrlValue]
+        """Document ID fora document"""
+        return self.properties.get("OData__dlc_DocIdUrl", FieldUrlValue())
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
                 "AttachmentFiles": self.attachment_files,
                 "ContentType": self.content_type,
                 "ComplianceInfo": self.compliance_info,
+                "OData__dlc_DocIdUrl": self.doc_id_url,
                 "EffectiveBasePermissions": self.effective_base_permissions,
                 "GetDlpPolicyTip": self.get_dlp_policy_tip,
                 "FieldValuesAsHtml": self.field_values_as_html,

office365/sharepoint/lists/exporter.py

@@ -0,0 +1,73 @@
+import json
+from typing import IO, AnyStr, Callable
+
+from typing_extensions import Self
+
+from office365.runtime.client_result import ClientResult
+from office365.sharepoint.files.system_object_type import FileSystemObjectType
+from office365.sharepoint.listitems.collection import ListItemCollection
+from office365.sharepoint.listitems.listitem import ListItem
+from office365.sharepoint.lists.list import List
+
+
+class ListExporter(object):
+
+    @staticmethod
+    def export(
+        source_list, destination_file, include_content=False, item_exported=None
+    ):
+        # type: (List, IO, bool, Callable[[ListItem], None]) -> Self
+        """Exports SharePoint List"""
+        import zipfile
+
+        def _append_file(name, data):
+            with zipfile.ZipFile(
+                destination_file.name, "a", zipfile.ZIP_DEFLATED
+            ) as zf:
+                zf.writestr(name, data)
+
+        def _download_content(list_item):
+            # type: (ListItem) -> None
+            def _after_downloaded(result):
+                # type: (ClientResult[AnyStr]) -> None
+                item_path = list_item.properties["FileRef"].replace(
+                    source_list.root_folder.serverRelativeUrl, ""
+                )
+                _append_file(item_path, result.value)
+
+            list_item.file.get_content().after_execute(_after_downloaded)
+
+        def _export_items(items):
+            # type: (ListItemCollection) -> None
+
+            for item in items:
+                item_path = str(item.id) + ".json"
+
+                if item.file_system_object_type == FileSystemObjectType.File:
+                    _append_file(item_path, json.dumps(item.to_json()))
+
+                    if include_content:
+                        _download_content(item)
+
+                    if callable(item_exported):
+                        item_exported(item)
+
+        def _get_items():
+            (
+                source_list.items.select(
+                    [
+                        "*",
+                        "Id",
+                        "FileRef",
+                        "FileDirRef",
+                        "FileLeafRef",
+                        "FileSystemObjectType",
+                    ]
+                )
+                .get()
+                .paged(page_loaded=_export_items)
+            )
+
+        source_list.ensure_properties(["SchemaXml", "RootFolder"], _get_items)
+
+        return source_list