Graph client : improvements and error handling for batch request

Author: [email protected]

examples/__init__.py

@@ -3,6 +3,9 @@
 from tests import settings
 
 
+test_user_principal_name = settings.get('users', 'test_user1')
+
+
 def acquire_token_by_client_credentials():
     authority_url = 'https://login.microsoftonline.com/{0}'.format(settings.get('default', 'tenant'))
     app = msal.ConfidentialClientApplication(

examples/directory/delete_groups.py

@@ -3,7 +3,7 @@
 
 client = GraphClient(acquire_token_by_username_password)
 
-groups = client.groups.get().top(500).execute_query()
+groups = client.groups.get().top(50).execute_query()
 deletedCount = 0
 groups_count = len(groups)
 while len(groups) > 0:

examples/onedrive/upload_file.py

@@ -1,12 +1,12 @@
 import os
 
-from examples import acquire_token_by_client_credentials
+from examples import acquire_token_by_client_credentials, test_user_principal_name
 from office365.graph_client import GraphClient
-from tests import settings
+
 
 client = GraphClient(acquire_token_by_client_credentials)
-user_name = settings.get('first_account_name')
-target_drive = client.users[user_name].drive
+
+target_drive = client.users[test_user_principal_name].drive
 
 local_path = "../../tests/data/SharePoint User Guide.docx"
 with open(local_path, 'rb') as f:

examples/outlook/send_message.py

@@ -20,5 +20,5 @@
     },
     "SaveToSentItems": "false"
 }
-target_user = client.users[test_user_principal_name]
-target_user.send_mail(message_json).execute_query()
+client.users[test_user_principal_name].send_mail(message_json).execute_query()
+

examples/sharepoint/lists_and_items/create_listitems_batch.py

@@ -4,6 +4,7 @@
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
 list_tasks = ctx.web.lists.get_by_title("Tasks")
 
-task_items = [list_tasks.add_item({"Title": create_unique_name("Task")}) for idx in range(0, 25)]
+
+task_items = [list_tasks.add_item({"Title": create_unique_name("Task")}) for idx in range(0, 20)]
 ctx.execute_batch()
 print(f" {len(task_items)} task items created")

examples/sharepoint/lists_and_items/data_generator.py

@@ -9,14 +9,11 @@
 
 
 def ensure_list(web, list_properties):
-    lists = web.lists.filter("Title eq '{0}'".format(list_properties.Title))
-    ctx.load(lists)
-    ctx.execute_query()
+    lists = web.lists.filter("Title eq '{0}'".format(list_properties.Title)).get().execute_query()
     if len(lists) == 1:
         return lists[0]
-    target_list = web.lists.add(list_properties)
-    ctx.execute_query()
-    return target_list
+    else:
+        return web.lists.add(list_properties).execute_query()
 
 
 def generate_documents(context):

examples/sharepoint/lists_and_items/update_item.py

@@ -0,0 +1,16 @@
+from random import randint
+
+from office365.sharepoint.client_context import ClientContext
+from tests import test_team_site_url, test_client_credentials
+
+ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
+
+list_tasks = ctx.web.lists.get_by_title("Tasks")
+items = list_tasks.items.get().top(1).execute_query()  # 1. Load existing list items
+if len(items) > 0:
+    item_to_update = items[0]
+    task_prefix = str(randint(0, 10000))
+    item_to_update.set_property("Title", f"Task {task_prefix}")
+    item_to_update.update().execute_query()
+
+

examples/sharepoint/lists_and_items/update_items_batch.py

@@ -11,6 +11,5 @@
 # 2. Update list items via Batch mode
 for task_id, item in enumerate(items):
     task_prefix = str(randint(0, 10000))
-    item.set_property("Title", f"Task {task_prefix}")
-    item.update()
+    item.set_property("Title", f"Task {task_prefix}").update()
 ctx.execute_batch()

office365/graph_client.py

@@ -45,6 +45,14 @@ def __init__(self, acquire_token_callback):
         self._authority_host_url = "https://login.microsoftonline.com"
         self._acquire_token_callback = acquire_token_callback
 
