🎉 init: first commit

Author: mic1on

.github/workflows/release.yml

@@ -0,0 +1,49 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*.*.*'
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+
+      - name: Build project for distribution
+        run: poetry build
+
+      - name: Check Version
+        id: check-version
+        run: |
+          [[ "$(poetry version --short)" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]] \
+            || echo ::set-output name=prerelease::true
+
+      - name: Create Release
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: "dist/*"
+          token: ${{ secrets.GITHUB_TOKEN }}
+          draft: false
+          prerelease: steps.check-version.outputs.prerelease == 'true'
+          allowUpdates: true
+
+      - name: Publish to PyPI
+        env:
+          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
+        run: poetry publish

.github/workflows/test.yml

@@ -0,0 +1,54 @@
+name: test suite
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ "ubuntu-latest" ]
+        python-version: [ "3.8", "3.9", "3.10" ]
+    runs-on: ${{ matrix.os }}
+    services:
+      rabbitmq:
+        image: redis:latest
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v2
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root
+      - name: Install library
+        run: poetry install --no-interaction
+      - name: Run tests
+        env:
+          REDIS_HOST: localhost
+        run: |
+          source .venv/bin/activate
+          pytest tests/

.gitignore

@@ -0,0 +1,138 @@
+# created by virtualenv automatically
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pycharm
+.idea
+poetry.lock
+*.DS_Store
+
+# docs/node_modules
+docs/node_modules

README.md

@@ -0,0 +1 @@
+# usepy-plugin-redis

example/demo.py

@@ -0,0 +1,24 @@
+[tool.poetry]
+name = "usepy-plugin-redis"
+version = "0.1.0"
+description = ""
+authors = ["miclon <jcnd@163.com>"]
+readme = "README.md"
+packages = [
+    { include = 'usepy_plugin_redis', from = 'src' }
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+redis = "^4.6.0"
+
+[tool.poetry.group.test.dependencies]
+pytest = [
+    { version = "^7.0.0", python = ">=3.6,<3.7" },
+    { version = "^7.3.1", python = ">=3.7" }
+]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+

pyproject.toml

@@ -0,0 +1,115 @@
+import logging
+
+import redis
+import time
+from threading import local
+
+MAX_SEND_ATTEMPTS = 6  # 最大发送重试次数
+MAX_CONNECTION_ATTEMPTS = float('inf')  # 最大连接重试次数
+MAX_CONNECTION_DELAY = 2 ** 5  # 最大延迟时间
+
+logger = logging.Logger(__name__)
+
+
+class RedisStore:
+
+    def __init__(self, *, host=None, port=None, password=None, **kwargs):
+        """
+        :param host: Redis host
+        :param port: Redis port
+        :param password: Redis password
+        :param kwargs: Redis parameters
+        """
+        self.state = local()
+        self.parameters = {
+            'host': host or 'localhost',
+            'port': port or 6379,
+            'password': password or None,
+        }
+        if kwargs:
+            self.parameters.update(kwargs)
+
+    def _create_connection(self):
+        attempts = 1
+        delay = 1
+        while attempts <= MAX_CONNECTION_ATTEMPTS:
+            try:
+                connector = redis.Redis(**self.parameters)
+                if attempts > 1:
+                    logger.warning(f"RedisStore connection succeeded after {attempts} attempts", )
+                connector.ping()
+                return connector
+            except redis.ConnectionError as exc:
+                logger.warning(f"RedisStore connection error<{exc}>; retrying in {delay} seconds")
+                attempts += 1
+                time.sleep(delay)
+                if delay < MAX_CONNECTION_DELAY:
+                    delay *= 2
+                    delay = min(delay, MAX_CONNECTION_DELAY)
+        raise redis.ConnectionError("RedisStore connection error, max attempts reached")
+
+    @property
+    def connection(self):
+        connection = getattr(self.state, "connection", None)
+        if connection is None:
+            connection = self.state.connection = self._create_connection()
+        return connection
+
+    @connection.deleter
+    def connection(self):
+        if _connection := getattr(self.state, "connection", None):
+            try:
+                _connection.close()
+            except Exception as exc:
+                logger.exception(f"RedisStore connection close error<{exc}>")
+            del self.state.connection
+
+
+class RedisStreamMixin:
+    connection: redis.Redis
+
+    def _create_group(self, stream, group):
+        try:
+            self.connection.xgroup_create(stream, group, id='0', mkstream=True)
+        except redis.exceptions.ResponseError as e:
+            if "already exists" not in str(e):
+                raise e
+
+    def send(self, stream, message, **kwargs):
+        """发送消息"""
+        attempts = 1
+        while True:
+            try:
+                self.connection.xadd(stream, message, **kwargs)
+                return message
+            except Exception as exc:
+                del self.connection
+                attempts += 1
+                if attempts > MAX_SEND_ATTEMPTS:
+                    raise exc
+
+    def start_consuming(self, stream, group, consumer, callback, prefetch=1, **kwargs):
+        """开始消费"""
+        self._create_group(stream, group)
+        while True:
+            try:
+                messages = self.connection.xreadgroup(group, consumer, {stream: '>'}, count=prefetch, **kwargs)
+                for message in messages:
+                    _, msg = message
+                    callback(msg)
+            except redis.ConnectionError:
+                logger.warning("RedisStore consume connection error, reconnecting...")
+                del self.connection
+                time.sleep(1)
+            except Exception as e:
+                logger.exception(f"RedisStore consume error<{e}>, reconnecting...")
+                del self.connection
+                time.sleep(1)
+
+
+class RedisStreamStore(RedisStore, RedisStreamMixin):
+    pass
+
+
+useRedis = RedisStore
+useRedisStreamStore = RedisStreamStore