Improvements for batch request (support for max items per bulk op), #349 related

Author: [email protected]

examples/sharepoint/lists_and_items/create_listitems_batch.py

@@ -5,6 +5,6 @@
 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, 20)]
+task_items = [list_tasks.add_item({"Title": create_unique_name("Task")}) for idx in range(0, 99)]
 ctx.execute_batch()
-print(f" {len(task_items)} task items created")
+print(" {0} task items created".format(len(task_items)))

examples/sharepoint/lists_and_items/update_items_batch.py

@@ -7,9 +7,10 @@
 
 # 1. Load existing list items
 list_tasks = ctx.web.lists.get_by_title("Tasks")
-items = list_tasks.items.get().top(50).execute_query()
+items = list_tasks.items.get().top(10).execute_query()
 # 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}").update()
+    item.set_property("Title", "Task {task_prefix}".format(task_prefix=task_prefix)).update()
 ctx.execute_batch()
+print("{0} items has been updated".format(len(items)))

office365/runtime/compat.py

@@ -19,12 +19,14 @@
     from urlparse import urljoin
     import pytz as timezone
     from email import message_from_string as message_from_bytes_or_string
+    from __builtin__ import xrange as range_or_xrange
 elif is_py3:
     from urllib.parse import urlparse
     from urllib.parse import quote
     from urllib.parse import urljoin
     from datetime import timezone
     from email import message_from_bytes as message_from_bytes_or_string
+    from builtins import range as range_or_xrange
 
 
 def message_as_bytes_or_string(message):

office365/runtime/odata/odata_batch_request.py

@@ -114,7 +114,6 @@ def _deserialize_response(self, raw_response):
                 "content": None
             }
         else:
-            #*headers_raw, content = lines[1:]
             headers_raw = lines[1:-1]
             content = lines[-1]
             content = json.loads(content)

office365/sharepoint/client_context.py

@@ -16,6 +16,7 @@
 from office365.sharepoint.sites.site import Site
 from office365.sharepoint.webs.context_web_information import ContextWebInformation
 from office365.sharepoint.webs.web import Web
+from office365.runtime.compat import range_or_xrange
 
 
 class ClientContext(ClientRuntimeContext):
@@ -98,18 +99,26 @@ def with_credentials(self, credentials):
         self.authentication_context.register_provider(credentials)
         return self
 
-    def execute_batch(self):
-        """Construct and submit a batch request"""
+    def execute_batch(self, items_per_bulk=100):
+        """
+        Construct and submit a batch request
+
+        :param int items_per_bulk: Maximum to be selected for bulk operation
+        """
         batch_request = ODataBatchRequest(self)
 
-        queries = [qry for qry in self.pending_request()]
-        batch_qry = BatchQuery(self, queries)
+        all_queries = [qry for qry in self.pending_request()]
+        # batch_qry = BatchQuery(self, all_queries)
 
         def _prepare_batch_request(request):
             self.ensure_form_digest(request)
 
         batch_request.beforeExecute += _prepare_batch_request
-        batch_request.execute_query(batch_qry)
+
+        for i in range_or_xrange(0, len(all_queries), items_per_bulk):
+            queries = all_queries[i:i + items_per_bulk]
+            batch_qry = BatchQuery(self, queries)
+            batch_request.execute_query(batch_qry)
 
     def build_single_request(self, query):
         """