#788: batch request fixes and enhancements

Author: vgrem

examples/sharepoint/listitems/create_batch.py

@@ -2,18 +2,24 @@
 Demonstrates how to create multiple list items
 """
 
+from typing import List
+
+from office365.runtime.client_object import ClientObject
 from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.listitems.listitem import ListItem
 from tests import create_unique_name, test_client_credentials, test_team_site_url
 
 
-def print_progress(items_count):
+def print_progress(return_types):
+    # type: (List[ClientObject]) -> None
+    items_count = len([t for t in return_types if isinstance(t, ListItem)])
     print("{0} list items has been created".format(items_count))
 
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
 tasks_list = ctx.web.lists.get_by_title("Company Tasks")
 
-num_of_items = 1024
+num_of_items = 512
 item_props = {"Title": create_unique_name("Task")}
 task_items = [tasks_list.add_item(item_props) for idx in range(0, num_of_items)]
 ctx.execute_batch(success_callback=print_progress)

examples/sharepoint/lists/import_list.py

@@ -1,10 +1,16 @@
+from typing import List
+
 from faker import Faker
 
+from office365.runtime.client_object import ClientObject
 from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.listitems.listitem import ListItem
 from tests import test_team_site_url, test_user_credentials
 
 
-def print_progress(items_count):
+def print_progress(return_types):
+    # type: (List[ClientObject]) -> None
+    items_count = len([t for t in return_types if isinstance(t, ListItem)])
     print("{0} list items has been created".format(items_count))
 
 
@@ -41,7 +47,7 @@ def run(context):
         #        idx, len(contacts_data), contact_item.properties["Title"]
         #    )
         # )
-    ctx.execute_batch(items_per_batch=2, success_callback=print_progress)
+    ctx.execute_batch(items_per_batch=10, success_callback=print_progress)
 
 
 if __name__ == "__main__":

examples/sharepoint/webs/clear_web.py

@@ -2,13 +2,15 @@
 
 """
 
+from typing import List
+
 from office365.sharepoint.client_context import ClientContext
 from tests import test_client_credentials, test_site_url
 
 
-def print_progress(num_deleted):
-    # type: (int) -> None
-    print("{0} deleted.".format(num_deleted))
+def print_progress(deleted_lists):
+    # type: (List) -> None
+    print("{0} deleted.".format(len(deleted_lists)))
 
 
 ctx = ClientContext(test_site_url).with_credentials(test_client_credentials)

office365/graph_client.py

@@ -229,16 +229,19 @@ def _acquire_token():
 
         return GraphClient(_acquire_token)
 
-    def execute_batch(self, items_per_batch=100):
+    def execute_batch(self, items_per_batch=100, success_callback=None):
         """Constructs and submit a batch request
 
         :param int items_per_batch: Maximum to be selected for bulk operation
+        :param (List[ClientObject|ClientResult])-> None success_callback: A success callback
         """
         batch_request = ODataV4BatchRequest(V4JsonFormat())
         batch_request.beforeExecute += self._authenticate_request
         while self.has_pending_request:
             qry = self._get_next_query(items_per_batch)
             batch_request.execute_query(qry)
+            if callable(success_callback):
+                success_callback(qry.return_type)
         return self
 
     def pending_request(self):

office365/runtime/queries/batch.py

@@ -61,3 +61,7 @@ def has_change_sets(self):
     @property
     def url(self):
         return "{0}/$batch".format(self.context.service_root_url())
+
+    @property
+    def return_type(self):
+        return [q.return_type for q in self._queries]

office365/sharepoint/client_context.py

@@ -8,6 +8,7 @@
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.token_response import TokenResponse
 from office365.runtime.auth.user_credential import UserCredential
+from office365.runtime.client_object import ClientObject
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_runtime_context import ClientRuntimeContext
 from office365.runtime.compat import get_absolute_url, urlparse
@@ -197,11 +198,11 @@ def with_credentials(self, credentials, environment="commercial"):
         return self
 
     def execute_batch(self, items_per_batch=100, success_callback=None):
-        # type: (int, Callable[[int], None]) -> Self
+        # type: (int, Callable[[List[ClientObject|ClientResult]], None]) -> Self
         """
         Construct and submit to a server a batch request
         :param int items_per_batch: Maximum to be selected for bulk operation
-        :param (int)-> None success_callback: A success callback
+        :param (List[ClientObject|ClientResult])-> None success_callback: A success callback
         """
         batch_request = ODataBatchV3Request(JsonLightFormat())
         batch_request.beforeExecute += self._authenticate_request
@@ -210,7 +211,7 @@ def execute_batch(self, items_per_batch=100, success_callback=None):
             qry = self._get_next_query(items_per_batch)
             batch_request.execute_query(qry)
             if callable(success_callback):
-                success_callback(items_per_batch)
+                success_callback(qry.return_type)
         return self
 
     def pending_request(self):

office365/sharepoint/entity.py

@@ -1,10 +1,11 @@
-from typing import TYPE_CHECKING, Callable
+from typing import TYPE_CHECKING, Callable, List
 
 from typing_extensions import Self
 
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.user_credential import UserCredential
 from office365.runtime.client_object import ClientObject
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.v3.entity import EntityPath
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.update_entity import UpdateEntityQuery
@@ -22,13 +23,13 @@ def execute_query_with_incremental_retry(self, max_retry=5):
         return self
 
     def execute_batch(self, items_per_batch=100, success_callback=None):
-        # type: (int, Callable[[int], None]) -> Self
+        # type: (int, Callable[[List[ClientObject|ClientResult]], None]) -> Self
         """Construct and submit to a server a batch request"""
         return self.context.execute_batch(items_per_batch, success_callback)
 
     def with_credentials(self, credentials):
         # type: (UserCredential|ClientCredential) -> Self
-        """ """
+        """Initializes a client to acquire a token via user or client credentials"""
         self.context.with_credentials(credentials)
         return self