#764 fix, SharePoint examples updates, typings enhancements

Author: vgrem

examples/directory/groups/create_m365.py

@@ -12,7 +12,7 @@
 
 grp_name = create_unique_name("Group")
 client = GraphClient(acquire_token_by_username_password)
-group = client.groups.create_m365_group(grp_name).execute_query()
+group = client.groups.create_m365(grp_name).execute_query()
 
 # clean up resources
 group.delete_object(True).execute_query()

examples/directory/groups/list.py

@@ -8,6 +8,6 @@
 from tests.graph_case import acquire_token_by_username_password
 
 client = GraphClient(acquire_token_by_username_password)
-groups = client.groups.get().top(10).execute_query()
+groups = client.groups.get().top(100).execute_query()
 for grp in groups:
     print(grp)

examples/outlook/messages/download.py

@@ -1,5 +1,5 @@
 """
-Get MIME content of a message
+Downloads MIME representation of a message
 
 https://learn.microsoft.com/en-us/graph/outlook-get-mime-message
 Requires Mail.ReadWrite permission
@@ -12,11 +12,11 @@
 from tests.graph_case import acquire_token_by_username_password
 
 client = GraphClient(acquire_token_by_username_password)
-messages = client.me.messages.select(["id", "subject"]).top(2).get().execute_query()
+messages = client.me.messages.select(["id", "subject"]).top(1).get().execute_query()
 with tempfile.TemporaryDirectory() as local_path:
     for message in messages:
-        with open(os.path.join(local_path, message.id + ".eml"), "wb") as local_file:
-            message.download(
-                local_file
-            ).execute_query()  # download MIME representation of a message
+        with open(
+            os.path.join(local_path, message.subject + ".eml"), "wb"
+        ) as local_file:
+            message.download(local_file).execute_query()
         print("Message downloaded into {0}".format(local_file.name))

examples/planner/create_plan.py

@@ -0,0 +1,14 @@
+"""
+Creates a new plannerPlan
+https://learn.microsoft.com/en-us/graph/api/planner-post-plans?view=graph-rest-1.0
+"""
+
+from office365.graph_client import GraphClient
+from tests import test_client_id, test_password, test_tenant, test_username
+
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
+group = client.groups.get_by_name("My Sample Team")
+plan = client.planner.plans.add("My Plan", group).execute_query()
+print(plan)

examples/planner/create_task.py

@@ -1,22 +1,16 @@
+"""
+Create a new plannerTask.
+https://learn.microsoft.com/en-us/graph/api/planner-post-tasks?view=graph-rest-1.0
+"""
+import sys
+
 from office365.graph_client import GraphClient
-from office365.planner.plans.plan import PlannerPlan
 from tests.graph_case import acquire_token_by_username_password
 
-
-def ensure_plan(planner, name):
-    """
-    :type planner: office365.planner.user.PlannerUser
-    :type name: str
-    :rtype: PlannerPlan
-    """
-    plans = planner.plans.get().filter("title eq '{0}'".format(name)).execute_query()
-    if len(plans) > 0:
-        return plans[0]
-    else:
-        return planner.plans.add(title=name).execute_query()
-
-
 client = GraphClient(acquire_token_by_username_password)
-plan = ensure_plan(client.me.planner, "My plan")
-task = client.planner.tasks.add(title="New task", planId=plan.id).execute_query()
+group = client.groups.get_by_name("My Sample Team").get().execute_query()
+plans = group.planner.plans.get().execute_query()
+if len(plans) == 0:
+    sys.exit("No plans were found")
+task = plans[0].tasks.add(title="New task").execute_query()
 print("Task {0} has been created".format(task.title))

examples/sharepoint/__init__.py

@@ -1,7 +1,9 @@
 from office365.sharepoint.fields.creation_information import FieldCreationInformation
 from office365.sharepoint.fields.type import FieldType
 from office365.sharepoint.lists.creation_information import ListCreationInformation
+from office365.sharepoint.lists.list import List
 from office365.sharepoint.lists.template_type import ListTemplateType
+from office365.sharepoint.webs.web import Web
 from tests import create_unique_name
 
 
@@ -17,9 +19,9 @@ def upload_sample_file(context, path):
 
 
 def create_sample_tasks_list(web):
-    """
-    :type web: office365.sharepoint.webs.web.Web
-    """
+    # type: (Web) -> List
+    list_title = "Company Tasks"
+
     list_title = create_unique_name("Tasks N")
     list_create_info = ListCreationInformation(
         list_title, None, ListTemplateType.TasksWithTimelineAndHierarchy
@@ -29,3 +31,7 @@ def create_sample_tasks_list(web):
     field_info = FieldCreationInformation("Manager", FieldType.User)
     return_type.fields.add(field_info).execute_query()
     return return_type
+
+
+def configure():
+    pass

examples/sharepoint/files/copy_file.py

@@ -1,22 +1,14 @@
 """
