Folder.get_folders() method, typings improvements for SharePoint API

Author: vgrem

examples/onedrive/drives/list.py

@@ -7,6 +7,6 @@
 from tests.graph_case import acquire_token_by_client_credentials
 
 client = GraphClient(acquire_token_by_client_credentials)
-drives = client.drives.get().top(10).execute_query()
+drives = client.drives.get().top(100).execute_query()
 for drive in drives:
     print("Drive url: {0}".format(drive.web_url))

examples/sharepoint/files/permissions/assign.py

@@ -12,16 +12,10 @@
 client = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
 file_url = "Shared Documents/report #123.csv"
 
-# Step 1: retrieve objects
-role_def = client.web.role_definitions.get_by_type(
-    RoleType.Contributor
-)  # address role by type
-user = client.web.site_users.get_by_email(
-    test_user_principal_name_alt
-)  # address user by email
-target_file = client.web.get_file_by_server_relative_path(
-    file_url
-)  # address file by relative url
 
-# Step 2: to assign a custom permissions to a file
+role_def = client.web.role_definitions.get_by_type(RoleType.Contributor)
+user = client.web.site_users.get_by_principal_name(test_user_principal_name_alt)
+target_file = client.web.get_file_by_server_relative_path(file_url)
+
+# assign a custom permissions for the user to a file
 target_file.listItemAllFields.add_role_assignment(user, role_def).execute_query()

examples/sharepoint/folders/get_props.py

@@ -1,5 +1,5 @@
 """
-Get Folder properties
+Gets Folder properties
 """
 from office365.sharepoint.client_context import ClientContext
 from tests import test_client_credentials, test_team_site_url

examples/sharepoint/folders/list_folders.py

@@ -1,25 +1,15 @@
-from typing import Callable
+"""
+Demonstrates how to enumerate a folder
+"""
 
 from office365.sharepoint.client_context import ClientContext
-from office365.sharepoint.folders.folder import Folder
 from tests import test_client_credentials, test_team_site_url
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-
-
-def enum_folder(parent_folder, action):
-    # type: (Folder, Callable[[Folder], None]) -> None
-    parent_folder.expand(["Folders"]).get().execute_query()
-    action(parent_folder)
-    for folder in parent_folder.folders:
-        enum_folder(folder, action)
-
-
-def print_folder_stat(folder):
-    # type: (Folder) -> None
-    print(folder.serverRelativeUrl)
-    print(folder.time_created)
-
-
-root_folder = ctx.web.default_document_library().root_folder
-enum_folder(root_folder, print_folder_stat)
+folders = (
+    ctx.web.default_document_library().root_folder.get_folders(True).execute_query()
+)
+for folder in folders:
+    print(
+        "Url: {0}, Created: {1}".format(folder.serverRelativeUrl, folder.time_created)
+    )

examples/sharepoint/folders/list_folders_custom.py

@@ -0,0 +1,27 @@
+"""
+Demonstrates how to enumerate a folder
+"""
+from typing import Callable
+
+from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.folders.folder import Folder
+from tests import test_client_credentials, test_team_site_url
+
+
+def enum_folder(parent_folder, action):
+    # type: (Folder, Callable[[Folder], None]) -> None
+    parent_folder.expand(["Folders"]).get().execute_query()
+    action(parent_folder)
+    for folder in parent_folder.folders:
+        enum_folder(folder, action)
+
+
+def print_folder_stat(folder):
+    # type: (Folder) -> None
+    print(folder.serverRelativeUrl)
+    print(folder.time_created)
+
+
+ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
+root_folder = ctx.web.default_document_library().root_folder
+enum_folder(root_folder, print_folder_stat)

examples/sharepoint/groups/add_remove_user.py examples/sharepoint/groups/add_remove.py

@@ -1,6 +1,5 @@
 """
 Adds and removes site group
-
 """
 from office365.sharepoint.client_context import ClientContext
 from tests import create_unique_name, test_password, test_site_url, test_username

examples/sharepoint/groups/expand_to_principals.py

@@ -0,0 +1,13 @@
+"""
+Expands group to a collection of principals.
+"""
+from office365.sharepoint.client_context import ClientContext
+from tests import test_client_id, test_client_secret, test_team_site_url
+
+ctx = ClientContext(test_team_site_url).with_client_credentials(
+    test_client_id, test_client_secret
+)
+
+result = ctx.web.associated_member_group.expand_to_principals(100).execute_query()
+for principal_info in result.value:
+    print(principal_info)

examples/sharepoint/navigation/export_top.py examples/sharepoint/navigation/list_top_nav.py

@@ -1,11 +1,11 @@
 """
-Export the top navigation
+Prints the top navigation
 """
-import json
 
 from office365.sharepoint.client_context import ClientContext
 from tests import test_client_credentials, test_team_site_url
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
 nav = ctx.web.navigation.top_navigation_bar.get().execute_query()
-print(json.dumps(nav.to_json(), indent=4))
+for item in nav:
+    print(item)

examples/sharepoint/permissions/get_for_list.py

@@ -1,10 +1,11 @@
 """
-Returns the user permissions for the list.
+Returns the user permissions for the list/lib.
 """
 from office365.sharepoint.client_context import ClientContext
 from tests import test_client_credentials, test_team_site_url
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
 doc_lib = ctx.web.default_document_library()
 result = doc_lib.get_user_effective_permissions(ctx.web.current_user).execute_query()