+    def build_single_request(self, query):
+        """
+        :type: office365.runtime.queries.client_query.ClientQuery
+        """
+        request = super(GraphClient, self).build_single_request(query)
+        self._build_specific_query(request)
+        return request
+
     def execute_batch(self):
         """Construct and submit a batch request"""
         batch_request = ODataV4BatchRequest(self)

office365/runtime/odata/odata_v4_batch_request.py

@@ -5,9 +5,7 @@
 
 
 class ODataV4BatchRequest(ClientRequest):
-    """
-
-    """
+    """ JSON batch request """
 
     def __init__(self, context):
         super().__init__(context)
@@ -33,25 +31,39 @@ def process_response(self, response, query):
         """
         json = response.json()
         for resp in json["responses"]:
+            self._validate_response(resp)
             sub_qry = query.get(int(resp["id"]))
             self.context.pending_request().map_json(resp["body"], sub_qry.return_type)
 
+    def _validate_response(self, json):
+        if int(json['status']) >= 400:
+            raise ValueError(json['body'])
+
     def _prepare_payload(self, query):
         """Serializes a batch request body.
 
-        :type query: office365.runtime.queries.client_query.BatchQuery
+        :type query: office365.runtime.queries.batch_query.BatchQuery
         """
 
         requests_json = []
         for qry in query.queries:
+            request_id = str(len(requests_json))
             request = qry.build_request()
-            requests_json.append(self._serialize_request(request, len(requests_json)))
+            requests_json.append(self._normalize_request(request, request_id))
 
         return {"requests": requests_json}
 
-    def _serialize_request(self, request, request_no):
+    def _normalize_request(self, request, _id, depends_on=None):
+        """
+
+        :type request: RequestOptions
+        :type _id: str
+        :type depends_on:  list[str] or None
+        """
         allowed_props = ["id", "method", "headers", "url", "body"]
         json = dict((k, v) for k, v in vars(request).items() if v is not None and k in allowed_props)
-        json["id"] = str(request_no)
+        json["id"] = _id
+        if depends_on is not None:
+            json["dependsOn"] = depends_on
         json["url"] = json["url"].replace(self.context.service_root_url(), "/")
         return json

office365/runtime/queries/batch_query.py

@@ -52,6 +52,9 @@ def change_sets(self):
 
     @property
     def queries(self):
+        """
+        :rtype: list[ClientQuery]
+        """
         return self._queries
 
     @property

office365/sharepoint/client_context.py

@@ -112,6 +112,9 @@ def _prepare_batch_request(request):
         batch_request.execute_query(batch_qry)
 
     def build_single_request(self, query):
+        """
+        :type: office365.runtime.queries.client_query.ClientQuery
+        """
         request = super(ClientContext, self).build_single_request(query)
         self._build_modification_query(request)
         return request

office365/sharepoint/contenttypes/content_type_collection.py

@@ -8,8 +8,8 @@
 class ContentTypeCollection(BaseEntityCollection):
     """Content Type resource collection"""
 
-    def __init__(self, context, resource_path=None):
-        super(ContentTypeCollection, self).__init__(context, ContentType, resource_path)
+    def __init__(self, context, resource_path=None, parent=None):
+        super(ContentTypeCollection, self).__init__(context, ContentType, resource_path, parent)
 
     def get_by_id(self, contentTypeId):
         """

office365/sharepoint/lists/list.py

@@ -337,7 +337,7 @@ def content_types(self):
         """Gets the content types that are associated with the list."""
         return self.properties.get('ContentTypes',
                                    ContentTypeCollection(self.context,
-                                                         ResourcePath("ContentTypes", self.resource_path)))
+                                                         ResourcePath("ContentTypes", self.resource_path), self))
 
     @property
     def user_custom_actions(self):

office365/sharepoint/webs/web.py

@@ -709,7 +709,7 @@ def content_types(self):
         """Gets the collection of content types for the Web site."""
         return self.properties.get('ContentTypes',
                                    ContentTypeCollection(self.context,
-                                                         ResourcePath("ContentTypes", self.resource_path)))
+                                                         ResourcePath("ContentTypes", self.resource_path), self))
 
     @property
     def role_definitions(self):