-Demonstrates how to copy a folder within a site
+Demonstrates how to copy a file within a site
 """
 from office365.sharepoint.client_context import ClientContext
 from tests import test_team_site_url, test_user_credentials
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_user_credentials)
 
-# uploads a temporary folder first in a Documents library
-path = "../../data/report.csv"
-file_from = (
-    ctx.web.default_document_library().root_folder.files.upload(path).execute_query()
+file_from = ctx.web.get_file_by_server_relative_url(
+    "Shared Documents/Financial Sample.xlsx"
 )
-
-# copies the file with a new name into folder
-destination_url = "Shared Documents/archive/2002/01"
-file_to = file_from.copyto_using_path(destination_url, True).execute_query()
-print("Folder has been copied into '{0}'".format(file_to.server_relative_path))
-
-# clean up
-file_from.delete_object().execute_query()
-file_to.delete_object().execute_query()
+folder_to = ctx.web.get_folder_by_server_relative_url("Shared Documents/archive")
+file_to = file_from.copyto(folder_to, True).execute_query()
+print("File has been copied into '{0}'".format(file_to))

examples/sharepoint/files/copy_using_path.py

@@ -0,0 +1,15 @@
+"""
+Demonstrates how to copy a file within a site
+"""
+from office365.sharepoint.client_context import ClientContext
+from tests import test_team_site_url, test_user_credentials
+
+ctx = ClientContext(test_team_site_url).with_credentials(test_user_credentials)
+
+file_from = ctx.web.get_file_by_server_relative_path(
+    "Shared Documents/Financial Sample.xlsx"
+)
+
+folder_to = ctx.web.get_folder_by_server_relative_path("Shared Documents/archive")
+file_to = file_from.copyto_using_path(folder_to, True).execute_query()
+print("File has been copied into '{0}'".format(file_to.server_relative_path))

examples/sharepoint/files/create_anonymous_link.py

@@ -8,7 +8,7 @@
 from tests import test_client_credentials, test_team_site_url
 
 client = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-file_url = "Shared Documents/report #123.csv"
+file_url = "Shared Documents/Financial Sample.xlsx"
 file = client.web.get_file_by_server_relative_path(file_url)
 expires = datetime.datetime.now() + timedelta(minutes=120)
 result = file.create_anonymous_link_with_expiration(expires).execute_query()

examples/sharepoint/files/download_large.py

@@ -6,11 +6,12 @@
 
 
 def print_download_progress(offset):
+    # type: (int) -> None
     print("Downloaded '{0}' bytes...".format(offset))
 
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-file_url = "Shared Documents/Archive/big_buck_bunny.mp4"
+file_url = "Shared Documents/big_buck_bunny.mp4"
 source_file = ctx.web.get_file_by_server_relative_path(file_url)
 local_file_name = os.path.join(tempfile.mkdtemp(), os.path.basename(file_url))
 with open(local_file_name, "wb") as local_file:

examples/sharepoint/files/list.py renamed to examples/sharepoint/folders/list_files.py

@@ -1,31 +1,19 @@
+"""
+Gets the files from the folder.
+If 'recursive' flag set to True, it traverses all sub folders
+"""
 from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.files.file import File
-from office365.sharepoint.folders.folder import Folder
 from tests import test_team_site_url, test_user_credentials
 
-ctx = ClientContext(test_team_site_url).with_credentials(test_user_credentials)
-
-
-def enum_folder(parent_folder, fn):
-    """
-    :type parent_folder: Folder
-    :type fn: (File)-> None
-    """
-    parent_folder.expand(["Files", "Folders"]).get().execute_query()
-    for file in parent_folder.files:  # type: File
-        fn(file)
-    for folder in parent_folder.folders:  # type: Folder
-        enum_folder(folder, fn)
-
 
 def print_file(f):
     # type: (File) -> None
     print(f.serverRelativeUrl)
 
 
+ctx = ClientContext(test_team_site_url).with_credentials(test_user_credentials)
 target_folder_url = "Shared Documents"
 root_folder = ctx.web.get_folder_by_server_relative_path(target_folder_url)
-# enum_folder(root_folder, print_file)
-
 files = root_folder.get_files(True).execute_query()
 [print_file(f) for f in files]

examples/sharepoint/folders/list_folders.py

@@ -1,5 +1,6 @@
 """
