scirodev 0.5.2__tar.gz → 0.5.3__tar.gz

{scirodev-0.5.2/scirodev.egg-info → scirodev-0.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scirodev
-Version: 0.5.2
+Version: 0.5.3
 Summary: PeakHub / sciro extensions to Pybricks: typed API stubs (sciro.*) and hub tooling on top of pybricksdev
 Author: Thomas Schank
 License: MIT

{scirodev-0.5.2 → scirodev-0.5.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scirodev"
-version = "0.5.2"
+version = "0.5.3"
 description = "PeakHub / sciro extensions to Pybricks: typed API stubs (sciro.*) and hub tooling on top of pybricksdev"
 readme = "README.md"
 requires-python = ">=3.10"

{scirodev-0.5.2 → scirodev-0.5.3}/sciro/tools.py

@@ -4,7 +4,56 @@ helpers. EXPERIMENTAL: the API may still change between releases.
 
 from __future__ import annotations
 
-from typing import Awaitable, Callable, Iterable, Iterator, Optional, Sequence, Tuple
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Awaitable,
+    Callable,
+    Iterable,
+    Iterator,
+    Optional,
+    Sequence,
+    Tuple,
+)
+
+if TYPE_CHECKING:
+    from pybricks._common import MaybeAwaitableTuple
+else:
+    # Upstream defines this only for type checkers; runtime importers of the
+    # stubs (the docs build) need a value. Annotations are strings here
+    # (from __future__ import annotations), so a placeholder suffices.
+    MaybeAwaitableTuple = None
+
+
+def multitask(*coroutines: Awaitable[Any], race: bool = False) -> MaybeAwaitableTuple:
+    """multitask(coroutine1, coroutine2, ..., race=False) -> Tuple
+
+    ``pybricks.tools.multitask`` (the same function on the hub), typed to
+    accept any awaitable.
+
+    The upstream stub asks for ``Coroutine``, which every *maybe-awaitable*
+    hub method fails to satisfy for a type checker: ``motor.run_angle(...)``,
+    ``db.straight(...)`` or ``sensor.read()`` are declared as awaitables, not
+    as coroutines, because they return a plain value when called outside
+    ``run_task``. Importing ``multitask`` (and :func:`run_task`) from
+    ``sciro.tools`` instead of ``pybricks.tools`` removes those warnings::
+
+        from sciro.tools import multitask, run_task
+
+        async def main():
+            await multitask(db.straight(500), log.record(db.state), race=True)
+
+        run_task(main())
+    """
+
+
+def run_task(coroutine: Optional[Awaitable[Any]] = None) -> Optional[bool]:
+    """run_task(coroutine) -> bool | None
+
+    ``pybricks.tools.run_task`` (the same function on the hub), typed to
+    accept any awaitable; see :func:`multitask`. Without an argument it
+    returns whether the run loop is active.
+    """
 
 
 class RingBuffer:

{scirodev-0.5.2 → scirodev-0.5.3/scirodev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scirodev
-Version: 0.5.2
+Version: 0.5.3
 Summary: PeakHub / sciro extensions to Pybricks: typed API stubs (sciro.*) and hub tooling on top of pybricksdev
 Author: Thomas Schank
 License: MIT