-print(result.value.permission_levels)
+for perm_level in result.value:
+    print(perm_level)

examples/sharepoint/permissions/get_for_site.py

@@ -1,13 +1,11 @@
 """
-Demonstrates how to retrieve site groups along with users
+Returns the user permissions for the site
 """
+from pprint import pprint
+
 from office365.sharepoint.client_context import ClientContext
 from tests import test_client_credentials, test_team_site_url
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-
-site_groups = ctx.web.site_groups.expand(["Users"]).get().execute_query()
-for g in site_groups:
-    print("Group name: {0}".format(g.login_name))
-    for u in g.users:
-        print("User name: {0}".format(u.login_name))
+result = ctx.web.get_user_effective_permissions(ctx.web.current_user).execute_query()
+pprint(result.value.permission_levels)

examples/sharepoint/permissions/grant_to_web.py

@@ -0,0 +1,16 @@
+"""
+Grants user access to web
+"""
+from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.sharing.role_type import RoleType
+from tests import (
+    test_client_credentials,
+    test_team_site_url,
+    test_user_principal_name_alt,
+)
+
+ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
+result = ctx.web.add_role_assignment(
+    test_user_principal_name_alt, RoleType.Contributor
+).execute_query()
+print("Access has been granted")

examples/sharepoint/users/get_for_site.py

@@ -0,0 +1,12 @@
+"""
+Demonstrates how to retrieve site groups along with users
+"""
+from office365.sharepoint.client_context import ClientContext
+from tests import test_client_credentials, test_team_site_url
+
+ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
+site_groups = ctx.web.site_groups.expand(["Users"]).get().execute_query()
+for g in site_groups:
+    print("Group: {0}".format(g.login_name))
+    for u in g.users:
+        print("User: {0}".format(u.login_name))

examples/sharepoint/webs/get_lists.py

@@ -1,7 +1,12 @@
+"""
+Enumerate across all lists in a site
+"""
+
 from office365.sharepoint.client_context import ClientContext
 from tests import test_client_credentials, test_site_url
 
 client = ClientContext(test_site_url).with_credentials(test_client_credentials)
-lists = client.web.get_lists().execute_query()
+# lists = client.web.get_lists().execute_query()
+lists = client.web.lists.get_all().execute_query()
 for lst in lists:
     print(lst.title)

office365/runtime/odata/type.py

@@ -1,5 +1,7 @@
 import datetime
+import inspect
 import uuid
+from typing import Type
 
 
 class ODataType(object):
@@ -93,6 +95,16 @@ def resolve_type(client_type):
         else:
             return ODataType.primitive_types.get(client_type, None)
 
+    @staticmethod
+    def resolve_enum_key(enum_type, value):
+        # type: (Type, int) -> str
+        return next(
+            iter(
+                [item[0] for item in inspect.getmembers(enum_type) if item[1] == value]
+            ),
+            None,
+        )
+
     def add_property(self, prop_schema):
         """
         :type prop_schema:  office365.runtime.odata.property.ODataProperty

office365/sharepoint/changes/change.py

@@ -1,7 +1,7 @@
 import datetime
-import inspect
 from typing import Optional
 
+from office365.runtime.odata.type import ODataType
 from office365.sharepoint.changes.token import ChangeToken
 from office365.sharepoint.changes.type import ChangeType
 from office365.sharepoint.entity import Entity
@@ -12,16 +12,7 @@ class Change(Entity):
 
     @property
     def change_type_name(self):
-        return next(
-            iter(
-                [
-                    item[0]
-                    for item in inspect.getmembers(ChangeType)
-                    if item[1] == self.change_type
-                ]
-            ),
-            None,
-        )
+        return ODataType.resolve_enum_key(ChangeType, self.change_type)
 
     @property
     def change_token(self):

office365/sharepoint/fields/related_field_collection.py

@@ -3,7 +3,7 @@
 from office365.sharepoint.fields.related_field import RelatedField
 
 
-class RelatedFieldCollection(EntityCollection):
+class RelatedFieldCollection(EntityCollection[RelatedField]):
     """Represents a collection of RelatedField resources."""
 
     def __init__(self, context, resource_path=None):

office365/sharepoint/folders/folder.py

@@ -54,6 +54,25 @@ def download_folder(
             self, download_file, after_file_downloaded, recursive
         )
 
+    def get_folders(self, recursive=False):
+        """
+        Retrieves folders
+        :param bool recursive: Determines whether to enumerate folders recursively
+        """
+        from office365.sharepoint.folders.collection import FolderCollection  # noqa
+
+        return_type = FolderCollection(self.context, self.folders.resource_path, self)
+
+        def _loaded(parent):
+            # type: ("Folder") -> None
+            [return_type.add_child(f) for f in parent.folders]
+            if recursive:
+                for folder in parent.folders:
+                    folder.ensure_properties(["Folders"], _loaded, parent=folder)
+
+        self.ensure_properties(["Folders"], _loaded, parent=self)
+        return return_type
+
     def get_files(self, recursive=False):
         """
         Retrieves files

office365/sharepoint/forms/collection.py

@@ -3,7 +3,7 @@
 from office365.sharepoint.forms.form import Form
 
 
-class FormCollection(EntityCollection):
+class FormCollection(EntityCollection[Form]):
     def __init__(self, context, resource_path=None):
         """Specifies a collection of list forms for a list."""
         super(FormCollection, self).__init__(context, Form, resource_path)