redqueue 0.10.0__py3-none-any.whl

redqueue/serialization.py

@@ -0,0 +1,79 @@
+# SPDX-License-Identifier: Apache-2.0
+# Author: SpringMirror-pear
+
+"""Serialization protocol and default codecs."""
+
+from __future__ import annotations
+
+import json
+from typing import Any, Protocol, runtime_checkable
+
+from redqueue.exceptions import MessageDecodeError, MessageEncodeError
+
+
+@runtime_checkable
+class Serializer(Protocol):
+    """Protocol implemented by RedQueue payload serializers."""
+
+    content_type: str
+
+    def encode(self, payload: Any, *, queue: str | None = None) -> bytes:
+        """Encode a Python payload into Redis-safe bytes."""
+
+    def decode(self, payload: bytes, *, queue: str | None = None) -> Any:
+        """Decode Redis bytes into a Python payload."""
+
+
+class JsonSerializer:
+    """JSON serializer used by default."""
+
+    content_type = "application/json"
+
+    def __init__(
+        self,
+        *,
+        ensure_ascii: bool = False,
+        sort_keys: bool = True,
+    ) -> None:
+        self.ensure_ascii = ensure_ascii
+        self.sort_keys = sort_keys
+
+    def encode(self, payload: Any, *, queue: str | None = None) -> bytes:
+        if isinstance(payload, bytes):
+            return payload
+        if isinstance(payload, (bytearray, memoryview)):
+            return bytes(payload)
+        try:
+            encoded = json.dumps(
+                payload,
+                ensure_ascii=self.ensure_ascii,
+                separators=(",", ":"),
+                sort_keys=self.sort_keys,
+            )
+            return encoded.encode("utf-8")
+        except (TypeError, ValueError) as exc:
+            raise MessageEncodeError.from_exception(
+                exc,
+                queue=queue,
+                details={"serializer": self.__class__.__name__},
+            ) from exc
+
+    def decode(self, payload: bytes, *, queue: str | None = None) -> Any:
+        if not isinstance(payload, (bytes, bytearray, memoryview)):
+            raise MessageDecodeError(
+                "serialized payload must be bytes-like",
+                action="message.decode",
+                queue=queue,
+                details={
+                    "serializer": self.__class__.__name__,
+                    "payload_type": type(payload).__name__,
+                },
+            )
+        try:
+            return json.loads(bytes(payload).decode("utf-8"))
+        except (UnicodeDecodeError, json.JSONDecodeError) as exc:
+            raise MessageDecodeError.from_exception(
+                exc,
+                queue=queue,
+                details={"serializer": self.__class__.__name__},
+            ) from exc

redqueue-0.10.0.dist-info/METADATA

