CheeseSignal 1.0.0__py2.py3-none-any.whl → 1.2.0__py2.py3-none-any.whl

CheeseSignal/__init__.py

@@ -1,331 +1 @@
-from typing import List, Callable, overload, Any
-
-class Receiver:
-    def __init__(self, fn: Callable, *, expected_receive_num: int, auto_remove: bool):
-        '''
-        - Args
-
-            - expected_receive_num: 期望接受信号的次数，超过该次数则不再响应信号；0为无限次。
-
-            - auto_remove: 是否自动删除响应次数超出期望次数的接收器。
-        '''
-        self.fn: Callable = fn
-        self._expected_receive_num: int = expected_receive_num
-        self._auto_remove: bool = auto_remove
-        self._total_receive_num: int = 0
-
-    def reset(self):
-        '''
-        重统计置数据。
-
-        在有期望信号接受次数的情况下，`auto_remove is False`的接收器会重新开始计数并接收信号。
-        '''
-
-        self._total_receive_num = 0
-
-    @property
-    def expected_receive_num(self) -> int:
-        '''
-        期望接受信号的次数，超过该次数则不再响应信号；0为无限次。
-        '''
-
-        return self._expected_receive_num
-
-    @expected_receive_num.setter
-    def expected_receive_num(self, value: int):
-        self._expected_receive_num = value
-
-    @property
-    def auto_remove(self) -> bool:
-        '''
-        是否自动删除响应次数超出期望次数的接收器。
-        '''
-
-        return self._auto_remove
-
-    @auto_remove.setter
-    def auto_remove(self, value: bool):
-        self._auto_remove = value
-
-    @property
-    def total_receive_num(self) -> int:
-        '''
-        【只读】 总计信号接受次数。
-        '''
-
-        return self._total_receive_num
-
-    @property
-    def remaining_receive_num(self) -> int:
-        '''
-        【只读】 剩余的期望信号接受次数；返回为-1代表无期望信号接受次数。
-        '''
-
-        if not self.expected_receive_num:
-            return -1
-        return self.expected_receive_num - self.total_receive_num
-
-    @property
-    def receivable(self) -> bool:
-        '''
-        【只读】 当前Receiver是否处于可接收信号状态。
-        '''
-
-        if self.remaining_receive_num == -1:
-            return True
-        return True if self.remaining_receive_num else False
-
-    @property
-    def unreceivable(self) -> bool:
-        '''
-        【只读】 当前Receiver是否处于不可接收信号状态。
-        '''
-
-        return not self.receivable
-
-class Signal:
-    def __init__(self):
-        self._receivers: List[Receiver] = []
-        self._total_send_num: int = 0
-
-    @overload
-    def connect(self, fn: Callable, *, expected_receive_num: int = 0, auto_remove: bool = False):
-        '''
-        通过函数注册响应函数。
-
-        ```python
-        from CheeseSignal import Signal
-
-        def receiver(*args, **kwargs):
-            ...
-
-        signal = Signal()
-        signal.connect(receiver)
-        ```
-
-        - Args
-
-            - expected_receive_num: 期望接受信号的次数，超过该次数则不再响应信号；0为无限次。
-
-            - auto_remove: 是否自动删除响应次数超出期望次数的接收器。
-
-        - Raise
-
-            - ValueError: 已有重复的函数接收器。
-        '''
-
-    @overload
-    def connect(self, *, expected_receive_num: int = 0, auto_remove: bool = False):
-        '''
-        通过装饰器注册响应函数。
-
-        ```python
-        from CheeseSignal import Signal
-
-        signal = Signal()
-
-        @signal.connect()
-        def receiver(*args, **kwargs):
-            ...
-        ```
-
-        - Args
-
-            - expected_receive_num: 期望接受信号的次数，超过该次数则不再响应信号；0为无限次。
-
-            - auto_remove: 是否自动删除响应次数超出期望次数的接收器。
-
-        - Raise
-
-            - ValueError: 已有重复的函数接收器。
-        '''
-
-    def connect(self, arg1: Callable | None = None, *, expected_receive_num: int = 0, auto_remove: bool = False):
-        if not arg1:
-            def wrapper(fn):
-                self._connect(fn, expected_receive_num = expected_receive_num, auto_remove = auto_remove)
-                return fn
-            return wrapper
-
-        self._connect(arg1, expected_receive_num = expected_receive_num, auto_remove = auto_remove)
-
-    def _connect(self, fn: Callable, *, expected_receive_num: int, auto_remove: bool):
-        for receiver in self.receivers:
-            if receiver.fn == fn:
-                raise ValueError('已有重复的函数接收器')
-
-        self.receivers.append(Receiver(fn, expected_receive_num = expected_receive_num, auto_remove = auto_remove))
-
-    def send(self, *args, **kwargs) -> List[Any]:
-        '''
-        发送信号。
-
-        ```python
-        from CheeseSignal import Signal
-
-        signal = Signal()
-        signal.send('data1', 'data2', **{
-            'key1': 'value1',
-            'key2': 'value2'
-        })
-        ```
-        '''
-
-        self._total_send_num += 1
-
-        results = []
-        for receiver in self.receivers[:]:
-            if receiver.remaining_receive_num > 0 or receiver.remaining_receive_num == -1:
-                receiver._total_receive_num += 1
-                results.append(receiver.fn(*args, **kwargs))
-
-                if receiver.remaining_receive_num == 0 and receiver.auto_remove:
-                    self.receivers.remove(receiver)
-        return results
-
-    async def async_send(self, *args, **kwargs) -> List[Any]:
-        '''
-        在协程环境中发送信号，并请保证所有接收函数都是协程函数。
-
-        ```python
-        import asyncio
-
-        from CheeseSignal import Signal
-
-        async def run_asyncio():
-            signal = Signal()
-            await signal.async_send('data1', 'data2', **{
-                'key1': 'value1',
-                'key2': 'value2'
-            })
-
-        asyncio.run(run_asyncio())
-        ```
-        '''
-
-        self._total_send_num += 1
-
-        results = []
-        for receiver in self.receivers[:]:
-            if receiver.remaining_receive_num > 0 or receiver.remaining_receive_num == -1:
-                receiver._total_receive_num += 1
-                results.append(await receiver.fn(*args, **kwargs))
-
-                if receiver.remaining_receive_num == 0 and receiver.auto_remove:
-                    self.receivers.remove(receiver)
-        return results
-
-    def disconnect(self, fn: Callable):
-        '''
-        断开接收器。
-
-        ```python
-        from CheeseSignal import Signal
-
-        def receiver(*args, **kwargs):
-            ...
-
-        signal = Signal()
-        signal.connect(receiver)
-        signal.disconnect(receiver)
-        ```
-
-        - Raise
-
-            - ValueError: 未找到该函数的接收器。
-        '''
-
-        for receiver in self.receivers:
-            if receiver.fn == fn:
-                self.receivers.remove(receiver)
-                return
-
-        raise ValueError('未找到该函数的接收器')
-
-    def reset(self):
-        '''
-        重置统计数据；所有的接收器的统计数据也会同步清空。
-        '''
-
-        self._total_send_num = 0
-        for receiver in self.receivers:
-            receiver.reset()
-
-    def disconnect_all(self):
-        '''
-        断开所有接收器。
-        '''
-
-        self._receivers = []
-
-    def get_receiver(self, fn: Callable) -> Receiver:
-        '''
-        获取接收器。
-
-        ```python
-        from CheeseSignal import Signal
-
-        def receiver(*args, **kwargs):
-            ...
-
-        signal = Signal()
-        signal.connect(receiver)
-
-        print(signal.get_receiver(receiver))
-        ```
-
-        - Raise
-
-            - ValueError: 未找到该函数的接收器。
-        '''
-
-        for receiver in self.receivers:
-            if receiver.fn == fn:
-                return receiver
-
-        raise ValueError('未找到该函数的接收器')
-
-    def index(self, fn: Callable) -> int:
-        '''
-        获取接收器的顺序位置。
-
-        ```python
-        from CheeseSignal import Signal
-
-        def receiver(*args, **kwargs):
-            ...
-
-        signal = Signal()
-        signal.connect(receiver)
-
-        print(signal.index(receiver))
-        ```
-
-        - Raise
-
-            - ValueError: 未找到该函数的接收器。
-        '''
-
-        i = 0
-        for receiver in self.receivers:
-            if receiver.fn == fn:
-                return i
-            i += 1
-
-        raise ValueError('未找到该函数的接收器')
-
-    @property
-    def receivers(self) -> List[Receiver]:
-        '''
-        【只读】 接收器的列表，按注册顺序排序。
-        '''
-
-        return self._receivers
-
-    @property
-    def total_send_num(self) -> int:
-        '''
-        【只读】 总计信号发送次数。
-        '''
-
-        return self._total_send_num
+from CheeseSignal.signal import Receiver, Signal

