5.9.0 - Add ability to wait for N task iterations

vkottler · vkottler · commit 12cec34b62ef · 2025-03-06T03:14:47.000-06:00
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -77,7 +77,7 @@ jobs:
 
       - run: |
           mk python-release owner=vkottler \
-                            repo=runtimepy version=5.8.4
+                            repo=runtimepy version=5.9.0
         if: |
           matrix.python-version == '3.12'
           && matrix.system == 'ubuntu-latest'
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Libre Embedded
+Copyright (c) 2025 Libre Embedded
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=f89c565370dd68d4215345aeab6feff4
+    hash=3ef34104e5e034e1dbd47bb8020808b6
     =====================================
 -->
 
-# runtimepy ([5.8.4](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.9.0](https://pypi.org/project/runtimepy/))
 
 [![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
 ![Build Status](https://github.com/vkottler/runtimepy/workflows/Python%20Package/badge.svg)
diff --git a/config b/config
@@ -1 +1 @@
-Subproject commit 469468c1079ac41f725aa77737b3d721ed77930b
+Subproject commit ad9674a5fc8813d7dac300c20f58bcacd2db7c71
diff --git a/local/variables/package.yaml b/local/variables/package.yaml
@@ -1,5 +1,5 @@
 ---
 major: 5
-minor: 8
-patch: 4
+minor: 9
+patch: 0
 entry: runtimepy
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta:__legacy__"
 
 [project]
 name = "runtimepy"
-version = "5.8.4"
+version = "5.9.0"
 description = "A framework for implementing Python services."
 readme = "README.md"
 requires-python = ">=3.12"
diff --git a/runtimepy/__init__.py b/runtimepy/__init__.py
@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=99838ab674af55409015e5abdd55fc6e
+# hash=809a612b14ec99a3d62dfdd4add8900e
 # =====================================
 
 """
@@ -10,7 +10,7 @@
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.8.4"
+VERSION = "5.9.0"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"
diff --git a/runtimepy/net/util.py b/runtimepy/net/util.py
@@ -159,7 +159,7 @@ def hostname(ip_address: str) -> str:
 def address_str(name: str, fallback_host: str = "localhost", **kwargs) -> str:
     """Get an IP address string for a given name."""
 
-    return _socket.getaddrinfo(
+    return _socket.getaddrinfo(  # type: ignore
         name if name else fallback_host, None, **kwargs
     )[0][4][0]
 
diff --git a/runtimepy/primitives/int.py b/runtimepy/primitives/int.py
@@ -40,6 +40,17 @@ def increment(self, amount: int = 1, timestamp_ns: int = None) -> int:
         self.set_value(new_val, timestamp_ns=timestamp_ns)
         return new_val
 
+    async def wait_for_increment(
+        self, timeout: float, count: int = 1
+    ) -> EvalResult:
+        """Wait for this primitive to increment by a certain amount."""
+
+        return await self.wait_for_value(
+            self.raw.value + count,
+            timeout,
+            operation=Operator.LESS_THAN_OR_EQUAL,
+        )
+
     async def wait_for_value(
         self,
         value: int | float,
diff --git a/runtimepy/task/basic/periodic.py b/runtimepy/task/basic/periodic.py
@@ -136,6 +136,15 @@ def disable(self) -> bool:
             self._enabled.clear()
         return result
 
+    async def wait_iterations(self, timeout: float, count: int = 1) -> bool:
+        """Wait for a task to complete a certain number of iterations."""
+
+        return bool(
+            await self.metrics.dispatches.wait_for_increment(
+                timeout, count=count
+            )
+        )
+
     async def run(
         self, period_s: float = None, stop_sig: _asyncio.Event = None
     ) -> None:
diff --git a/tests/primitives/test_int.py b/tests/primitives/test_int.py
@@ -81,3 +81,8 @@ async def incrementer() -> None:
 
     assert not await prim.wait_for_value(prim.value + 1, 0.0)
     assert await prim.wait_for_value(prim.value, 0.0)
+
+    assert not await prim.wait_for_increment(0.1)
+    task = asyncio.create_task(incrementer())
+    assert await prim.wait_for_increment(0.1)
+    await task
diff --git a/tests/task/basic/test_basic.py b/tests/task/basic/test_basic.py
@@ -22,8 +22,7 @@ async def test_periodic_task_overrun():
     await task.task(period_s=BASE_PERIOD)
 
     # Allow it to run.
-    while task.metrics.dispatches.value == 0:
-        await asyncio.sleep(BASE_PERIOD)
+    assert await task.wait_iterations(BASE_PERIOD * 10)
 
     await task.stop()
     assert task.metrics.overruns.value > 0
@@ -41,7 +40,7 @@ async def test_periodic_task_basic():
     initial = await task.task(base_period)
 
     # Allow it to run.
-    await asyncio.sleep(base_period * 2)
+    assert await task.wait_iterations(base_period * 10, count=2)
 
     # Create a new instance of the task, causing the first one to be cancelled.
     new_task = await task.task(base_period * 2)
@@ -50,7 +49,7 @@ async def test_periodic_task_basic():
     assert initial.done()
 
     # Ensure the new task gets to run.
-    await asyncio.sleep(base_period * 2)
+    await task.wait_iterations(base_period * 2)
 
     # Cancel the new task and ensure it stops.
     new_task.cancel()
