async-timer 1.1.2__tar.gz → 1.1.4__tar.gz

{async_timer-1.1.2 → async_timer-1.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: async-timer
-Version: 1.1.2
+Version: 1.1.4
 Summary: The missing Python async timer.
 License: MIT
 Keywords: async,timer

{async_timer-1.1.2 → async_timer-1.1.4}/pyproject.toml

@@ -1,12 +1,13 @@
 [tool.poetry]
 name = "async-timer"
-version = "v1.1.2"
+version = "v1.1.4"
 description = "The missing Python async timer."
 authors = ["Ilya O. <vrghost@gmail.com>"]
 license = "MIT"
 readme = "README.md"
 packages = [
-    {include = "async_timer", from = "src"}
+    {include = "async_timer", from = "src"},
+    {include = "mock_async_timer", from = "src"}
 ]
 classifiers = [
     "Intended Audience :: Developers",

async_timer-1.1.4/src/mock_async_timer/__init__.py

@@ -0,0 +1,3 @@
+"""This module provides an async timer mock class for your unittest needs."""
+from . import timer
+from .timer import MockTimer

async_timer-1.1.4/src/mock_async_timer/timer.py

@@ -0,0 +1,39 @@
+import asyncio
+import unittest.mock
+
+import async_timer
+
+
+class MockPacemaker(async_timer.pacemaker.TimerPacemaker):
+    sleep: unittest.mock.AsyncMock
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.sleep = unittest.mock.AsyncMock(name="mock-timer-sleep")
+
+    async def _try_wait(self, delay: float):
+        if self._cancel_evt.is_set():
+            raise StopAsyncIteration()
+
+        await self._sleep_until_next_loop_iter()
+        await self.sleep(delay)
+
+    async def _sleep_until_next_loop_iter(self):
+        """Awaiting this function will release on the next async loop iteration"""
+        fut = asyncio.Future()
+        asyncio.get_event_loop().call_soon(lambda: fut.set_result(42))
+        await fut
+
+
+class MockTimer(async_timer.Timer):
+    """Test-friendly mock timer class.
+
+    The main difference is that it is using test-friendly pacemaker
+        that doesn't sleep.
+    """
+
+    pacemaker: MockPacemaker
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.pacemaker = MockPacemaker(self.pacemaker.delay)