onestep 0.1.4__tar.gz → 0.1.6__tar.gz

{onestep-0.1.4 → onestep-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: onestep
-Version: 0.1.4
+Version: 0.1.6
 Summary: 
 Author: miclon
 Author-email: jcnd@163.com

{onestep-0.1.4 → onestep-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "onestep"
-version = "0.1.4"
+version = "0.1.6"
 description = ""
 authors = ["miclon <jcnd@163.com>"]
 readme = "README.md"
@@ -22,6 +22,7 @@ rabbitmq = ["amqpstorm"]
 nacos-sdk-python = "^0.1.12"
 redis = "^4.5.1"
 autopep8 = "^2.0.2"
+loguru = "^0.6.0"
 
 
 [tool.poetry.group.test.dependencies]

{onestep-0.1.4 → onestep-0.1.6}/setup.py

@@ -18,7 +18,7 @@ extras_require = \
 
 setup_kwargs = {
     'name': 'onestep',
-    'version': '0.1.4',
+    'version': '0.1.6',
     'description': '',
     'long_description': '# OneStep\n\n<a href="https://github.com/mic1on/onestep/actions/workflows/test.yml?query=event%3Apush+branch%3Amain" target="_blank">\n    <img src="https://github.com/mic1on/onestep/workflows/test%20suite/badge.svg?branch=main&event=push" alt="Test">\n</a>\n<a href="https://pypi.org/project/onestep" target="_blank">\n    <img src="https://img.shields.io/pypi/v/onestep.svg" alt="Package version">\n</a>\n\n<a href="https://pypi.org/project/onestep" target="_blank">\n    <img src="https://img.shields.io/pypi/pyversions/onestep.svg" alt="Supported Python versions">\n</a>\n\n<hr />\n仅需一步，轻松实现分布式异步任务。\n\n## Brokers\n\n- [x] MemoryBroker\n- [x] CronBroker\n- [x] WebHookBroker\n- [x] RabbitMQBroker\n- [ ] RedisBroker\n- [ ] KafkaBroker\n\n## example\n\n```python\nfrom onestep import step, WebHookBroker\n\n\n# 对外提供一个webhook接口，接收外部的消息\n@step(from_broker=WebHookBroker(path="/push"))\ndef waiting_messages(message):\n    print("收到消息：", message)\n\n\nif __name__ == \'__main__\':\n    step.start(block=True)\n```\n\n```python\nfrom onestep import step, CronBroker\n\n\n# 每3秒触发一次任务\n@step(from_broker=CronBroker("* * * * * */3", a=1))\ndef cron_task(message):\n    assert message.body == {"a": 1}\n    return message\n\n\nif __name__ == \'__main__\':\n    step.start(block=True)\n```\n\n更多例子请参阅：[examples](example)',
     'author': 'miclon',

{onestep-0.1.4 → onestep-0.1.6}/src/onestep/__init__.py

@@ -1,10 +1,14 @@
 from .onestep import step
-from .retry import NeverRetry, AlwaysRetry, TimesRetry, RetryIfException, NackErrorCallBack
+from .retry import NeverRetry, AlwaysRetry, TimesRetry, RetryIfException, NackErrorCallBack, LocalAndQueueRetry
 from .broker import (
     BaseBroker, BaseConsumer, BaseLocalBroker, BaseLocalConsumer,
     MemoryBroker, RabbitMQBroker, WebHookBroker, CronBroker
 )
-from .middleware import BaseMiddleware, BaseConfigMiddleware, RedisConfigMiddleware, NacosConfigMiddleware
+from .middleware import (
+    BaseMiddleware, BaseConfigMiddleware,
+    NacosPublishConfigMiddleware, NacosConsumeConfigMiddleware,
+    RedisPublishConfigMiddleware, RedisConsumeConfigMiddleware,
+)
 
 __all__ = [
     'step',
@@ -24,12 +28,15 @@ __all__ = [
     'AlwaysRetry',
     'TimesRetry',
     'RetryIfException',
+    'LocalAndQueueRetry',
     #
     'NackErrorCallBack',
 
     # middleware
     'BaseMiddleware',
     'BaseConfigMiddleware',
-    'RedisConfigMiddleware',
-    'NacosConfigMiddleware',
+    'NacosPublishConfigMiddleware',
+    'NacosConsumeConfigMiddleware',
+    'RedisPublishConfigMiddleware',
+    'RedisConsumeConfigMiddleware',
 ]

{onestep-0.1.4 → onestep-0.1.6}/src/onestep/broker/cron.py

@@ -19,10 +19,13 @@ class CronBroker(BaseLocalBroker):
         self.kwargs = kwargs
         self._scheduler()
 
+    def _real_task(self):
+        self.queue.put_nowait(self.kwargs)
+
     def _scheduler(self):
         if self.next_fire_time <= datetime.now():
             self.next_fire_time = self.itr.get_next(datetime)
-            self.queue.put_nowait(self.kwargs)
+            self._real_task()
 
         threading.Timer(interval=1, function=self._scheduler).start()
 

onestep-0.1.6/src/onestep/middleware/__init__.py

@@ -0,0 +1,6 @@
+from .base import BaseMiddleware
+from .config import (
+    BaseConfigMiddleware, PublishConfigMixin, ConsumeConfigMixin,
+    NacosConfigMixin, NacosPublishConfigMiddleware, NacosConsumeConfigMiddleware,
+    RedisConfigMixin, RedisPublishConfigMiddleware, RedisConsumeConfigMiddleware
+)

onestep-0.1.6/src/onestep/middleware/base.py

@@ -0,0 +1,17 @@
+class BaseMiddleware:
+
+    def before_send(self, step, message, *args, **kwargs):
+        """消息发送之前"""
+        pass
+
+    def after_send(self, step, message, *args, **kwargs):
+        """消息发送之后"""
+        pass
+
+    def before_receive(self, step, message, *args, **kwargs):
+        """消息接收之前"""
+        pass
+
+    def after_receive(self, step, message, *args, **kwargs):
+        """消息接收之后"""
+        pass

onestep-0.1.6/src/onestep/middleware/config.py

@@ -0,0 +1,77 @@
+from .base import BaseMiddleware
+
+
+class BaseConfigMiddleware(BaseMiddleware):
+
+    def __init__(self, client, *args, **kwargs):
+        self.config_key = kwargs.pop('config_key', None)
+        self.client = client
+
+    def process(self, step, message, *args, **kwargs):
+        """实际获取配置的逻辑"""
+        config = self.get(self.config_key)
+        return config
+
+    def get(self, key):
+        raise NotImplementedError
+
+
+class PublishConfigMixin:
+    def before_receive(self, step, message, *args, **kwargs):
+        """消息发送之前，给消息添加配置"""
+        config = self.process(step, message, *args, **kwargs)  # noqa
+        # 持久性，会跟随消息传递到其他 broker
+        message.extra['config'] = config
+
+
+class ConsumeConfigMixin:
+    def before_receive(self, step, message, *args, **kwargs):
+        """消息消费之前，给消息附加配置"""
+        config = self.process(step, message, *args, **kwargs)  # noqa
+        # 一次性，不跟随消息传递到其他 broker
+        message.config = config
+
+
+class NacosConfigMixin:
+
+    def __init__(self, client, *args, **kwargs):
+        super().__init__(client, *args, **kwargs)
+        self.config_group = kwargs.pop("config_group", "DEFAULT_GROUP")
+
+    def get(self, key):
+        pass
+
+    def set(self, key, value):
+        pass
+
+
+class NacosPublishConfigMiddleware(NacosConfigMixin, PublishConfigMixin, BaseConfigMiddleware):
+    """发布前附加来自 Nacos 的配置"""
+
+
+class NacosConsumeConfigMiddleware(NacosConfigMixin, ConsumeConfigMixin, BaseConfigMiddleware):
+    """消费前附加来自 Nacos 的配置"""
+
+
+class RedisConfigMixin:
+
+    def __init__(self, client, *args, **kwargs):
+        super().__init__(client, *args, **kwargs)
+        self.config_group = kwargs.pop('config_group', 'onestep:config')
+
+    def get(self, key):
+        value = self.client.hget(name=self.config_group, key=key)  # noqa
+        if isinstance(value, bytes):
+            value = value.decode()
+        return value
+
+    def set(self, key, value):
+        return self.client.hset(name=self.config_group, key=key, value=value)  # noqa
+
+
+class RedisPublishConfigMiddleware(RedisConfigMixin, PublishConfigMixin, BaseConfigMiddleware):
+    """发布前附加来自 Redis 的配置"""
+
+
+class RedisConsumeConfigMiddleware(RedisConfigMixin, ConsumeConfigMixin, BaseConfigMiddleware):
+    """消费前附加来自 Redis 的配置"""

{onestep-0.1.4 → onestep-0.1.6}/src/onestep/onestep.py

@@ -120,7 +120,7 @@ class BaseOneStep:
             if not hasattr(middleware, signal):
                 continue
             try:
-                getattr(middleware, signal)(self, *args, **kwargs)
+                getattr(middleware, signal)(step=self, *args, **kwargs)
             except StopMiddleware:
                 break
 

onestep-0.1.4/src/onestep/middleware/__init__.py

@@ -1,4 +0,0 @@
-from .config import (
-    NacosConfigMiddleware, RedisConfigMiddleware, BaseConfigMiddleware
-)
-from .base import BaseMiddleware

onestep-0.1.4/src/onestep/middleware/base.py

@@ -1,13 +0,0 @@
-class BaseMiddleware:
-
-    def before_send(self, *args, **kwargs):
-        """消息发送之前"""
-
-    def after_send(self, *args, **kwargs):
-        """消息发送之后"""
-
-    def before_receive(self, *args, **kwargs):
-        """消息接收之前"""
-
-    def after_receive(self, *args, **kwargs):
-        """消息接收之后"""

onestep-0.1.4/src/onestep/middleware/config.py

@@ -1,50 +0,0 @@
-import redis
-
-from .base import BaseMiddleware
-
-
-class BaseConfigMiddleware(BaseMiddleware):
-
-    def __init__(self, client, *args, **kwargs):
-        self.config_key = kwargs.pop('config_key')
-        self.client = client
-
-    def before_send(self, message):
-        """消息发送之前，给消息添加配置"""
-        config = self.get(self.config_key)
-        message.config = config
-
-    def get(self, key):
-        raise NotImplementedError
-
-
-class NacosConfigMiddleware(BaseConfigMiddleware):
-
-    def __init__(self, client, *args, **kwargs):
-        super().__init__(client, *args, **kwargs)
-        self.config_group = kwargs.pop("config_group", "DEFAULT_GROUP")
-
-
-class RedisConfigMiddleware(BaseConfigMiddleware):
-
-    def __init__(self, client, *args, **kwargs):
-        super().__init__(client, *args, **kwargs)
-        self.config_group = kwargs.pop('config_group', 'onestep:config')
-
-    def get(self, key):
-        value = self.client.hget(name=self.config_group, key=key)
-        if isinstance(value, bytes):
-            value = value.decode()
-        return value
-
-    def set(self, key, value):
-        return self.client.hset(name=self.config_group, key=key, value=value)
-
-
-if __name__ == '__main__':
-    rds_params = {
-    }
-    rds_client = redis.Redis(**rds_params)
-
-    rc = RedisConfigMiddleware(client=rds_client)
-    print(rc.get("name"))