update

Author: hsz1273327

MANIFEST.in

@@ -2,4 +2,4 @@ include LICENSE
 include README.md
 include CHANGELOG.md
 include requirements.txt
-recursive-include redisproxy *.pyx *.pxd *.pxi *.py *.c *.h *.temp *.jinja
+recursive-include redishelper *.pyx *.pxd *.pxi *.py *.c *.h *.temp *.jinja

README.md

@@ -1,4 +1,4 @@
-# redisproxy
+# redishelper
 
 提供redis客户端的代理对象功能.本项目代理的对象是[redis-py](https://github.com/redis/redis-py)中的四种客户端
 
@@ -10,7 +10,7 @@
 ## 特性
 
 + 提供了统一的代理对象`RedisProxy`用于代理`redis.Redis`,`redis.cluster.RedisCluster`,`redis.asyncio.Redis`或`redis.asyncio.cluster.RedisCluster`
-+ 针对生产者消费者模式提供了专用代理对象`ChannelConsumerProxy`,`ChannelProducerProxy`,`QueueConsumerProxy`,`QueueProducerProxy`,`StreamConsumerProxy`,`StreamProducerProxy`
++ 针对生产者消费者模式提供了专用代理对象`ChannelConsumerHelper`,`ChannelProducerHelper`,`QueueConsumerHelper`,`QueueProducerHelper`,`StreamConsumerPHelper`,`StreamProducerHelper`
 + 生产者消费者提供了进一步的封装,可以通过上下文管理连接
 
 ## 使用
@@ -64,7 +64,7 @@ await r.get(x)
 > 同步生产者
 
 ```python
-qp = cast(StreamProducerProtocol, StreamProducerProxy.from_proxy(rediscli, maxlen=20))
+qp = cast(StreamProducerProtocol, StreamProducerHelper.from_proxy(rediscli, maxlen=20))
 with qp.mount() as producer:
     for i in range(10):
         producer.publish(topic,value)
@@ -73,7 +73,7 @@ with qp.mount() as producer:
 > 异步生产者
 
 ```python
-qp = cast(AioStreamProducerProtocol, StreamProducerProxy.from_proxy(rediscli, maxlen=20))
+qp = cast(AioStreamProducerProtocol, StreamProducerHelper.from_proxy(rediscli, maxlen=20))
 async with qp.mount() as producer:
     for i in range(10):
         await producer.publish(topic,value)
@@ -82,7 +82,7 @@ async with qp.mount() as producer:
 > 同步消费者
 
 ```python
-qc = cast(ConsumerProtocol, QueueConsumerProxy.from_proxy(rediscli, topics))
+qc = cast(ConsumerProtocol, QueueConsumerHelper.from_proxy(rediscli, topics))
 
 with qc.watch() as records:
     for record in records:
@@ -92,7 +92,7 @@ with qc.watch() as records:
 > 异步消费者
 
 ```python
-qc = cast(AioConsumerProtocol, QueueConsumerProxy.from_proxy(rediscli, topics))
+qc = cast(AioConsumerProtocol, QueueConsumerHelper.from_proxy(rediscli, topics))
 
 async with qc.watch() as records:
     async for record in records:
@@ -102,5 +102,5 @@ async with qc.watch() as records:
 ## 安装
 
 ```bash
-pip install redisproxy
+pip install redishelper
 ```

document/README.md

@@ -1,4 +1,4 @@
-# redisproxy
+# redishelper
 
 提供redis客户端的代理对象功能.本项目代理的对象是[redis-py](https://github.com/redis/redis-py)中的四种客户端
 

document/conf.py

@@ -17,7 +17,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'redisproxy'
+project = 'redishelper'
 copyright = '2023, mac'
 author = 'mac'
 
@@ -114,4 +114,4 @@ def setup(app):
 extensions.append('autoapi.extension')
 extensions.append("sphinx.ext.napoleon")
 autoapi_type = 'python'
-autoapi_dirs = ["/Users/mac/WORKSPACE/GITHUB/PythonTools/redisproxy/redisproxy"]
+autoapi_dirs = ["/Users/mac/WORKSPACE/GITHUB/PythonTools/redisproxy/redishelper"]

document/index.md

@@ -1,4 +1,4 @@
-# Welcome to redisproxy's documentation!
+# Welcome to redishelper's documentation!
 
 ## 目录
 

redishelper/__init__.py

@@ -0,0 +1,10 @@
+from .proxy import RedisProxy
+from .channelconsumer import ChannelConsumerHelper
+from .channelproducer import ChannelProducerHelper
+from .queueconsumer import QueueConsumerHelper
+from .queueproducer import QueueProducerHelper
+from .streamconsumer import StreamConsumerHelper
+from .streamproducer import StreamProducerHelper
+
+from .models import AutoOffsetReset, Acks, ConsumerRecord
+from .protocols import ConsumerProtocol, ProducerProtocol, AioConsumerProtocol, AioProducerProtocol, StreamProducerProtocol, AioStreamProducerProtocol

redisproxy/channelconsumer.py renamed to redishelper/channelconsumer.py

@@ -10,7 +10,7 @@
 from .models import ConsumerRecord
 
 
-class ChannelConsumerProxy(RedisProxy):
+class ChannelConsumerHelper(RedisProxy):
     __slots__ = ('instance', "_callbacks", "_instance_check", "_aio", "_cluster", "watch", "_topics")
 
     def __init__(self, topics: str, *, url: Optional[str] = None, addresses: Optional[str] = None, aio: Optional[bool] = None,
@@ -70,7 +70,7 @@ def _watch_sync(self, channel: PubSub, timeout: int = 3) -> Generator[ConsumerRe
             yield record
 
     @classmethod
-    def from_proxy(clz, proxy: RedisProxy, topics: str) -> "ChannelConsumerProxy":
+    def from_proxy(clz, proxy: RedisProxy, topics: str) -> "ChannelConsumerHelper":
         """从RedisProxy实例创建代理.
 
         Args:
@@ -89,7 +89,7 @@ def from_proxy(clz, proxy: RedisProxy, topics: str) -> "ChannelConsumerProxy":
 
 
 @asynccontextmanager
-async def _watch_async(self: ChannelConsumerProxy) -> AsyncGenerator[AsyncIterable[ConsumerRecord], None]:
+async def _watch_async(self: ChannelConsumerHelper) -> AsyncGenerator[AsyncIterable[ConsumerRecord], None]:
     if self.instance is None:
         raise NotImplemented
     try:
@@ -104,7 +104,7 @@ async def _watch_async(self: ChannelConsumerProxy) -> AsyncGenerator[AsyncIterab
 
 
 @contextmanager
-def _watch_sync(self: ChannelConsumerProxy) -> Generator[Iterable[ConsumerRecord], None, None]:
+def _watch_sync(self: ChannelConsumerHelper) -> Generator[Iterable[ConsumerRecord], None, None]:
     if self.instance is None:
         raise NotImplemented
     try:

redisproxy/channelproducer.py renamed to redishelper/channelproducer.py

@@ -7,7 +7,7 @@
 from types import MethodType
 
 
-class ChannelProducerProxy(RedisProxy):
+class ChannelProducerHelper(RedisProxy):
     __slots__ = ('instance', "_callbacks", "_instance_check", "_aio", "_cluster", "mount")
 
     def __init__(self, *, url: Optional[str] = None, addresses: Optional[str] = None, aio: Optional[bool] = None, **conn_params: Any) -> None:
@@ -38,7 +38,7 @@ def regist_methods(self, instance: Any) -> None:
             self.mount = MethodType(_mount_sync, self)
 
     @classmethod
-    def from_proxy(clz, proxy: RedisProxy) -> "ChannelProducerProxy":
+    def from_proxy(clz, proxy: RedisProxy) -> "ChannelProducerHelper":
         """从RedisProxy实例创建代理.
 
         Args:
@@ -56,7 +56,7 @@ def from_proxy(clz, proxy: RedisProxy) -> "ChannelProducerProxy":
 
 
 @contextmanager
-def _mount_sync(self: ChannelProducerProxy) -> Generator[ChannelProducerProxy, None, None]:
+def _mount_sync(self: ChannelProducerHelper) -> Generator[ChannelProducerHelper, None, None]:
     if self.instance is None:
         raise NotImplemented
     try:
@@ -66,7 +66,7 @@ def _mount_sync(self: ChannelProducerProxy) -> Generator[ChannelProducerProxy, N
 
 
 @asynccontextmanager
-async def _mount_async(self: ChannelProducerProxy) -> AsyncGenerator[ChannelProducerProxy, None]:
+async def _mount_async(self: ChannelProducerHelper) -> AsyncGenerator[ChannelProducerHelper, None]:
     if self.instance is None:
         raise NotImplemented
     try:

redisproxy/models.py renamed to redishelper/models.py

@@ -5,7 +5,7 @@
 from .models import ConsumerRecord
 
 
-class QueueConsumerProxy(RedisProxy):
+class QueueConsumerHelper(RedisProxy):
     __slots__ = ('instance', "_callbacks", "_instance_check", "_aio", "_cluster", "watch", "_l2r", "_topics")
 
     def __init__(self, topics: str, *, url: Optional[str] = None, addresses: Optional[str] = None, aio: Optional[bool] = None,
@@ -83,7 +83,7 @@ def _watch_sync(self, timeout: int = 3) -> Generator[ConsumerRecord, None, None]
 
     @classmethod
     def from_proxy(clz, proxy: RedisProxy, topics: str, *,
-                   l2r: bool = False) -> "QueueConsumerProxy":
+                   l2r: bool = False) -> "QueueConsumerHelper":
         """从RedisProxy实例创建代理.
 
         Args:
@@ -103,7 +103,7 @@ def from_proxy(clz, proxy: RedisProxy, topics: str, *,
 
 
 @asynccontextmanager
-async def _watch_async(self: QueueConsumerProxy) -> AsyncGenerator[AsyncIterable[ConsumerRecord], None]:
+async def _watch_async(self: QueueConsumerHelper) -> AsyncGenerator[AsyncIterable[ConsumerRecord], None]:
     if self.instance is None:
         raise NotImplemented
     try:
@@ -113,7 +113,7 @@ async def _watch_async(self: QueueConsumerProxy) -> AsyncGenerator[AsyncIterable
 
 
 @contextmanager
-def _watch_sync(self: QueueConsumerProxy) -> Generator[Iterable[ConsumerRecord], None, None]:
+def _watch_sync(self: QueueConsumerHelper) -> Generator[Iterable[ConsumerRecord], None, None]:
     if self.instance is None:
         raise NotImplemented
     try:

redisproxy/protocols.py renamed to redishelper/protocols.py

@@ -4,7 +4,7 @@
 from types import MethodType
 
 
-class QueueProducerProxy(RedisProxy):
+class QueueProducerHelper(RedisProxy):
     __slots__ = ('instance', "_callbacks", "_instance_check", "_aio", "_cluster", "publish", "mount", "_l2r")
 
     def __init__(self, *, url: Optional[str] = None, addresses: Optional[str] = None, aio: Optional[bool] = None,
@@ -46,7 +46,7 @@ def l2r(self) -> bool:
 
     @classmethod
     def from_proxy(clz, proxy: RedisProxy, *,
-                   l2r: bool = False) -> "QueueProducerProxy":
+                   l2r: bool = False) -> "QueueProducerHelper":
         """从RedisProxy实例创建代理.
 
         Args:
@@ -64,22 +64,22 @@ def from_proxy(clz, proxy: RedisProxy, *,
         return p
 
 
-async def _publish_async(self: QueueProducerProxy, topic: str, value: Union[str, bytes]) -> None:
+async def _publish_async(self: QueueProducerHelper, topic: str, value: Union[str, bytes]) -> None:
     if self._l2r:
         await self.instance.lpush(topic, value)
     else:
         await self.instance.rpush(topic, value)
 
 
-def _publish_sync(self: QueueProducerProxy, topic: str, value: Union[str, bytes]) -> None:
+def _publish_sync(self: QueueProducerHelper, topic: str, value: Union[str, bytes]) -> None:
     if self._l2r:
         self.instance.lpush(topic, value)
     else:
         self.instance.rpush(topic, value)
 
 
 @contextmanager
-def _mount_sync(self: QueueProducerProxy) -> Generator[QueueProducerProxy, None, None]:
+def _mount_sync(self: QueueProducerHelper) -> Generator[QueueProducerHelper, None, None]:
     if self.instance is None:
         raise NotImplemented
     try:
@@ -89,7 +89,7 @@ def _mount_sync(self: QueueProducerProxy) -> Generator[QueueProducerProxy, None,
 
 
 @asynccontextmanager
-async def _mount_async(self: QueueProducerProxy) -> AsyncGenerator[QueueProducerProxy, None]:
+async def _mount_async(self: QueueProducerHelper) -> AsyncGenerator[QueueProducerHelper, None]:
     if self.instance is None:
         raise NotImplemented
     try:

redisproxy/proxy.py renamed to redishelper/proxy.py

@@ -10,7 +10,7 @@
 from redis.commands.core import AsyncDataAccessCommands, DataAccessCommands
 
 
-class StreamConsumerProxy(RedisProxy):
+class StreamConsumerHelper(RedisProxy):
     __slots__ = ('instance', "_callbacks", "_instance_check", "_aio", "_cluster", "watch", "_topics",
                  "_auto_offset_reset", "_count", "_blocktime",
                  "_client_id", "_group_id", "_ack")
@@ -203,7 +203,7 @@ def _watch_sync(self) -> Generator[ConsumerRecord, None, None]:
     @classmethod
     def from_proxy(clz, proxy: RedisProxy, topics: str, *,
                    auto_offset_reset: AutoOffsetReset = AutoOffsetReset.latest, count: Optional[int] = 20, blocktime: Optional[int] = 1000,
-                   client_id: Optional[str] = None, group_id: Optional[str] = None, ack: Acks = Acks.after) -> "StreamConsumerProxy":
+                   client_id: Optional[str] = None, group_id: Optional[str] = None, ack: Acks = Acks.after) -> "StreamConsumerHelper":
         """从RedisProxy实例创建代理.
 
         Args:
@@ -228,7 +228,7 @@ def from_proxy(clz, proxy: RedisProxy, topics: str, *,
 
 
 @asynccontextmanager
-async def _watch_async(self: StreamConsumerProxy) -> AsyncGenerator[AsyncIterable[ConsumerRecord], None]:
+async def _watch_async(self: StreamConsumerHelper) -> AsyncGenerator[AsyncIterable[ConsumerRecord], None]:
     if self.instance is None:
         raise NotImplemented
     try:
@@ -238,7 +238,7 @@ async def _watch_async(self: StreamConsumerProxy) -> AsyncGenerator[AsyncIterabl
 
 
 @contextmanager
-def _watch_sync(self: StreamConsumerProxy) -> Generator[Iterable[ConsumerRecord], None, None]:
+def _watch_sync(self: StreamConsumerHelper) -> Generator[Iterable[ConsumerRecord], None, None]:
     if self.instance is None:
         raise NotImplemented
     try:

redisproxy/queueconsumer.py renamed to redishelper/queueconsumer.py

@@ -8,7 +8,7 @@
 from types import MethodType
 
 
-class StreamProducerProxy(RedisProxy):
+class StreamProducerHelper(RedisProxy):
     __slots__ = ('instance', "_callbacks", "_instance_check", "_aio", "_cluster", "mount", "publish", "_maxlen", "_approximate", "_nomkstream")
 
     def __init__(self, *, url: Optional[str] = None, addresses: Optional[str] = None, aio: Optional[bool] = None,
@@ -48,7 +48,7 @@ def regist_methods(self, instance: Any) -> None:
             self.mount = MethodType(_mount_sync, self)
 
     @classmethod
-    def from_proxy(clz, proxy: RedisProxy, maxlen: Optional[int] = None, approximate: bool = True, nomkstream: bool = False) -> "StreamProducerProxy":
+    def from_proxy(clz, proxy: RedisProxy, maxlen: Optional[int] = None, approximate: bool = True, nomkstream: bool = False) -> "StreamProducerHelper":
         """从RedisProxy实例创建代理.
 
         Args:
@@ -68,18 +68,18 @@ def from_proxy(clz, proxy: RedisProxy, maxlen: Optional[int] = None, approximate
         return p
 
 
-async def _publish_async(self: StreamProducerProxy, topic: str, value: Dict[str, str]) -> None:
+async def _publish_async(self: StreamProducerHelper, topic: str, value: Dict[str, str]) -> None:
     p = cast(AsyncDataAccessCommands, self.instance)
     await p.xadd(topic, value, maxlen=self._maxlen, approximate=self._approximate, nomkstream=self._nomkstream)
 
 
-def _publish_sync(self: StreamProducerProxy, topic: str, value: Dict[str, str]) -> None:
+def _publish_sync(self: StreamProducerHelper, topic: str, value: Dict[str, str]) -> None:
     p = cast(DataAccessCommands, self.instance)
     p.xadd(topic, value, maxlen=self._maxlen, approximate=self._approximate, nomkstream=self._nomkstream)
 
 
 @contextmanager
-def _mount_sync(self: StreamProducerProxy) -> Generator[StreamProducerProxy, None, None]:
+def _mount_sync(self: StreamProducerHelper) -> Generator[StreamProducerHelper, None, None]:
     if self.instance is None:
         raise NotImplemented
     try:
@@ -89,7 +89,7 @@ def _mount_sync(self: StreamProducerProxy) -> Generator[StreamProducerProxy, Non
 
 
 @asynccontextmanager
-async def _mount_async(self: StreamProducerProxy) -> AsyncGenerator[StreamProducerProxy, None]:
+async def _mount_async(self: StreamProducerHelper) -> AsyncGenerator[StreamProducerHelper, None]:
     if self.instance is None:
         raise NotImplemented
     try:

redisproxy/queueproducer.py renamed to redishelper/queueproducer.py

@@ -1,5 +1,5 @@
 [metadata]
-name = redisproxy
+name = redishelper
 version = 0.0.2
 author = mac
 author_email = 
@@ -36,6 +36,6 @@ setup_requires =
 
 
 [options.packages.find]
-include = redisproxy
+include = redishelper
 exclude = tests
 

redisproxy/streamconsumer.py renamed to redishelper/streamconsumer.py

@@ -1,5 +1,5 @@
 from redis.commands.core import DataAccessCommands
-from redisproxy.proxy import RedisProxy
+from redishelper.proxy import RedisProxy
 from typing import cast
 
 rediscli = RedisProxy()

redisproxy/streamproducer.py renamed to redishelper/streamproducer.py

@@ -1,6 +1,6 @@
 import asyncio
 from redis.commands.core import AsyncDataAccessCommands
-from redisproxy.proxy import RedisProxy
+from redishelper.proxy import RedisProxy
 from typing import cast
 
 rediscli = RedisProxy()