@@ -0,0 +1,312 @@
+Metadata-Version: 2.4
+Name: redqueue
+Version: 0.10.0
+Summary: Redis-backed Python message queue library with List, Streams, delayed tasks, and monitoring.
+Project-URL: Homepage, https://github.com/SpringMirror-pear/redqueue
+Project-URL: Repository, https://github.com/SpringMirror-pear/redqueue.git
+Project-URL: Issues, https://github.com/SpringMirror-pear/redqueue/issues
+Author: SpringMirror-pear
+Maintainer: SpringMirror-pear
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: delayed-jobs,message-queue,queue,redis,streams
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: redis==6.4.0
+Provides-Extra: dev
+Requires-Dist: mypy==2.1.0; (python_version >= '3.10') and extra == 'dev'
+Requires-Dist: pytest-asyncio==1.4.0; (python_version >= '3.10') and extra == 'dev'
+Requires-Dist: pytest==9.1.1; (python_version >= '3.10') and extra == 'dev'
+Requires-Dist: ruff==0.15.18; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# RedQueue
+
+RedQueue is a Redis-backed Python message queue library with List, Streams,
+delayed tasks, synchronous APIs, asynchronous APIs, compatibility checks, and
+monitoring hooks.
+
+RedQueue 是一个基于 Redis 的 Python 消息队列库，支持 List、Streams、延迟任务、
+同步 API、异步 API、兼容性检查和监控 hook。
+
+Repository / 仓库：
+https://github.com/SpringMirror-pear/redqueue.git
+
+## Features / 功能
+
+- Redis List reliable queue with `BLMOVE` on Redis `>=6.2` and `BRPOPLPUSH`
+  fallback on older compatible Redis versions.
+- Redis Streams backend with consumer groups. Streams require Redis `>=5.0`.
+- Delayed tasks based on Redis Sorted Set.
+- Sync client `QueueClient` and async client `AsyncQueueClient`.
+- Unified exception hierarchy with structured context.
+- Monitoring events for publish, consume, ack, nack, retry, dead letter, delay,
+  and backend errors.
+- Redis capability detection from `INFO server`.
+- Apache License 2.0.
+
+- 基于 Redis List 的可靠队列：Redis `>=6.2` 使用 `BLMOVE`，低版本兼容时回退
+  `BRPOPLPUSH`。
+- 基于 Redis Streams 的消费组后端，Streams 要求 Redis `>=5.0`。
+- 基于 Redis Sorted Set 的延迟任务。
+- 同步客户端 `QueueClient` 与异步客户端 `AsyncQueueClient`。
+- 带结构化上下文的统一异常体系。
+- 针对发布、消费、确认、拒绝、重试、死信、延迟和后端错误的监控事件。
+- 通过 `INFO server` 探测 Redis 能力。
+- Apache License 2.0。
+
+## Compatibility / 兼容性
+
+Runtime:
+
+- Python `>=3.9`
+- redis-py `6.4.0`
+- Target development environment: Python `3.14.5`
+
+Redis:
+
+| Feature | Redis requirement | Notes |
+| --- | --- | --- |
+| List blocking consume | `>=2.0` | Uses `BLPOP` family compatibility baseline |
+| List reliable move | `>=2.2` | Uses `BRPOPLPUSH`; `BLMOVE` preferred on `>=6.2` |
+| Streams | `>=5.0` | Uses `XADD`, `XGROUP CREATE`, `XREADGROUP` |
+| Streams auto claim | `>=6.2` | Uses `XAUTOCLAIM`; Redis 5.x uses `XPENDING`/`XCLAIM` fallback |
+| Delayed tasks | `>=1.2` | Uses `ZADD` and timestamp scores |
+
+运行环境：
+
+- Python `>=3.9`
+- redis-py `6.4.0`
+- 目标开发环境：Python `3.14.5`
+
+Redis：
+
+| 功能 | Redis 要求 | 说明 |
+| --- | --- | --- |
+| List 阻塞消费 | `>=2.0` | 以 `BLPOP` 系列能力为基础 |
+| List 可靠搬移 | `>=2.2` | 使用 `BRPOPLPUSH`；Redis `>=6.2` 优先使用 `BLMOVE` |
+| Streams | `>=5.0` | 使用 `XADD`、`XGROUP CREATE`、`XREADGROUP` |
+| Streams 自动认领 | `>=6.2` | 使用 `XAUTOCLAIM`；Redis 5.x 回退 `XPENDING`/`XCLAIM` |
+| 延迟任务 | `>=1.2` | 使用 `ZADD` 和时间戳 score |
+
+## Installation / 安装
+
+```bash
+pip install redqueue
+```
+
+For local development:
+
+```bash
+python -m pip install -r requirements.txt
+```
+
+本地开发：
+
+```bash
+python -m pip install -r requirements.txt
+```
+
+## Quick Start / 快速开始
+
+Synchronous List queue:
+
+```python
+from redqueue import QueueClient
+
+client = QueueClient.from_url(
+    "redis://127.0.0.1:6379/0",
+    queue="emails",
+    backend="list",
+)
+
+message_id = client.publish({"to": "user@example.com"})
+message = client.consume(timeout=1)
+
+if message is not None:
+    try:
+        print(message.payload)
+        client.ack(message)
+    except Exception:
+        client.retry(message, reason="handler failed")
+```
+
+同步 List 队列：
+
+```python
+from redqueue import QueueClient
+
+client = QueueClient.from_url(
+    "redis://127.0.0.1:6379/0",
+    queue="emails",
+    backend="list",
+)
+
+message_id = client.publish({"to": "user@example.com"})
+message = client.consume(timeout=1)
+
+if message is not None:
+    try:
+        print(message.payload)
+        client.ack(message)
+    except Exception:
+        client.retry(message, reason="handler failed")
+```
+
+Streams backend:
+
+```python
+from redqueue import QueueClient
+
+client = QueueClient.from_url(
+    "redis://127.0.0.1:6379/0",
+    queue="events",
+    backend="stream",
+    consumer_group="redqueue",
+    consumer_name="worker-1",
+)
+
+client.publish({"event": "created"})
+message = client.consume(timeout=1)
+```
+
+Streams 后端：
+
+```python
+from redqueue import QueueClient
+
+client = QueueClient.from_url(
+    "redis://127.0.0.1:6379/0",
+    queue="events",
+    backend="stream",
+    consumer_group="redqueue",
+    consumer_name="worker-1",
+)
+
+client.publish({"event": "created"})
+message = client.consume(timeout=1)
+```
+
+Asynchronous client:
+
+```python
+import asyncio
+
+from redqueue import AsyncQueueClient
+
+
+async def main() -> None:
+    client = await AsyncQueueClient.from_url(
+        "redis://127.0.0.1:6379/0",
+        queue="jobs",
+        backend="list",
+    )
+    await client.publish({"task": "sync"})
+    message = await client.consume(timeout=1)
+    if message is not None:
+        await client.ack(message)
+    await client.close()
+
+
+asyncio.run(main())
+```
+
+异步客户端：
+
+```python
+import asyncio
+
+from redqueue import AsyncQueueClient
+
+
+async def main() -> None:
+    client = await AsyncQueueClient.from_url(
+        "redis://127.0.0.1:6379/0",
+        queue="jobs",
+        backend="list",
+    )
+    await client.publish({"task": "sync"})
+    message = await client.consume(timeout=1)
+    if message is not None:
+        await client.ack(message)
+    await client.close()
+
+
+asyncio.run(main())
+```
+
+Delayed task:
+
+```python
+from redqueue import QueueClient
+
+client = QueueClient.from_url("redis://127.0.0.1:6379/0", queue="emails")
+client.delay({"to": "later@example.com"}, delay_seconds=60)
+released = client.schedule_due(limit=100)
+```
+
+延迟任务：
+
+```python
+from redqueue import QueueClient
+
+client = QueueClient.from_url("redis://127.0.0.1:6379/0", queue="emails")
+client.delay({"to": "later@example.com"}, delay_seconds=60)
+released = client.schedule_due(limit=100)
+```
+
+## Documentation / 文档
+
+- API: [docs/API.md](docs/API.md)
+- Changelog: [CHANGELOG.md](CHANGELOG.md)
+- Release process: [docs/RELEASE.md](docs/RELEASE.md)
+- Test guide: [tests/README.md](tests/README.md)
+
+- API 文档：[docs/API.md](docs/API.md)
+- 版本变更记录：[CHANGELOG.md](CHANGELOG.md)
+- 发布流程：[docs/RELEASE.md](docs/RELEASE.md)
+- 测试指南：[tests/README.md](tests/README.md)
+
+## Testing / 测试
+
+```bash
+PYTHONPATH=src python -m pytest
+```
+
+Run integration tests with a local Redis server:
+
+```bash
+REDQUEUE_REDIS_URL=redis://127.0.0.1:6379/0 PYTHONPATH=src python -m pytest -m integration
+```
+
+使用本地 Redis 运行集成测试：
+
+```bash
+REDQUEUE_REDIS_URL=redis://127.0.0.1:6379/0 PYTHONPATH=src python -m pytest -m integration
+```
+
+## Versioning / 版本规则
+
+Development versions and formal release versions are separate streams.
+`0.10.0devN` records development milestones. The first formal release is
+`0.10.0`.
+
+开发版本与正式版本不互通。`0.10.0devN` 用于记录开发里程碑，第一个正式版本为
+`0.10.0`。
+
+## License / 许可证
+
+Apache License 2.0. See [LICENSE](LICENSE).
+
+Apache License 2.0。详见 [LICENSE](LICENSE)。