-Demonstrates how to enumerate a folder
+Demonstrates how to retrieve folders
+If 'recursive' flag set to True, it traverses all sub folders
 """
 
 from office365.sharepoint.client_context import ClientContext

examples/sharepoint/listitems/create.py

@@ -1,27 +1,23 @@
-from examples.sharepoint import create_sample_tasks_list
+"""
+Creates a list item in a List
+"""
+
 from office365.sharepoint.client_context import ClientContext
-from office365.sharepoint.fields.multi_user_value import FieldMultiUserValue
 from office365.sharepoint.fields.user_value import FieldUserValue
-from tests import test_client_credentials, test_site_url, test_user_principal_name
-
-ctx = ClientContext(test_site_url).with_credentials(test_client_credentials)
-tasks_list = create_sample_tasks_list(ctx.web)
+from tests import (
+    test_client_credentials,
+    test_team_site_url,
+    test_user_principal_name,
+)
 
-user = ctx.web.ensure_user(test_user_principal_name)
-multi_user_value = FieldMultiUserValue()
-multi_user_value.add(FieldUserValue.from_user(user))
+ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
+tasks_list = ctx.web.lists.get_by_title("Company Tasks")
+manager = ctx.web.site_users.get_by_principal_name(test_user_principal_name)
 
-item_to_create = tasks_list.add_item(
+item = tasks_list.add_item(
     {
         "Title": "New Task",
-        "AssignedTo": multi_user_value,
-        "Manager": FieldUserValue.from_user(user),
+        # "Manager": FieldUserValue.from_user(manager),
     }
 ).execute_query()
-
-multi_user_value_alt = FieldMultiUserValue()
-multi_user_value_alt.add(FieldUserValue(user.id))
-
-item_to_create_alt = tasks_list.add_item(
-    {"Title": "New Task 2", "AssignedTo": multi_user_value_alt}
-).execute_query()
+print("Item has been created")

examples/sharepoint/listitems/create_batch.py

@@ -1,21 +1,14 @@
 """
-Demonstrates how to create multiple list items via batch request
+Demonstrates how to create multiple list items
 """
 from office365.sharepoint.client_context import ClientContext
-from office365.sharepoint.lists.template_type import ListTemplateType
 from tests import create_unique_name, test_client_credentials, test_team_site_url
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-list_tasks = ctx.web.add_list(
-    create_unique_name("Tasks"), ListTemplateType.Tasks
-).execute_query()
+tasks_list = ctx.web.lists.get_by_title("Company Tasks")
 
-num_of_items = 2
+num_of_items = 10
 item_props = {"Title": create_unique_name("Task")}
-task_items = [list_tasks.add_item(item_props) for idx in range(0, num_of_items)]
+task_items = [tasks_list.add_item(item_props) for idx in range(0, num_of_items)]
 ctx.execute_batch()
 print("{0} task items created".format(len(task_items)))
-
-
-print("Cleaning up temporary resources...")
-list_tasks.delete_object().execute_query()

examples/sharepoint/listitems/delete.py

@@ -1,33 +1,15 @@
 """
-Demonstrates how to delete a list item
+Demonstrates how to delete a List Item from a List
 """
 from office365.sharepoint.client_context import ClientContext
-from office365.sharepoint.lists.template_type import ListTemplateType
-from tests import create_unique_name, test_client_credentials, test_team_site_url
-
-
-def create_tasks_list(client):
-    """
-    :type client: ClientContext
-    """
-    list_title = create_unique_name("Tasks")
-    target_list = client.web.add_list(list_title, ListTemplateType.Tasks)
-    target_list.add_item({"Title": "Task1"})
-    target_list.add_item({"Title": "Task2"})
-    return target_list.expand(["items"]).get()
-
+from tests import test_client_credentials, test_team_site_url
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-tasks_list = create_tasks_list(ctx).execute_query()
+tasks_list = ctx.web.lists.get_by_title("Company Tasks")
+items = tasks_list.items.get().execute_query()
 
 print("Option 1: remove a list item (with an option to restore from a recycle bin)...")
-item_id = tasks_list.items[1].id
-tasks_list.get_item_by_id(item_id).recycle().execute_query()
+items[0].recycle().execute_query()
 
 print("Option 2: Permanently remove a list item...")
-item_id = tasks_list.items[2].id
-tasks_list.get_item_by_id(item_id).delete_object().execute_query()
-
-
-print("Cleaning up...")
-tasks_list.delete_object().execute_query()
+items[1].delete_object().execute_query()

examples/sharepoint/listitems/delete_batch.py

@@ -1,16 +1,17 @@
+"""
+Demonstrates how to delete multiple list items
+"""
 from office365.sharepoint.client_context import ClientContext
-from office365.sharepoint.listitems.listitem import ListItem
 from tests import test_client_credentials, test_team_site_url
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-items_count = 100
+items_count = 10
 
 # 1. Load existing list items
-list_tasks = ctx.web.lists.get_by_title("Tasks")
-items = list_tasks.items.get().top(items_count).execute_query()
+tasks_list = ctx.web.lists.get_by_title("Company Tasks")
+items = tasks_list.items.get().top(items_count).execute_query()
 
 # 2. Delete list items (via batch mode)
-for item in items:  # type: ListItem
-    item.delete_object()
+[item.delete_object() for item in items]
 ctx.execute_batch()
 print("{0} items have been deleted".format(items_count))