SharePoint API: Folder methods and types, bug fixes: #256

Author: vvgrem@gmail.com

examples/sharepoint/files/upload_large_file.py

@@ -1,15 +1,10 @@
+import functools
 import os
-
 from settings import settings
 
 from office365.runtime.auth.user_credential import UserCredential
 from office365.sharepoint.client_context import ClientContext
 
-
-def print_upload_progress(offset, total_size):
-    print("Uploaded '{}' bytes from '{}'...[{}%]".format(offset, total_size, round(offset/total_size*100, 2)))
-
-
 credentials = UserCredential(settings['user_credentials']['username'],
                              settings['user_credentials']['password'])
 ctx = ClientContext(settings['url']).with_credentials(credentials)
@@ -19,8 +14,14 @@ def print_upload_progress(offset, total_size):
 size_chunk = 1000000
 local_path = "../../../tests/data/big_buck_bunny.mp4"
 
+
 file_size = os.path.getsize(local_path)
 
+
+def print_upload_progress(offset):
+    print("Uploaded '{}' bytes from '{}'...[{}%]".format(offset, file_size, round(offset / file_size * 100, 2)))
+
+
 if file_size > size_chunk:
     result_file = target_folder.files.create_upload_session(local_path, size_chunk, print_upload_progress)
 else:

examples/sharepoint/tenant/get_site_admin.py renamed to examples/sharepoint/tenant/get_set_site_admin.py

@@ -17,8 +17,8 @@
 admins = tenant.get_site_secondary_administrators(site_id=target_site.id)
 admin_client.execute_query()
 
-#emails = settings.get("test_accounts")
-#tenant.set_site_secondary_administrators(site_id=target_site.id, emails=emails).execute_query()
+emails = settings.get("test_accounts")
+tenant.set_site_secondary_administrators(site_id=target_site.id, emails=emails).execute_query()
 
 for admin in admins:  # type: SecondaryAdministratorsInfo
     print(admin.get_property('loginName'))

office365/runtime/queries/service_operation_query.py

@@ -28,7 +28,7 @@ def build_url(self):
         self.binding_type.query_options.reset()
         if self.static:
             url = self.context.service_root_url() + \
-                          '.'.join([self.binding_type.entity_type_name, method_path.to_url()])
+                  '.'.join([self.binding_type.entity_type_name, method_path.to_url()])
         else:
             url = '/'.join([self.binding_type.resource_url, method_path.to_url()])
         return url

office365/sharepoint/actions/create_file.py

@@ -7,12 +7,9 @@ class CreateFileQuery(ServiceOperationQuery):
     def __init__(self, files, file_creation_information):
         """
 
-        :type file_creation_information: office365.sharepoint.file_creation_information.FileCreationInformation
+        :type file_creation_information: office365.sharepoint.files.file_creation_information.FileCreationInformation
         :type files: FileCollection
         """
-        self._return_type = File(files.context)
-        super().__init__(files, "add", {
-            "overwrite": file_creation_information.overwrite,
-            "url": file_creation_information.url
-        }, file_creation_information.content, None, self._return_type)
+        super().__init__(files, "add", file_creation_information.to_json(), file_creation_information.content, None,
+                         File(files.context))
         files.add_child(self._return_type)

office365/sharepoint/actions/upload_session.py

