Submit a SharePoint batch asynchronously.

execute_batch_async splits the pending changes exactly like execute_batch but never blocks the event loop. With concurrency > 1 the batches overlap, and throttling / per-sub-request retry behave the same as in the synchronous path.

Permissions

Requires delegated permission Sites.FullControl.All (writes list items).

Reference

• https://learn.microsoft.com/en-us/sharepoint/dev/apis/rest-api/navigation/list-operations

View source

import asyncio

from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.lists.templates.type import ListTemplateType
from tests.settings import cert_path, cert_thumbprint, client_id, site_url, tenant


async def main() -> None:
    ctx = ClientContext(site_url).with_client_certificate(
        tenant, client_id=client_id, thumbprint=cert_thumbprint, cert_path=cert_path
    )
    target_list = await ctx.web.ensure_list("Company Tasks", template_type=ListTemplateType.Tasks).execute_query_async()
    for index in range(200):
        target_list.add_item({"Title": f"Task {index}"})

    await ctx.execute_batch_async(items_per_batch=100, concurrency=4)

    # item_count is a snapshot loaded with the list (0 for a freshly created one);
    # re-read it from a fresh list to reflect the batch.
    report = await ctx.web.lists.get_by_title("Company Tasks").select(["ItemCount"]).execute_query_async()
    print(f"List items count: {report.item_count}")


asyncio.run(main())

---

← Back to Async / await