CheeseSignal/signal.py

@@ -0,0 +1,359 @@
+import asyncio
+from typing import List, Callable, overload, Any, TYPE_CHECKING, Literal, Tuple
+
+if TYPE_CHECKING:
+    class Signal:
+        ...
+
+class Receiver:
+    def __init__(self, signal: 'Signal', fn: Callable, *, expected_receive_num: int, auto_remove: bool, runType: Literal['ORDERED', 'CONCURRENT', 'NO_WAIT'] = 'ORDERED'):
+        '''
+        - Args
+            - expected_receive_num: 期望接受信号的次数，超过该次数则不再响应信号；0为无限次。
+
+            - auto_remove: 是否自动删除响应次数超出期望次数的接收器。
+        '''
+
+        self._signal: 'Signal' = signal
+        self.fn: Callable = fn
+        self._expected_receive_num: int = expected_receive_num
+        self._auto_remove: bool = auto_remove
+        self._total_receive_num: int = 0
+        self._active: bool = True
+        self._runType: Literal['ORDERED', 'CONCURRENT', 'NO_WAIT'] = runType
+
+    def reset(self):
+        '''
+        重统计置数据。
+
+        在有期望信号接受次数的情况下，`auto_remove is False`的接收器会重新开始计数并接收信号。
+        '''
+
+        self._total_receive_num = 0
+
+    @property
+    def expected_receive_num(self) -> int:
+        '''
+        期望接受信号的次数，超过该次数则不再响应信号；0为无限次。
+
+        设置值小于`total_receive_num`且`auto_remove is True`，则会立刻删除。
+        '''
+
+        return self._expected_receive_num
+
+    @expected_receive_num.setter
+    def expected_receive_num(self, value: int):
+        self._expected_receive_num = value
+
+        if self._auto_remove and self.is_expired:
+            self._signal.receivers.remove(self)
+
+    @property
+    def auto_remove(self) -> bool:
+        '''
+        是否自动删除响应次数超出期望次数的接收器。
+
+        设置为`True`时若该receiver过期，则会立刻删除。
+        '''
+
+        return self._auto_remove
+
+    @auto_remove.setter
+    def auto_remove(self, value: bool):
+        self._auto_remove = value
+
+        if self._auto_remove and self.is_expired:
+            self._signal.receivers.remove(self)
+
+    @property
+    def active(self) -> bool:
+        '''
+        是否激活；未激活将忽略信号。
+        '''
+
+        return self._active
+
+    @active.setter
+    def active(self, value: bool):
+        self._active = value
+
+    @property
+    def total_receive_num(self) -> int:
+        '''
+        【只读】 总计信号接受次数。
+        '''
+
+        return self._total_receive_num
+
+    @property
+    def remaining_receive_num(self) -> int:
+        '''
+        【只读】 剩余的期望信号接受次数；返回为-1代表无期望信号接受次数。
+        '''
+
+        if not self.expected_receive_num:
+            return -1
+        return self.expected_receive_num - self.total_receive_num
+
+    @property
+    def is_expired(self) -> bool:
+        '''
+        【只读】 是否过期。
+        '''
+
+        return not self.is_unexpired
+
+    @property
+    def is_unexpired(self) -> bool:
+        '''
+        【只读】 是否未过期。
+        '''
+
+        if self.remaining_receive_num == -1:
+            return True
+        return True if self.remaining_receive_num else False
+
+    @property
+    def runType(self) -> Literal['ORDERED', 'CONCURRENT', 'NO_WAIT']:
+        '''
+        【只读】 运行的方式，仅在`async_send`时有效。
+
+        - ORDERED: 按顺序执行，返回结果。
+
+        - CONCURRENT: 并行执行，返回结果。
+
+        - NO_WAIT: 并行执行，不阻塞代码。
+        '''
+
+        return self._runType
+
+    @runType.setter
+    def runType(self, value: Literal['ORDERED', 'CONCURRENT', 'NO_WAIT']):
+        self._runType = value
+
+class Signal:
+    def __init__(self):
+        self._receivers: List[Receiver] = []
+        self._total_send_num: int = 0
+
+    @overload
+    def connect(self, fn: Callable, *, expected_receive_num: int = 0, auto_remove: bool = False, runType: Literal['ORDERED', 'CONCURRENT', 'NO_WAIT'] = 'ORDERED'):
+        '''
+        通过函数注册响应函数。
+
+        >>> from CheeseSignal import Signal
+        >>>
+        >>> def receiver(*args, **kwargs):
+        ...     ...
+        >>>
+        >>> signal = Signal()
+        >>> signal.connect(receiver)
+
+        - Args
+            - expected_receive_num: 期望接受信号的次数，超过该次数则不再响应信号；0为无限次。
+
+            - auto_remove: 是否自动删除响应次数超出期望次数的接收器。
+
+        - Raise
+            - ValueError: 已有重复的函数接收器。
+        '''
+
+    @overload
+    def connect(self, *, expected_receive_num: int = 0, auto_remove: bool = False):
+        '''
+        通过装饰器注册响应函数。
+
+        >>> from CheeseSignal import Signal
+        >>>
+        >>> signal = Signal()
+        >>>
+        >>> @signal.connect()
+        >>> def receiver(*args, **kwargs):
+        ...     ...
+
+        - Args
+            - expected_receive_num: 期望接受信号的次数，超过该次数则不再响应信号；0为无限次。
+
+            - auto_remove: 是否自动删除响应次数超出期望次数的接收器。
+
+        - Raise
+            - ValueError: 已有重复的函数接收器。
+        '''
+
+    def connect(self, arg1: Callable | None = None, *, expected_receive_num: int = 0, auto_remove: bool = False, runType: Literal['ORDERED', 'CONCURRENT', 'NO_WAIT'] = 'ORDERED'):
+        if not arg1:
+            def wrapper(fn):
+                self._connect(fn, expected_receive_num = expected_receive_num, auto_remove = auto_remove, runType = runType)
+                return fn
+            return wrapper
+
+        self._connect(arg1, expected_receive_num = expected_receive_num, auto_remove = auto_remove, runType = runType)
+
+    def _connect(self, fn: Callable, *, expected_receive_num: int, auto_remove: bool, runType: Literal['ORDERED', 'CONCURRENT', 'NO_WAIT']):
+        for receiver in self.receivers:
+            if receiver.fn == fn:
+                raise ValueError('已有重复的函数接收器')
+
+        self.receivers.append(Receiver(self, fn, expected_receive_num = expected_receive_num, auto_remove = auto_remove, runType = runType))
+
+    def send(self, *args, **kwargs) -> List[Any]:
+        '''
+        发送信号。
+
+        >>> from CheeseSignal import Signal
+        >>>
+        >>> signal = Signal()
+        >>> signal.send('data1', 'data2', **{
+        ...     'key1': 'value1',
+        ...     'key2': 'value2'
+        >>> })
+        '''
+
+        self._total_send_num += 1
+
+        results = []
+        for receiver in self.receivers[:]:
+            if receiver.active and receiver.is_unexpired:
+                receiver._total_receive_num += 1
+                results.append(receiver.fn(*args, **kwargs))
+
+                if receiver.is_expired:
+                    self.receivers.remove(receiver)
+        return results
+
+    async def async_send(self, *args, **kwargs) -> Tuple[List[Any], List[Any]]:
+        '''
+        在协程环境中发送信号，并请保证所有接收函数都是协程函数。
+
+        >>> import asyncio
+        >>>
+        >>> from CheeseSignal import Signal
+        >>>
+        >>> async def run_asyncio():
+        ...     signal = Signal()
+        ...     await signal.async_send('data1', 'data2', **{
+        ...         'key1': 'value1',
+        ...         'key2': 'value2'
+        ...     })
+        >>>
+        >>> asyncio.run(run_asyncio())
+
+        - Returns
+            返回长度为2的元祖，分别为ORDERED类型和CONCURRENT类型的结果。
+        '''
+
+        self._total_send_num += 1
+        receivers = [receiver for receiver in self.receivers.copy() if receiver.active and receiver.is_unexpired]
+
+        [asyncio.create_task(receiver.fn(*args, **kwargs)) for receiver in receivers if receiver.runType == 'NO_WAIT']
+        concurrent_tasks = [receiver.fn(*args, **kwargs) for receiver in receivers if receiver.runType == 'CONCURRENT']
+        concurrent_results = await asyncio.gather(*concurrent_tasks) if concurrent_tasks else []
+        ordered_results = [await receiver.fn(*args, **kwargs) for receiver in receivers if receiver.runType == 'ORDERED']
+
+        return concurrent_results, ordered_results
+
+    def disconnect(self, fn: Callable):
+        '''
+        断开接收器。
+
+        >>> from CheeseSignal import Signal
+        >>>
+        >>> def receiver(*args, **kwargs):
+        ...     ...
+        >>>
+        >>> signal = Signal()
+        >>> signal.connect(receiver)
+        >>> signal.disconnect(receiver)
+
+        - Raise
+            - ValueError: 未找到该函数的接收器。
+        '''
+
+        for receiver in self.receivers:
+            if receiver.fn == fn:
+                self.receivers.remove(receiver)
+                return
+
+        raise ValueError('未找到该函数的接收器')
+
+    def reset(self):
+        '''
+        重置统计数据；所有的接收器的统计数据也会同步清空。
+        '''
+
+        self._total_send_num = 0
+        for receiver in self.receivers:
+            receiver.reset()
+
+    def disconnect_all(self):
+        '''
+        断开所有接收器。
+        '''
+
+        self._receivers = []
+
+    def get_receiver(self, fn: Callable) -> Receiver:
+        '''
+        获取接收器。
+
+        >>> from CheeseSignal import Signal
+        >>>
+        >>> def receiver(*args, **kwargs):
+        ...     ...
+        >>>
+        >>> signal = Signal()
+        >>> signal.connect(receiver)
+        >>>
+        >>> print(signal.get_receiver(receiver))
+
+        - Raise
+            - ValueError: 未找到该函数的接收器。
+        '''
+
+        for receiver in self.receivers:
+            if receiver.fn == fn:
+                return receiver
+
+        raise ValueError('未找到该函数的接收器')
+
+    def index(self, fn: Callable) -> int:
+        '''
+        获取接收器的顺序位置。
+
+        >>> from CheeseSignal import Signal
+        >>>
+        >>> def receiver(*args, **kwargs):
+        ...     ...
+        >>>
+        >>> signal = Signal()
+        >>> signal.connect(receiver)
+        >>>
+        >>> print(signal.index(receiver))
+
+        - Raise
+            - ValueError: 未找到该函数的接收器。
+        '''
+
+        i = 0
+        for receiver in self.receivers:
+            if receiver.fn == fn:
+                return i
+            i += 1
+
+        raise ValueError('未找到该函数的接收器')
+
+    @property
+    def receivers(self) -> List[Receiver]:
+        '''
+        【只读】 接收器的列表，按注册顺序排序。
+        '''
+
+        return self._receivers
+
+    @property
+    def total_send_num(self) -> int:
+        '''
+        【只读】 总计信号发送次数。
+        '''
+
+        return self._total_send_num

