patchwork-client-redis 1.0.0__tar.gz

patchwork_client_redis-1.0.0/.gitignore

@@ -0,0 +1,68 @@
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/dictionaries
+.idea/**/shelf
+.idea/**/modules.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+cmake-build-release/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# lib build
+build/
+dist/
+django-pool.egg.info/
+.env/
+django_pool.egg-info/
+/doc/site/
+/node/patchwork/node/settings.json
+.pytest_cache/
+/patchwork_client_kafka.egg-info/
+**/__pycache__
+*.pyc
+# build metadata
+*.egg-info/

patchwork_client_redis-1.0.0/.gitlab-ci.yml

@@ -0,0 +1,220 @@
+# Advise GitLab that these environment vars should be loaded from the Variables config.
+variables:
+  PROD_PYPI_TOKEN: SECURE
+  TEST_PYPI_TOKEN: SECURE
+
+include:
+  - template: Dependency-Scanning.gitlab-ci.yml
+
+default:
+  image: ghcr.io/astral-sh/uv:python3.11-bookworm
+
+gemnasium-python-dependency_scanning:
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+
+stages:
+  - test
+  - build
+  - deploy
+
+.test:
+  cache:
+    key: uv-cache
+    paths:
+      - .uv/
+      - .cache/uv/
+
+  before_script:
+    - uv --version
+    - uv sync --all-extras --dev
+
+  script:
+    - uv run pytest tests
+
+# Python matrix tests
+test 3.11:
+  extends: .test
+  image: ghcr.io/astral-sh/uv:python3.11-bookworm
+
+test 3.12:
+  extends: .test
+  image: ghcr.io/astral-sh/uv:python3.12-bookworm
+
+test 3.13:
+  extends: .test
+  image: ghcr.io/astral-sh/uv:python3.13-bookworm
+
+
+coverage:
+  image: ghcr.io/astral-sh/uv:python3.11-bookworm
+
+  only:
+    - master
+    - merge_requests
+
+  before_script:
+    - uv sync --all-extras --dev
+
+  script:
+    - uv run pytest --cov=. tests
+    - uv run coverage xml
+
+  coverage: '/TOTAL.+ ([0-9]{1,3}%)/'
+
+
+doc:
+  stage: build
+
+  only:
+    - /^client-redis-\d+\.\d+(\.\d+)?(\.?(a|b|rc)\d*)?$/
+    - merge_requests
+
+  script:
+    - uv sync --extra docs
+    - uv run mkdocs build -f doc/mkdocs.yml
+
+  artifacts:
+    paths:
+      - doc/site/
+    expire_in: 1d
+
+pages:
+  stage: deploy
+  only:
+    - /^client-redis-\d+\.\d+(\.\d+)?(\.?(a|b|rc)\d*)?$/
+
+  needs:
+    - job: doc
+      artifacts: true
+
+  script:
+    - mkdir -p public/
+    - cp -r doc/site/* public/
+
+  artifacts:
+    paths:
+      - public
+
+compute_version:
+  stage: test
+  image: ghcr.io/astral-sh/uv:python3.11-bookworm
+
+  before_script:
+    - git checkout -B "$CI_COMMIT_REF_NAME" "$CI_COMMIT_SHA"
+    - uv sync --group dev
+
+  script:
+    - git fetch --tags --unshallow || git fetch --tags
+    - |
+      LAST=$(uv run semantic-release version --print-last-released)
+      NEXT=$(uv run semantic-release version --print)
+      if [ "$LAST" = "$NEXT" ]; then
+        echo "SHOULD_RELEASE=false" >> release.env
+        echo "VERSION=" >> release.env
+        echo "No new version to release, skipping RC build"
+      else
+        echo "SHOULD_RELEASE=true" >> release.env
+        echo "VERSION=$NEXT" >> release.env
+        echo "Next version: $NEXT"
+      fi
+
+  artifacts:
+    reports:
+      dotenv: release.env
+
+  only:
+    - master
+
+publish_rc:
+  stage: build
+  image: ghcr.io/astral-sh/uv:python3.11-bookworm
+
+  needs:
+    - job: compute_version
+      artifacts: true
+
+  rules:
+    - if: '$CI_COMMIT_BRANCH == "master"'
+
+  before_script:
+    - |
+      if [ "$SHOULD_RELEASE" = "true" ]; then
+        echo "Publishing RC for version $VERSION"
+        # your publish logic here
+      else
+        echo "No release needed, skipping publish"
+        exit 0
+      fi
+    - git fetch --tags --unshallow || true
+    - uv sync --group dev
+
+  script: |
+    BASE_TAG=$(git describe --tags --abbrev=0 --match "client-redis-*" 2>/dev/null || echo "")
+    if [ -n "$BASE_TAG" ]; then
+      RC=$(git rev-list ${BASE_TAG}..HEAD --count)
+    else
+      RC=$(git rev-list HEAD --count)
+    fi
+    RC_VERSION="${VERSION}rc${RC}"
+    echo "Building RC version: $RC_VERSION"
+    export SETUPTOOLS_SCM_PRETEND_VERSION="$RC_VERSION"
+    uv build
+    ls -lah dist/
+    uv publish --index testpypi --token "$TEST_PYPI_TOKEN"
+
+tag_release:
+  stage: deploy
+  image: ghcr.io/astral-sh/uv:python3.11-bookworm
+  when: manual
+
+  needs:
+    - job: compute_version
+      artifacts: true
+
+  rules:
+    - if: '$CI_COMMIT_BRANCH == "master"'
+
+  before_script:
+    - |
+      if [ "$SHOULD_RELEASE" = "true" ]; then
+        echo "Releasing for version $VERSION"
+      else
+        echo "No pending RC release, can't create release tag"
+        exit 1
+      fi
+    - apt-get update
+    - export DEBIAN_FRONTEND=noninteractive
+    - apt-get -y install git curl jq gawk
+
+  script: |
+    git fetch --tags
+    TAG="client-redis-$VERSION"
+    export VERSION_TAG_EXISTS=$(git tag | grep $VERSION | wc -l)
+    test $VERSION_TAG_EXISTS -eq 1 && exit 0  # exit if version already exist
+    echo "Creating release of version $VERSION"
+    jq -n --arg version "$TAG" --arg desc "$CI_COMMIT_MESSAGE" --arg sha "$CI_COMMIT_SHA" '{ "name":$version, "tag_name":$version, "description":$desc, "ref":$sha, "assets":{}}' > release-tmp.txt
+    cat release-tmp.txt
+    curl --header "Content-Type:application/json" --header "PRIVATE-TOKEN:$RELEASE_API_TOKEN" --data @release-tmp.txt --request POST $CI_API_V4_URL/projects/$CI_PROJECT_ID/releases -v
+
+
+upload_pypi:
+  stage: deploy
+  image: ghcr.io/astral-sh/uv:python3.11-bookworm
+
+  before_script:
+    - git fetch --tags --unshallow || true
+    - uv sync --group dev
+
+  script:
+    - FULL_TAG=$(git describe --tags --exact-match --match "client-redis-*")
+    - VERSION=${FULL_TAG#client-redis-}
+    - echo "Publishing version $VERSION"
+
+    - export SETUPTOOLS_SCM_PRETEND_VERSION="$VERSION"
+
+    - uv build
+    - uv publish --token $PROD_PYPI_TOKEN
+
+  only:
+    - /^client-redis-\d+\.\d+(\.\d+)?(\.?(a|b|rc)\d*)?$/

patchwork_client_redis-1.0.0/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,25 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="PyCompatibilityInspection" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="ourVersions">
+        <value>
+          <list size="2">
+            <item index="0" class="java.lang.String" itemvalue="3.10" />
+            <item index="1" class="java.lang.String" itemvalue="3.11" />
+          </list>
+        </value>
+      </option>
+    </inspection_tool>
+    <inspection_tool class="PyInterpreterInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="PyPackageRequirementsInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="PyStubPackagesAdvertiser" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="ignoredPackages">
+        <list>
+          <option value="pandas" />
+        </list>
+      </option>
+    </inspection_tool>
+  </profile>
+</component>

patchwork_client_redis-1.0.0/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

patchwork_client_redis-1.0.0/.idea/patchwork-client-redis.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="PackageRequirementsSettings" />
+  <component name="PyDocumentationSettings" />
+  <component name="ReSTService" />
+  <component name="TestRunnerService" />
+</module>

patchwork_client_redis-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

patchwork_client_redis-1.0.0/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: patchwork-client-redis
+Version: 1.0.0
+Summary: Redis Streams client for Patchwork - The distributed asynchronous microframework
+Author: Paweł Pecio
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.11.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: patchwork-core<3,>=2.0.0
+Requires-Dist: redis>=5.0
+Provides-Extra: docs
+Requires-Dist: mkdocs<2,==1.6.1; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocstrings[python]; extra == "docs"
+Dynamic: license-file
+
+# Patchwork Client Redis
+
+Redis Streams client for Patchwork - an asynchronous distributed microframework.
+
+## Requirements
+
+* Python 3.11+
+* Redis 7.0+
+* `patchwork-core` 2.0+
+
+## Installation
+
+``pip install patchwork-client-redis``
+
+## Development
+
+```bash
+uv sync --all-extras --dev
+uv run pytest tests
+REDIS_URL=redis://127.0.0.1:6379/0 uv run pytest int
+```
+
+## Documentation
+
+https://patchwork-framework.gitlab.io/redis-client

patchwork_client_redis-1.0.0/README.md

@@ -0,0 +1,25 @@
+# Patchwork Client Redis
+
+Redis Streams client for Patchwork - an asynchronous distributed microframework.
+
+## Requirements
+
+* Python 3.11+
+* Redis 7.0+
+* `patchwork-core` 2.0+
+
+## Installation
+
+``pip install patchwork-client-redis``
+
+## Development
+
+```bash
+uv sync --all-extras --dev
+uv run pytest tests
+REDIS_URL=redis://127.0.0.1:6379/0 uv run pytest int
+```
+
+## Documentation
+
+https://patchwork-framework.gitlab.io/redis-client

patchwork_client_redis-1.0.0/doc/docs/changelog.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 1.0.0
+
+First release:
+
+- `AsyncRedisPublisher` (`XADD`) and `AsyncRedisSubscriber` (`XREADGROUP` consumer groups)
+- commits with `XACK` in any order, native rollback with `XCLAIM` and broker delivery counter
+- taking over messages of dead consumers with `XAUTOCLAIM` (`claim_idle_ms`), recovery of own pending messages
+  after restart with a stable consumer name
+- automatic consumer group creation and re-creation, retries on connection errors, subscriber failure instead
+  of hanging
+- passes Patchwork client contract tests (patchwork-core 2.0)

patchwork_client_redis-1.0.0/doc/docs/contribution.md

@@ -0,0 +1,23 @@
+# Contribution
+
+```bash
+uv sync --all-extras --dev
+uv run pytest tests
+uv run ruff check patchwork tests int
+```
+
+Unit tests and client contract tests in `tests/` run against [fakeredis](https://github.com/cunla/fakeredis-py).
+To run them against a real Redis set `REDIS_TEST_URL`, the database is **flushed** before each test, use
+a dedicated one:
+
+```bash
+docker compose -f docker-compose.ci.yml up -d
+REDIS_TEST_URL=redis://127.0.0.1:6379/15 uv run pytest tests
+```
+
+Integration tests in `int/` run the client contract test suite against a real Redis (keys are prefixed and removed
+after tests):
+
+```bash
+REDIS_URL=redis://127.0.0.1:6379/0 uv run pytest int
+```

patchwork_client_redis-1.0.0/doc/docs/getstarted.md

@@ -0,0 +1,58 @@
+# Getting started
+
+```python
+import asyncio
+
+from patchwork.client.redis import AsyncRedisPublisher, AsyncRedisSubscriber
+
+URL = 'redis://localhost:6379/0'
+
+
+async def main():
+    async with (
+        AsyncRedisPublisher(url=URL) as publisher,
+        AsyncRedisSubscriber(url=URL, queues=['orders'], group='billing') as subscriber,
+    ):
+        await publisher.send({'order': 1}, queue='orders', type='order.created')
+
+        delivery = await subscriber.get(timeout=5)
+        print(delivery.message.type, delivery.message.get_payload())
+        await subscriber.commit(delivery)
+
+
+asyncio.run(main())
+```
+
+## With Patchwork node
+
+```python
+from patchwork.client.redis import AsyncRedisPublisher, AsyncRedisSubscriber
+from patchwork.node import Worker
+from patchwork.node.core import TaskRouter
+from patchwork.node.node import run
+from patchwork.node.processor import InlineUnit
+
+URL = 'redis://redis:6379/0'
+
+router = TaskRouter(processor=InlineUnit(concurrency=10))
+
+
+@router.on('order.created')
+async def order_created(message):
+    ...
+
+
+worker = Worker(
+    subscriber=AsyncRedisSubscriber(url=URL, queues=['orders'], group='billing', consumer='billing-0'),
+    publisher=AsyncRedisPublisher(url=URL, postpone_queue='postpone'),
+)
+worker.add_router(router)
+
+if __name__ == '__main__':
+    run(worker)
+```
+
+!!! hint
+
+    Set `consumer` to a stable name (eg. Kubernetes pod name), so messages pending on the consumer are delivered
+    again immediately after restart instead of waiting for `claim_idle_ms`.

patchwork_client_redis-1.0.0/doc/docs/index.md

@@ -0,0 +1,29 @@
+# Patchwork Client Redis
+
+[Redis Streams](https://redis.io/docs/latest/develop/data-types/streams/) client for
+[Patchwork](https://patchwork-framework.gitlab.io/core): `AsyncRedisPublisher` and `AsyncRedisSubscriber`
+implementing the Patchwork client contract.
+
+- each queue is a stream, messages are appended with `XADD`
+- subscribers read in consumer groups (`XREADGROUP`), each group receives all messages, consumers in a group
+  compete for messages
+- commits acknowledge single messages (`XACK`) in any order
+- native rollback: the message is claimed back and delivered again, broker delivery counter is reported as
+  `Delivery.redelivered`
+- messages of consumers which went away are taken over after `claim_idle_ms` (`XAUTOCLAIM`)
+- failures are never silent: connection errors are retried, then the subscriber stops and `get()` raises
+  `SubscriberClosed`
+
+## Installation
+
+```bash
+pip install patchwork-client-redis
+```
+
+Requires Python 3.11+, Redis 7.0+ and patchwork-core 2.0+.
+
+!!! note
+
+    Redis streams don't support delayed delivery. Messages with `not_before` in the future are sent to the
+    publisher `postpone_queue` and forwarded by the [patchwork-postponer](https://gitlab.com/patchwork-framework/postponer)
+    service.

patchwork_client_redis-1.0.0/doc/docs/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2019 - 2020
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

patchwork_client_redis-1.0.0/doc/docs/source.md

@@ -0,0 +1,9 @@
+# Source code
+
+Project source code can be found at [GitLab](https://gitlab.com/patchwork-framework/redis-client).
+
+Package name: `patchwork-client-redis`
+
+::: patchwork.client.redis.publisher
+::: patchwork.client.redis.subscriber
+::: patchwork.client.redis.common