daprmq-client 0.0.0a4__tar.gz

daprmq_client-0.0.0a4/.gitignore

@@ -0,0 +1,122 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+venv/
+env/
+ENV/
+.venv
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*.sublime-project
+*.sublime-workspace
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Environment
+.env.local
+
+# Tests
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+*.cover
+.hypothesis/
+
+# Type checking
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Docker
+*.log
+
+# Dapr
+.dapr/
+dapr_scheduler/
+dapr/blobstore-data/
+
+# .NET
+bin/
+obj/
+*.dll
+*.exe
+*.pdb
+*.cache
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+*.userprefs
+project.lock.json
+project.fragment.lock.json
+artifacts/
+*.nuget.props
+*.nuget.targets
+.vs/
+
+# Perf results: each machine's own history (CI's lives on the perf-results branch)
+/perf-results/
+
+# Custom nuget - allow custom nuget packages
+!nuget-local/*.nupkg
+
+# Node.js / Dashboard
+dashboard/node_modules/
+dashboard/dist/
+dashboard/npm-debug.log*
+dashboard/yarn-debug.log*
+dashboard/yarn-error.log*
+dashboard/.env
+dashboard/.env.production
+dashboard/.env.local
+dashboard/.env.development.local
+dashboard/.env.test.local
+dashboard/.env.production.local
+dashboard/index-backup.html
+
+# Node.js / TypeScript SDK
+sdks/typescript/node_modules/
+sdks/typescript/npm-debug.log*
+
+# Java SDK
+sdks/java/target/
+
+# Examples
+examples/java/*/target/
+examples/java/*/dependency-reduced-pom.xml
+examples/typescript/*/node_modules/
+examples/typescript/*/npm-debug.log*
+examples/python/*/.venv/

daprmq_client-0.0.0a4/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

