Improvements for fluent interface, support for saving taxonomy field values (#353)

Author: [email protected]

README.md

@@ -303,7 +303,7 @@ where
 def download_files(remote_folder, local_path):
     drive_items = remote_folder.children.get().execute_query()
     for drive_item in drive_items:
-        if not drive_item.file.is_server_object_null:  # is file?
+        if drive_item.file is not None:  # is file?
             # download file content
             with open(os.path.join(local_path, drive_item.name), 'wb') as local_file:
                 drive_item.download(local_file).execute_query()

examples/__init__.py

@@ -3,13 +3,22 @@
 from tests import settings
 
 
-def acquire_token_client_credentials():
-
+def acquire_token_by_client_credentials():
     authority_url = 'https://login.microsoftonline.com/{0}'.format(settings.get('default', 'tenant'))
     app = msal.ConfidentialClientApplication(
         authority=authority_url,
         client_id=settings.get('client_credentials', 'client_id'),
         client_credential=settings.get('client_credentials', 'client_secret')
     )
-    result = app.acquire_token_for_client(scopes=["https://graph.microsoft.com/.default"])
-    return result
+    return app.acquire_token_for_client(scopes=["https://graph.microsoft.com/.default"])
+
+
+def acquire_token_by_username_password():
+    authority_url = 'https://login.microsoftonline.com/{0}'.format(settings.get('default', 'tenant'))
+    app = msal.PublicClientApplication(
+        authority=authority_url,
+        client_id=settings.get('client_credentials', 'client_id')
+    )
+    return app.acquire_token_by_username_password(username=settings.get('user_credentials', "username"),
+                                                  password=settings.get('user_credentials', "password"),
+                                                  scopes=["https://graph.microsoft.com/.default"])

examples/b2c/registerIdP.py

@@ -1,8 +1,8 @@
-from examples import acquire_token_client_credentials
+from examples import acquire_token_by_client_credentials
 from office365.graph_client import GraphClient
 
 
-client = GraphClient(acquire_token_client_credentials)
+client = GraphClient(acquire_token_by_client_credentials)
 idp_col = client.identity_providers.get().execute_query()
 for idp in idp_col:
     print(idp.id)

examples/directory/delete_groups.py

@@ -1,25 +1,15 @@
-from examples import acquire_token_client_credentials
+from examples import acquire_token_by_username_password
 from office365.graph_client import GraphClient
 
-client = GraphClient(acquire_token_client_credentials)
+client = GraphClient(acquire_token_by_username_password)
 
-groups = client.groups.get().top(10).execute_query()
-index = 0
+groups = client.groups.get().top(100).execute_query()
+deletedCount = 0
 groups_count = len(groups)
 while len(groups) > 0:
     cur_grp = groups[0]
-    print("({0} of {1}) Deleting {2} group ...".format(index + 1, groups_count, cur_grp.properties['displayName']))
-    cur_grp.delete_object().execute_query()
-    print("Group deleted.")
-    index += 1
-
-deleted_groups = client.directory.deleted_groups.get().execute_query()
-groups_count = len(deleted_groups)
-index = 0
-while len(deleted_groups) > 0:
-    cur_grp = deleted_groups[0]
-    print("({0} of {1}) Deleting {2} group permanently ...".format(index + 1, groups_count,
-                                                                   cur_grp.properties['displayName']))
-    cur_grp.delete_object().execute_query()
-    print("Group deleted.")
-    index += 1
+    print(
+        "({0} of {1}) Deleting {2} group ...".format(deletedCount + 1, groups_count, cur_grp.properties['displayName']))
+    cur_grp.delete_object(permanent_delete=True).execute_query()
+    print("Group deleted permanently.")
+    deletedCount += 1

examples/onedrive/export_files.py

@@ -5,16 +5,16 @@
 import os
 import tempfile
 
-from examples import acquire_token_client_credentials
+from examples import acquire_token_by_client_credentials
 from office365.graph_client import GraphClient
 from tests import test_user_principal_name
 
 
-client = GraphClient(acquire_token_client_credentials)
+client = GraphClient(acquire_token_by_client_credentials)
 drive = client.users[test_user_principal_name].drive  # get user's drive
 with tempfile.TemporaryDirectory() as local_path:
     drive_items = drive.root.children.get().execute_query()
-    file_items = [item for item in drive_items if not item.file.is_server_object_null]    # files only
+    file_items = [item for item in drive_items if item.file is not None]    # files only
     for drive_item in file_items:
         with open(os.path.join(local_path, drive_item.name), 'wb') as local_file:
             drive_item.download(local_file).execute_query()  # download file content

examples/onedrive/import_files.py

@@ -1,7 +1,7 @@
 import os
 from os.path import isfile, join
 
-from examples import acquire_token_client_credentials
+from examples import acquire_token_by_client_credentials
 from office365.graph_client import GraphClient
 from tests import load_settings
 
@@ -23,7 +23,7 @@ def upload_files(remote_drive, local_root_path):
 
 
 settings = load_settings()
-client = GraphClient(acquire_token_client_credentials)
+client = GraphClient(acquire_token_by_client_credentials)
 user_name = settings.get('test_alt_account_name')
 target_drive = client.users[user_name].drive  # get target drive
 # import local files into OneDrive

examples/onedrive/print_folders_and_files.py

@@ -1,13 +1,12 @@
 from office365.graph_client import GraphClient
-from tests import acquire_token_by_username_password
+from tests.graph_case import acquire_token_by_username_password
 
 
 def enum_folders_and_files(root_folder):
     drive_items = root_folder.children.get().execute_query()
     for drive_item in drive_items:
-        item_type = drive_item.folder.is_server_object_null and "file" or "folder"
-        print("Type: {0} Name: {1}".format(item_type, drive_item.name))
-        if not drive_item.folder.is_server_object_null and drive_item.folder.childCount > 0:
+        print("Name: {0}".format(drive_item.name))
+        if not drive_item.is_property_available("folder"):  # is folder facet?
             enum_folders_and_files(drive_item)
 
 

examples/onedrive/upload_file.py

@@ -1,10 +1,10 @@
 import os
 
-from examples import acquire_token_client_credentials
+from examples import acquire_token_by_client_credentials
 from office365.graph_client import GraphClient
 from tests import settings
 
-client = GraphClient(acquire_token_client_credentials)
+client = GraphClient(acquire_token_by_client_credentials)
 user_name = settings.get('first_account_name')
 target_drive = client.users[user_name].drive
 

examples/outlook/send_message.py

@@ -1,8 +1,8 @@
-from examples import acquire_token_client_credentials
+from examples import acquire_token_by_client_credentials
 from office365.graph_client import GraphClient
 from tests import test_user_principal_name, test_user_principal_name_alt
 
-client = GraphClient(acquire_token_client_credentials)
+client = GraphClient(acquire_token_by_client_credentials)
 message_json = {
     "Message": {
         "Subject": "Meet for lunch?",

examples/sharepoint/lists_and_items/create_listitem.py

@@ -0,0 +1,48 @@
+from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.fields.field_creation_information import FieldCreationInformation
+from office365.sharepoint.fields.field_multi_user_value import FieldMultiUserValue
+from office365.sharepoint.fields.field_type import FieldType
+from office365.sharepoint.fields.field_user_value import FieldUserValue
+from office365.sharepoint.lists.list_creation_information import ListCreationInformation
+from office365.sharepoint.lists.list_template_type import ListTemplateType
+from tests import create_unique_name, test_site_url, test_client_credentials, test_user_principal_name
+
+
+def create_tasks_list(client):
+    """
+
+    :type client: ClientContext
+    """
+    list_title = create_unique_name("Tasks N")
+    list_create_info = ListCreationInformation(list_title,
+                                               None,
+                                               ListTemplateType.TasksWithTimelineAndHierarchy)
+
+    target_list = client.web.lists.add(list_create_info).execute_query()
+    field_info = FieldCreationInformation("Manager", FieldType.User)
+    user_field = target_list.fields.add(field_info).execute_query()
+    return target_list
+
+
+ctx = ClientContext(test_site_url).with_credentials(test_client_credentials)
+tasks_list = create_tasks_list(ctx)
+
+#user = ctx.web.current_user.get().execute_query()
+user = ctx.web.ensure_user(test_user_principal_name)
+multi_user_value = FieldMultiUserValue()
+multi_user_value.add(FieldUserValue.from_user(user))
+
+item_to_create = tasks_list.add_item({
+    "Title": "New Task",
+    "AssignedTo": multi_user_value,
+    "Manager": FieldUserValue.from_user(user)
+}).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()
+