{cheesesignal-1.0.0.dist-info → cheesesignal-1.2.0.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.3
 Name: CheeseSignal
-Version: 1.0.0
+Version: 1.2.0
 Summary: 一款简约的信号系统。
 Project-URL: Source, https://github.com/CheeseUnknown/CheeseSignal
 Author-email: Cheese Unknown <cheese@cheese.ren>
 License-File: LICENSE
-Keywords: API,BackEnd
+Keywords: Signal
 Description-Content-Type: text/markdown
 
 # **CheeseSignal**
@@ -192,7 +192,7 @@ print(signal.index(receiver))
 from CheeseSignal import Receiver
 ```
 
-#### **`def __init__(self, fn: Callable, *, expected_receive_num: int, auto_remove: bool)`**
+#### **`def __init__(self, signal: Signal, fn: Callable, *, expected_receive_num: int, auto_remove: bool)`**
 
 - **参数**
 
@@ -204,10 +204,18 @@ from CheeseSignal import Receiver
 
 期望接受信号的次数，超过该次数则不再响应信号；0为无限次。
 
+设置值小于`total_receive_num`且`auto_remove is True`，则会立刻删除。
+
 #### **`self.auto_remove: bool`**
 
 是否自动删除响应次数超出期望次数的接收器。
 
+设置为`True`且`is_expired is True`，则会立刻删除。
+
+#### **`self.active: bool`**
+
+是否激活；未激活将忽略信号。
+
 #### **`self.total_receive_num: int`**
 
 【只读】 总计信号接受次数。
@@ -216,13 +224,13 @@ from CheeseSignal import Receiver
 
 【只读】 剩余的期望信号接受次数；返回为-1代表无期望信号接受次数。
 
-#### **`self.receivable: bool`**
+#### **`self.is_expired: bool`**
 
-【只读】 当前Receiver是否处于可接收信号状态。
+【只读】 是否过期。
 
-#### **`self.unreceivable: bool`**
+#### **`self.is_unexpired: bool`**
 
-【只读】 当前Receiver是否处于不可接收信号状态。
+【只读】 是否未过期。
 
 #### **`def reset(self)`**
 

cheesesignal-1.2.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+CheeseSignal/__init__.py,sha256=--LvG_YyRo9N3ubHlhunm4FiiMD60hM2LsdB9uiprPM,49
+CheeseSignal/signal.py,sha256=sxPyXtRIxgt23uTxn2SQjoF1QSIeRZxqz1MGwzij7to,10842
+cheesesignal-1.2.0.dist-info/METADATA,sha256=09TA7w_cQcne48pQILYiOrSl-5K0sjat4KVUvo7jvuI,5141
+cheesesignal-1.2.0.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
+cheesesignal-1.2.0.dist-info/licenses/LICENSE,sha256=5vFb3i4UDlskszJ3jGPh8bXrM_axJfDRRuvLu1M3bIs,1070
+cheesesignal-1.2.0.dist-info/RECORD,,

{cheesesignal-1.0.0.dist-info → cheesesignal-1.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.24.1
+Generator: hatchling 1.25.0
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any

cheesesignal-1.0.0.dist-info/RECORD

@@ -1,5 +0,0 @@
-CheeseSignal/__init__.py,sha256=thvWjsoJ8ed1TxU6Rjq4fQDxRDOe1Q1aefhpKLJZuro,8855
-cheesesignal-1.0.0.dist-info/METADATA,sha256=6IzokYvq4ACf7zuJijYVIneesveYHv7grTE3B0p2s-8,4978
-cheesesignal-1.0.0.dist-info/WHEEL,sha256=lA-f9Lj70wKOLrgpRcgvGFxEoHnVMUTjYbvYas0c5ow,105
-cheesesignal-1.0.0.dist-info/licenses/LICENSE,sha256=5vFb3i4UDlskszJ3jGPh8bXrM_axJfDRRuvLu1M3bIs,1070
-cheesesignal-1.0.0.dist-info/RECORD,,