redqueue-0.10.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+redqueue/__init__.py,sha256=qeLe-6ifOIvBeycNCEIO9A9_H125xRUPwJPLzgLOyh8,1777
+redqueue/_version.py,sha256=2ZLLZopMxv1W29sQUQYmocEn640rzezrP-Zc-tQzk1k,114
+redqueue/async_client.py,sha256=3lDfoZSp_RY0LEfMsr5MAYOFTm6wHsevfNBx6-LnTfM,6618
+redqueue/client.py,sha256=4mEXgMlrbGl2DWZl2cSxLi6h_MK18ItPBYBk7qPvBXA,5774
+redqueue/compat.py,sha256=IgLOGiSEy0_7Jjs0D66waiTGSgz3e_R18Q7shb6gEJU,5830
+redqueue/config.py,sha256=gPN09uUNWaAyDvdm-e1lau2iW3DaiykaLea8oqQdCd8,5804
+redqueue/exceptions.py,sha256=zFJ_sozK0vFA0mpHPc0D4q5tBk-P4K3LyTdF8Kt_F7s,4723
+redqueue/message.py,sha256=Ak8ao9BgOQHWGo6iG81_YQFgvZ0myNEHK9JsKJ_55ME,2319
+redqueue/monitoring.py,sha256=3po7qFyxJaukMOeCdqbfknEpf9jns9_TgwRb2ycthWo,3275
+redqueue/serialization.py,sha256=aZA-wYE2YTVq_wTqoiJGy8a5iYg87CsMSDSSBcpfY54,2547
+redqueue/backends/__init__.py,sha256=lFU7Ul-vXs88HELQckXfBBqYMdECKMKXKFIfym4NKdw,589
+redqueue/backends/async_delay.py,sha256=39owr0rq4Gw-mCkabji1oR3JaZFW6-V4WvYionwnNdA,8036
+redqueue/backends/async_list.py,sha256=NjvxKhPZqYCgiDbn1sQqs8cOATAwgEd8wovxTLI_Pxc,9831
+redqueue/backends/async_stream.py,sha256=8FT_I0wnpJBT3mYUt8auYoghTNIkcedJH_nVeOqGngc,12295
+redqueue/backends/base.py,sha256=sR3vKq9KFQ0opIB_PxBy3HXDXfxH6Z-6Jh31Q19euI8,3229
+redqueue/backends/delay.py,sha256=It6HxYk3MhLCLZfpxVDNFc0Kl50preLGodTygOKJK4Y,7916
+redqueue/backends/list.py,sha256=jmJvt79aFdKE99nMNy2cpEeZfAnnGlrtqKnHQiLE6JU,9581
+redqueue/backends/stream.py,sha256=l9J23hzV1O4RXy5R5rbbZeNGxyDE-lW0a0UtmzeL91U,11624
+redqueue-0.10.0.dist-info/METADATA,sha256=oEX4x44Uzx2UrIklOm9QcVtc8yRv7brbzQ_1mZbemxQ,8496
+redqueue-0.10.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+redqueue-0.10.0.dist-info/licenses/LICENSE,sha256=lmM37FouddNTvAQVIcCmqik-V6EWrnJ06kouztHZQuU,9075
+redqueue-0.10.0.dist-info/licenses/NOTICE,sha256=gg7MyFyC75df_QKBUgRY7W0nd9e9QiYGyIXWXMCQT9Q,107
+redqueue-0.10.0.dist-info/RECORD,,

redqueue-0.10.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

redqueue-0.10.0.dist-info/licenses/LICENSE

@@ -0,0 +1,158 @@
+Apache License
+Version 2.0, January 2004
+https://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.
+
+"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 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

redqueue-0.10.0.dist-info/licenses/NOTICE

@@ -0,0 +1,4 @@
+RedQueue
+Copyright 2026 SpringMirror-pear
+
+This product is licensed under the Apache License, Version 2.0.