@@ -31,7 +31,7 @@ def __init__(self, files, source_path, chunk_size, chunk_uploaded, chunk_func_ar
         :type files: office365.sharepoint.files.file_collection.FileCollection
         :type source_path: str
         :type chunk_size: int
-        :type chunk_uploaded: (int)->None
+        :type chunk_uploaded: (int, *)->None
         """
 
         super().__init__(files, _create_empty_file(source_path))

office365/sharepoint/files/file_creation_information.py

@@ -14,6 +14,12 @@ def __init__(self, url=None, overwrite=False, content=None):
         self._overwrite = overwrite
         self._content = content
 
+    def to_json(self):
+        return {
+            "overwrite": self.overwrite,
+            "url": self.url
+        }
+
     @property
     def content(self):
         """Gets the binary content of the file."""

office365/sharepoint/folders/folder.py

@@ -5,9 +5,11 @@
 from office365.runtime.queries.update_entity_query import UpdateEntityQuery
 from office365.runtime.resource_path import ResourcePath
 from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
+from office365.sharepoint.actions.create_file import CreateFileQuery
 from office365.sharepoint.base_entity import BaseEntity
 from office365.sharepoint.changes.change_collection import ChangeCollection
 from office365.sharepoint.changes.change_query import ChangeQuery
+from office365.sharepoint.contenttypes.content_type_id import ContentTypeId
 from office365.sharepoint.files.file_creation_information import FileCreationInformation
 from office365.sharepoint.listitems.listitem import ListItem
 
@@ -68,6 +70,7 @@ def _add_sub_folder():
             new_folder.set_property("ServerRelativeUrl", new_folder_url)
             qry = CreateEntityQuery(self.folders, new_folder, new_folder)
             self.context.add_query(qry)
+
         self.ensure_property("ServerRelativeUrl", _add_sub_folder)
         return new_folder
 
@@ -90,18 +93,17 @@ def delete_object(self):
         self.remove_from_parent_collection()
         return self
 
-    def upload_file(self, name, content):
+    def upload_file(self, file_name, content):
         """Uploads a file into folder
 
-        :type name: str
+        :type file_name: str
         :type content: str
+        :rtype: office365.sharepoint.files.file.File
         """
-        info = FileCreationInformation()
-        info.content = content
-        info.url = name
-        info.overwrite = True
-        target_file = self.files.add(info)
-        return target_file
+        info = FileCreationInformation(url=file_name, overwrite=True, content=content)
+        qry = CreateFileQuery(self.files, info)
+        self.context.add_query(qry)
+        return qry.return_type
 
     def copy_to(self, new_relative_url, overwrite):
         """Copies the folder with files to the destination URL.
@@ -132,16 +134,15 @@ def _move_folder_with_files():
             for file in self.files:
                 new_file_url = "/".join([new_relative_url, file.properties['Name']])
                 file.moveto(new_file_url, flags)
+
         self.ensure_property("Files", _move_folder_with_files)
         return self
 
     @property
     def list_item_all_fields(self):
         """Specifies the list item fields (2) values for the list item corresponding to the folder."""
-        if self.is_property_available('ListItemAllFields'):
-            return self.properties["ListItemAllFields"]
-        else:
-            return ListItem(self.context, ResourcePath("ListItemAllFields", self.resource_path))
+        return self.properties.get("ListItemAllFields",
+                                   ListItem(self.context, ResourcePath("ListItemAllFields", self.resource_path)))
 
     @property
     def files(self):
@@ -152,6 +153,28 @@ def files(self):
             from office365.sharepoint.files.file_collection import FileCollection
             return FileCollection(self.context, ResourcePath("Files", self.resource_path))
 
+    @property
+    def folders(self):
+        """Specifies the collection of list folders contained within the list folder.
+        """
+        from office365.sharepoint.folders.folder_collection import FolderCollection
+        return self.properties.get("Folders",
+                                   FolderCollection(self.context, ResourcePath("Folders", self.resource_path)))
+
+    @property
+    def parent_folder(self):
+        """Specifies the list folder.
+        """
+        return self.properties.get("ParentFolder",
+                                   Folder(self.context, ResourcePath("ParentFolder", self.resource_path)))
+
+    @property
+    def name(self):
+        """Specifies the list folder name.
+        :rtype: str or None
+        """
+        return self.properties.get("Name", None)
+
     @property
     def unique_id(self):
         """Gets the unique ID of the folder.
@@ -181,6 +204,14 @@ def unique_content_type_order(self):
         """
         return self.properties.get("UniqueContentTypeOrder", None)
 
+    @property
+    def content_type_order(self):
+        """Specifies the content type order for the list folder.
+
+        :rtype: office365.sharepoint.contenttypes.content_type_id.ContentTypeId or None
+        """
+        return self.properties.get("ContentTypeOrder", ContentTypeId())
+
     @property
     def time_last_modified(self):
         """Gets the last time this folder or a direct child was modified in UTC.
@@ -196,22 +227,23 @@ def serverRelativeUrl(self):
         """
         return self.properties.get("ServerRelativeUrl", None)
 
-    @property
-    def folders(self):
-        """Get a folder collection"""
-        if self.is_property_available('Folders'):
-            return self.properties["Folders"]
+    def get_property(self, name):
+        property_mapping = {
+            "ListItemAllFields": self.list_item_all_fields,
+            "ParentFolder": self.parent_folder
+        }
+        if name in property_mapping:
+            return property_mapping[name]
         else:
-            from office365.sharepoint.folders.folder_collection import FolderCollection
-            return FolderCollection(self.context, ResourcePath("Folders", self.resource_path))
+            return super(Folder, self).get_property(name)
 
     def set_property(self, name, value, persist_changes=True):
         super(Folder, self).set_property(name, value, persist_changes)
         # fallback: create a new resource path
-        if self._resource_path is None:
-            if name == "ServerRelativeUrl":
-                self._resource_path = ResourcePathServiceOperation("getFolderByServerRelativeUrl", [value],
-                                                                   ResourcePath("Web"))
-            elif name == "UniqueId":
-                self._resource_path = ResourcePathServiceOperation("getFolderById", [value], ResourcePath("Web"))
+        # if self._resource_path is None:
+        if name == "ServerRelativeUrl":
+            self._resource_path = ResourcePathServiceOperation("getFolderByServerRelativeUrl", [value],
+                                                               ResourcePath("Web"))
+        elif name == "UniqueId":
+            self._resource_path = ResourcePathServiceOperation("getFolderById", [value], ResourcePath("Web"))
         return self

office365/sharepoint/listitems/listitem.py

@@ -244,6 +244,7 @@ def set_property(self, name, value, persist_changes=True):
             if name == "Id" and self._parent_collection is not None:
                 self._resource_path = ResourcePathServiceOperation(
                     "getItemById", [value], self._parent_collection.resource_path.parent)
+        return self
 
     def ensure_type_name(self, target_list):
         """

office365/sharepoint/listitems/user_info_item.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.listitems.listitem import ListItem
+
+
+class UserInfoItem(ListItem):
+    pass

office365/sharepoint/tenant/administration/site_creation_default_storage_quota.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SiteCreationDefaultStorageQuota(ClientValue):
+    pass