daprmq_client-0.0.0a4/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.5
+Name: daprmq-client
+Version: 0.0.0a4
+Summary: Python client SDK for DaprMQ
+Project-URL: Repository, https://github.com/olitomlinson/dapr-mq
+Project-URL: Documentation, https://github.com/olitomlinson/dapr-mq/blob/main/sdks/python/docs/CLIENT_SDK.md
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: grpcio-health-checking>=1.66
+Requires-Dist: grpcio>=1.66
+Requires-Dist: httpx>=0.27
+Requires-Dist: protobuf>=5.27
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: grpcio-tools>=1.66; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: testcontainers>=4.8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# daprmq-client
+
+Async Python client SDK for [DaprMQ](https://github.com/olitomlinson/dapr-mq), a FIFO queue built on Dapr actors.
+
+```sh
+pip install daprmq-client --pre
+```
+
+```python
+from daprmq_client import DaprMQClient, EnqueueItem
+
+async with DaprMQClient(http_base_url="http://localhost:8002", grpc_address="localhost:8003") as client:
+    await client.enqueue("orders", [EnqueueItem(item={"id": 1})])
+```
+
+DaprMQ is pre-release: versions are `0.0.0aN`, so `pip` needs `--pre` (or an explicit version) to install one.
+
+See the [SDK guide](https://github.com/olitomlinson/dapr-mq/blob/main/sdks/python/docs/CLIENT_SDK.md) for
+consumers, sessions, retries and the full API. Licensed under Apache-2.0.

daprmq_client-0.0.0a4/README.md

@@ -0,0 +1,19 @@
+# daprmq-client
+
+Async Python client SDK for [DaprMQ](https://github.com/olitomlinson/dapr-mq), a FIFO queue built on Dapr actors.
+
+```sh
+pip install daprmq-client --pre
+```
+
+```python
+from daprmq_client import DaprMQClient, EnqueueItem
+
+async with DaprMQClient(http_base_url="http://localhost:8002", grpc_address="localhost:8003") as client:
+    await client.enqueue("orders", [EnqueueItem(item={"id": 1})])
+```
+
+DaprMQ is pre-release: versions are `0.0.0aN`, so `pip` needs `--pre` (or an explicit version) to install one.
+
+See the [SDK guide](https://github.com/olitomlinson/dapr-mq/blob/main/sdks/python/docs/CLIENT_SDK.md) for
+consumers, sessions, retries and the full API. Licensed under Apache-2.0.

daprmq_client-0.0.0a4/docs/CLIENT_SDK.md

@@ -0,0 +1,215 @@
+# daprmq-client (Python)
+
+An async Python client for DaprMQ's HTTP/gRPC API - `DaprMQClient` for direct queue and session operations, plus `SessionQueueConsumer`, a managed multi-session consume loop built on the `ConsumeSession` streaming RPC. Lives at `sdks/python/`, physically separate from the server codebase under `dotnet/`. Built on `httpx` (REST) and `grpc.aio` (streaming) - every public method is a coroutine.
+
+## Install / Reference
+
+```bash
+pip install daprmq-client --pre
+```
+
+DaprMQ is pre-release (`0.0.0aN`), so `--pre` or an explicit version is needed. To work on the SDK itself,
+install from the local path (editable):
+
+```bash
+uv pip install -e path/to/sdks/python
+```
+
+or add it as a path dependency in your own `pyproject.toml`:
+
+```toml
+[project]
+dependencies = ["daprmq-client @ file:///path/to/sdks/python"]
+```
+
+The gRPC stubs under `daprmq_client/grpc/` are generated from the shared proto contract (`dotnet/src/DaprMQ.ApiServer/Protos/daprmq.proto` - the same source of truth the .NET and TypeScript SDKs use) and checked in; re-run `python scripts/generate_grpc.py` from `sdks/python/` after the proto changes.
+
+## Constructing a client
+
+```python
+from daprmq_client import DaprMQClient
+
+async with DaprMQClient(
+    http_base_url="http://localhost:8002",
+    grpc_address="localhost:8003",
+) as client:
+    ...  # client.aclose() runs automatically on exit
+```
+
+or without the context manager:
+
+```python
+client = DaprMQClient(http_base_url="http://localhost:8002", grpc_address="localhost:8003")
+try:
+    ...
+finally:
+    await client.aclose()
+```
+
+`DaprMQClient` is REST-backed for every operation except `consume_session`, which is the one method built on the `ConsumeSession` gRPC streaming RPC - everything else (`enqueue`, `dequeue_locked`, `acknowledge`, `acknowledge_batch`, `extend_lock`, `nack`, `dead_letter`, `accept_session`, `renew_session_lease`, `release_session`) is a plain HTTP call under the hood (via `httpx.AsyncClient`).
+
+`grpc_address` is required unless you pass a pre-built `grpc_stub` (e.g. in tests - `http_client`/`grpc_stub` are both DI/test seams). `aclose()` only tears down the `httpx.AsyncClient`/gRPC channel this instance built itself; an `http_client` or `grpc_stub` you supplied yourself is left alone.
+
+Errors map to typed exceptions exported alongside the client (`LockNotFoundError`, `LockExpiredError`, `SessionNotFoundError`, `SessionLockedError`, `SessionLeaseExpiredError`, `InvalidLeaseIdError`, `SessionActorUnavailableError`, `NoSessionsAvailableError`, `SessionLostError`, `ValidationError`, `ActorNotFoundError`, `DaprMQUnavailableError`, `DeliveryUnknownError`), all deriving from `DaprMQError`. A `204 No Content` (queue empty / no session available) is not an error - `dequeue_locked`/`accept_session` return `None` instead of raising.
+
+## Retries, failures and waiting for a server
+
+Calls ride out a DaprMQ that briefly can't serve them, such as a worker restarting, under the shared
+contract in [RETRIES_AND_READINESS.md](../../testing/RETRIES_AND_READINESS.md). [docs/TIMEOUTS_AND_RETRIES.md](../../../docs/TIMEOUTS_AND_RETRIES.md) covers what to program for, across all SDKs:
+
+```python
+client = DaprMQClient(
+    http_base_url=..., grpc_address=...,
+    retry=RetryOptions(
+        timeout=30.0,                # default, in seconds: how long to keep retrying an outage. 0 = off
+        auto_idempotency_keys=True,  # optional: makes every enqueue safe to retry
+    ),
+)
+```
+
+- **Slow is not failed.** A call that reached a busy queue waits its turn for as long as it takes, up to your own cancellation (and a 100 s per-call safety limit). The retry timeout never cuts it short.
+- **Certainly not performed** (the server reports it couldn't serve the call, or the connection was
+  refused): retried until `timeout`, then `DaprMQUnavailableError`. Always safe to repeat later.
+- **Outcome unknown** (the connection broke after sending, or no response arrived in time): an
+  `enqueue` whose items all have an `idempotency_key`, and `acknowledge_batch`, are retried; anything else raises
+  `DeliveryUnknownError` straight away. It carries the `operation`, the `queue_id` and, for enqueue,
+  the items' `idempotency_keys`. What to do next:
+  - **Enqueue without keys:** re-send and accept a possible duplicate.
+  - **`dequeue_locked`:** don't re-send. If it ran, the items come back when their locks expire.
+  - **Acknowledge / extend_lock / dead_letter / nack:** re-sending is safe in effect. A `LockNotFoundError`
+    then means the first attempt worked.
+- **Cancelling the task** (e.g. `asyncio.wait_for`) stops retrying as normal cancellation.
+
+`await client.wait_for_ready()` waits until queue operations can be served (gRPC health service
+`daprmq.DaprMQ.operations`), without writing anything. Bound it with `asyncio.wait_for`. Pass
+`"daprmq.DaprMQ"` to wait only for the server instance itself.
+
+## Basic queue operations
+
+```python
+from daprmq_client import EnqueueItem
+
+await client.enqueue("my-queue", [EnqueueItem(item={"task": "send_email"})])
+
+result = await client.dequeue_locked("my-queue", ttl_seconds=60)
+if result is not None:
+    for item in result.items:
+        # ... process item.item ...
+        await client.acknowledge("my-queue", item.lock_id)
+```
+
+**Competing consumers.** By default a queue serves one lock at a time - while any item is locked, further locked dequeues come back `locked` (HTTP 423). When several consumers share a queue (e.g. replicas scaled out by KEDA), pass `allow_competing_consumers=True` so each can hold its own locks concurrently.
+
+## Consuming a queue over a stream (`consume`, `QueueConsumer`)
+
+`consume` opens a gRPC stream on a plain queue. The server keeps up to `prefetch_count` locked items delivered, refills as they are settled, and renews their locks until they are settled, so there's no polling and no `extend_lock`:
+
+```python
+import contextlib
+
+async with contextlib.aclosing(client.consume(
+    "my-queue", prefetch_count=50, allow_competing_consumers=True,
+    on_settle_failed=lambda lock_id, err: log.warning("settle %s: %s", lock_id, err),
+)) as stream:
+    async for delivery in stream:
+        # ... process delivery.item; delivery.delivery_count is 1 on a first delivery ...
+        await delivery.ack()  # or nack() / dead_letter()
+```
+
+A rejected settle doesn't end the stream: it goes to `on_settle_failed`. Leaving the loop, or setting the `cancel` event, half-closes the stream: the server applies the settles already sent and returns every unsettled item straight away (`aclosing` waits for that). Settling afterwards raises `StreamClosedError`.
+
+`QueueConsumer` is the recommended way to run a long-lived consumer. It runs your handler over the stream and reopens it with backoff if it breaks:
+
+```python
+from daprmq_client import QueueConsumer, QueueConsumerOptions, QueueMessageContext
+
+async def handler(ctx: QueueMessageContext) -> None:
+    # ctx.lock_id, ctx.item, ctx.priority, ctx.delivery_count
+    await process(ctx.item)  # returning acks; raising applies on_handler_error
+
+async with QueueConsumer(client, "my-queue", QueueConsumerOptions(max_concurrent_handlers=10), handler):
+    ...  # run your application
+```
+
+Stopping - `await consumer.stop()`, or leaving the `async with` - stops handing out messages, lets running handlers finish and settle for up to `drain_timeout_seconds`, then closes the stream, so the server returns every message the consumer held but hadn't started straight away. For a job that takes a batch and exits (a KEDA ScaledJob, a cron job), use `dequeue_locked` instead: a stream's prefetch would lock messages the job never handles.
+
+| Option | Default | Notes |
+| --- | --- | --- |
+| `max_active_messages` | 100 | The stream's prefetch count: messages locked to this consumer, handled or waiting |
+| `max_concurrent_handlers` | 0 (unlimited) | Bounded by `max_active_messages` |
+| `lock_ttl_seconds` | 30 s | The server renews each lock until its message is settled |
+| `allow_competing_consumers` | `true` | Replicas share the queue |
+| `strict_order` | `false` | Queue order even after a nack: a window of 1, one handler, no competing consumers |
+| `on_handler_error` | `QueueHandlerFailureAction.NACK` | Or `DEAD_LETTER` |
+| `max_retriable_errors_per_sec` | 10 | Paces nacks after handler errors; 0 for unpaced |
+| `min_backoff_seconds` / `max_backoff_seconds` | 1 / 60 | Seconds before reopening a broken stream; doubles per break, resets after a delivery |
+| `drain_timeout_seconds` | 30 s | |
+## Sessions - manual API
+
+For sticky routing, admin tooling, or callers who don't want a managed consume loop:
+
+```python
+lease = await client.accept_session("my-queue", session_id="order-42")
+if lease is not None:
+    dequeued = await client.dequeue_locked(f"my-queue-session-{lease.session_id}", lease_id=lease.lease_id)
+    # ... acknowledge/extend_lock/dead_letter against the same derived queue id + lease_id ...
+    await client.release_session("my-queue", lease.session_id, lease.lease_id)
+```
+
+See [API_REFERENCE.md](../../../docs/API_REFERENCE.md#sessions) and [design/sessions.md](../../../docs/design/sessions.md) for the underlying actor-id convention and lease semantics.
+
+## Sessions - managed consume loop (`SessionQueueConsumer`)
+
+`SessionQueueConsumer` is the recommended way to consume sessions: it runs `max_concurrent_sessions` independent slots, each looping over its own `consume_session` stream - claim a session, hand each delivered item to your handler, ack or dead-letter it, repeat until the session drains, then claim another. No manual lease heartbeating is needed; the server renews the lease on its own schedule for as long as the stream stays open.
+
+```python
+from daprmq_client import SessionHandlerFailureAction, SessionQueueConsumer, SessionQueueConsumerOptions
+
+options = SessionQueueConsumerOptions(
+    max_concurrent_sessions=8,
+    lease_seconds=30,
+    prefetch_count=1,
+    on_handler_exception=SessionHandlerFailureAction.DEAD_LETTER_MESSAGE,
+)
+
+async def handler(context):
+    # context.session_id, context.lock_id, context.item, context.priority
+    await process(context.item)
+    # returning normally acks the item; raising triggers on_handler_exception's behavior
+
+async with SessionQueueConsumer(client, "my-queue", options, handler):
+    ...  # consumer.start() ran on entry; consumer.stop() runs on exit
+```
+
+`stop()` stops claiming sessions and closes idle streams at once. A handler that is running finishes and its message is settled (acked, or per `on_handler_exception`) before its stream closes; prefetched messages not yet handled return with their session. Slot tasks still running after `drain_timeout_seconds` (default 30) are cancelled, which raises `CancelledError` in the handler. `stop()` returns once every stream has closed, so the sessions are released by then. A `consume_session` stream stopped by its `cancel` event, by leaving the `async for` (close it with `contextlib.aclosing` to wait), or by an error half-closes: settlements already sent are applied before the session is released, and the call is cancelled only if the server hasn't ended it within 5 s. Settling after that raises `DaprMQError`.
+
+`session_idle_timeout_seconds` releases a session once no message has arrived for that long, so the slot moves on to another (default 0 = the server default, `lease_seconds`). Lower it when sessions are short and publishers don't add to them later; it's also a `consume_session` argument.
+
+`on_handler_exception` is one of `DEAD_LETTER_MESSAGE` (default), `NACK_MESSAGE` (return the item to the front of the session for redelivery - counts toward the server's max delivery count, past which it is dead-lettered), `ABANDON_SESSION`, or `BOTH`. Session ordering holds only at the default prefetch of 1: with a larger prefetch, items already delivered are handled before a nacked item comes back.
+
+`await client.acknowledge_batch(queue_id, lock_ids, lease_id=...)` settles up to 1,000 locks in one call (one actor turn, one state save), typically everything a bulk `dequeue_locked(count=n)` returned. It returns `AcknowledgeBatchResult(items_acknowledged, results)` with one `LockAcknowledgeResult(lock_id, outcome)` per lock in request order; `outcome` is one of the `AcknowledgeOutcome` constants (`ACKNOWLEDGED`, `LOCK_NOT_FOUND`, `LOCK_EXPIRED`, `INVALID_LOCK_ID`). A lock that can't be settled never fails the others; only a whole-call problem raises (`SessionLeaseExpiredError`, `InvalidLeaseIdError`, `ValidationError` for an empty list, more than 1,000 ids or duplicates). An unknown outcome is retried automatically, so after a retry `LOCK_NOT_FOUND` can mean the first attempt already settled that lock.
+
+`await client.nack(queue_id, lock_id, lease_id=...)` (and `await delivery.nack()` on a `SessionDelivery`) returns a locked item to its original position; it returns `NackResult(dead_lettered, delivery_count, dlq_id)`.
+
+or without the context manager:
+
+```python
+consumer = SessionQueueConsumer(client, "my-queue", options, handler)
+consumer.start()
+# ... run your application ...
+await consumer.stop()  # stops claiming, lets in-flight handlers settle, closes streams
+```
+
+`SessionMessageContext` deliberately has no `lease_id` - the `ConsumeSession` wire protocol never exposes one to the client (the server tracks it internally and applies it when calling `acknowledge`/`dead_letter` on your behalf), which is exactly what makes the managed loop simpler than the manual API above.
+
+Sticky routing to one specific session: set `target_session_id` alongside `max_concurrent_sessions=1` (any other combination raises `ValueError` - a targeted claim only ever occupies one slot).
+
+On a failed claim (no session currently available), a slot backs off with a doubling/cap/reset-on-success shape (`min_backoff_seconds` → `max_backoff_seconds`, reset to `min_backoff_seconds` the moment a claim succeeds).
+
+### Why one shared client
+
+**All of a `SessionQueueConsumer`'s `max_concurrent_sessions` slots share the single `DaprMQClient` (and its one gRPC channel) passed into its constructor** - never construct a separate `DaprMQClient` per slot. A gRPC channel multiplexes every RPC, including long-lived streams, over one (or a small number of, if the server's per-connection stream cap is exceeded) underlying HTTP/2 connection - this is what makes running 10s-100s of concurrent `consume_session` streams cheap. Giving each slot its own channel would open that many separate HTTP/2 connections for no benefit - see the "multiplexing many sessions over one stream" discussion in [design/sessions.md](../../../docs/design/sessions.md) for the full reasoning.
+
+## Testing your own code against this SDK
+
+`DaprMQClient`'s `http_client`/`grpc_stub` constructor arguments are DI/test seams - substitute a fake `httpx.AsyncTransport` and a fake gRPC stub to exercise code that depends on `DaprMQClient` without a live server. See `sdks/python/tests/fake_transport.py` and `sdks/python/tests/fake_grpc_stub.py` for the pattern this SDK's own test suite uses.