ezmsg-baseproc 1.0__py3-none-any.whl

ezmsg/baseproc/util/typeresolution.py

@@ -0,0 +1,81 @@
+import typing
+from types import UnionType
+
+from typing_extensions import get_original_bases
+
+
+def resolve_typevar(cls: type, target_typevar: typing.TypeVar) -> type:
+    """
+    Resolve the concrete type bound to a TypeVar in a class hierarchy.
+    This function traverses the method resolution order (MRO) of the class
+    and checks the original bases of each class in the MRO for the TypeVar.
+    If the TypeVar is found, it returns the concrete type bound to it.
+    If the TypeVar is not found, it raises a TypeError.
+    Args:
+        cls (type): The class to inspect.
+        target_typevar (typing.TypeVar): The TypeVar to resolve.
+    Returns:
+        type: The concrete type bound to the TypeVar.
+    """
+    for base in cls.__mro__:
+        orig_bases = get_original_bases(base)
+        for orig_base in orig_bases:
+            origin = typing.get_origin(orig_base)
+            if origin is None:
+                continue
+            params = getattr(origin, "__parameters__", ())
+            if not params:
+                continue
+            if target_typevar in params:
+                index = params.index(target_typevar)
+                args = typing.get_args(orig_base)
+                try:
+                    return args[index]
+                except IndexError:
+                    pass
+    raise TypeError(f"Could not resolve {target_typevar} in {cls}")
+
+
+TypeLike = typing.Union[type[typing.Any], typing.Any, type(None), None]
+
+
+def check_message_type_compatibility(type1: TypeLike, type2: TypeLike) -> bool:
+    """
+    Check if two types are compatible for message passing.
+    Returns True if:
+    - Both are None/NoneType
+    - Either is typing.Any
+    - type1 is a subclass of type2, which includes
+        - type1 and type2 are concrete types and type1 is a subclass of type2
+        - type1 is None/NoneType and type2 is typing.Optional, or
+        - type1 is subtype of the non-None inner type of type2 if type2 is Optional
+    - type1 is a Union/Optional type and all inner types are compatible with type2
+    Args:
+        type1: First type to compare
+        type2: Second type to compare
+    Returns:
+        bool: True if the types are compatible, False otherwise
+    """
+    # If either is Any, they are compatible
+    if type1 is typing.Any or type2 is typing.Any:
+        return True
+
+    # Handle None as NoneType
+    if type1 is None:
+        type1 = type(None)
+    if type2 is None:
+        type2 = type(None)
+
+    # Handle if type1 is Optional/Union type
+    if typing.get_origin(type1) in {typing.Union, UnionType}:
+        return all(check_message_type_compatibility(inner_type, type2) for inner_type in typing.get_args(type1))
+
+    # Regular issubclass check. Handles cases like:
+    # - type1 is a subclass of concrete type2
+    # - type1 is a subclass of the inner type of type2 if type2 is Optional
+    # - type1 is a subclass of one of the inner types of type2 if type2 is Union
+    # - type1 is NoneType and type2 is Optional or Union[None, ...] or Union[NoneType, ...]
+    try:
+        return issubclass(type1, type2)
+    except TypeError:
+        return False

ezmsg_baseproc-1.0.dist-info/METADATA

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: ezmsg-baseproc
+Version: 1.0
+Summary: Base processor classes and protocols for ezmsg signal processing pipelines
+Author-email: Griffin Milsap <griffin.milsap@gmail.com>, Preston Peranich <pperanich@gmail.com>, Chadwick Boulay <chadwick.boulay@gmail.com>, Kyle McGraw <kmcgraw@blackrockneuro.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: ezmsg[axisarray]>=3.6.0
+Requires-Dist: typing-extensions>=4.0.0
+Description-Content-Type: text/markdown
+
+# ezmsg-baseproc
+
+Base processor classes and protocols for building signal processing pipelines in [ezmsg](https://github.com/ezmsg-org/ezmsg).
+
+## Installation
+
+```bash
+pip install ezmsg-baseproc
+```
+
+## Overview
+
+This package provides the foundational processor architecture for ezmsg signal processing:
+
+- **Protocols** - Type definitions for processors, transformers, consumers, and producers
+- **Base Classes** - Abstract base classes for building stateless and stateful processors
+- **Composite Processors** - Classes for chaining processors into pipelines
+- **Unit Wrappers** - ezmsg Unit base classes that wrap processors for graph integration
+
+## Module Structure
+
+```
+ezmsg.baseproc/
+├── protocols.py      # Protocol definitions and type variables
+├── processor.py      # Base non-stateful processors
+├── stateful.py       # Stateful processor base classes
+├── composite.py      # CompositeProcessor and CompositeProducer
+├── units.py          # ezmsg Unit wrappers
+└── util/
+    ├── asio.py           # Async/sync utilities
+    ├── message.py        # SampleMessage definitions
+    ├── profile.py        # Profiling decorators
+    └── typeresolution.py # Type resolution helpers
+```
+
+## Usage
+
+### Creating a Simple Transformer
+
+```python
+from dataclasses import dataclass
+from ezmsg.baseproc import BaseTransformer
+from ezmsg.util.messages.axisarray import AxisArray
+
+@dataclass
+class MySettings:
+    scale: float = 1.0
+
+class MyTransformer(BaseTransformer[MySettings, AxisArray, AxisArray]):
+    def _process(self, message: AxisArray) -> AxisArray:
+        return message.replace(data=message.data * self.settings.scale)
+```
+
+### Creating a Stateful Transformer
+
+```python
+from ezmsg.baseproc import BaseStatefulTransformer, processor_state
+
+@processor_state
+class MyState:
+    count: int = 0
+    hash: int = -1
+
+class MyStatefulTransformer(BaseStatefulTransformer[MySettings, AxisArray, AxisArray, MyState]):
+    def _reset_state(self, message: AxisArray) -> None:
+        self._state.count = 0
+
+    def _process(self, message: AxisArray) -> AxisArray:
+        self._state.count += 1
+        return message
+```
+
+### Creating an ezmsg Unit
+
+```python
+from ezmsg.baseproc import BaseTransformerUnit
+
+class MyUnit(BaseTransformerUnit[MySettings, AxisArray, AxisArray, MyTransformer]):
+    SETTINGS = MySettings
+    # That's all - the base class handles everything else!
+```
+
+## Development
+
+We use [`uv`](https://docs.astral.sh/uv/getting-started/installation/) for development.
+
+1. Install `uv` if not already installed
+2. Clone and cd into the repository
+3. Run `uv sync` to create a `.venv` and install dependencies
+4. Run `uv run pytest tests` to run tests
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

ezmsg_baseproc-1.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+ezmsg/baseproc/__init__.py,sha256=zmhdrRTnj3-ilBitu6zBniV04HJXc_fM_tKYiapFGko,3830
+ezmsg/baseproc/__version__.py,sha256=T-YAefOAMONzdzJN9AfYa3q6PjJ-HRflYoFg45W1xFU,699
+ezmsg/baseproc/composite.py,sha256=Lin4K_rmS2Tnxt-m8daP-PUyeeqL4id5JkVh-AUNrQw,14901
+ezmsg/baseproc/processor.py,sha256=Ir9FtNuVG4yc-frwNxoYrlld99ff1mXwwGWaHxEJ6tY,8056
+ezmsg/baseproc/protocols.py,sha256=QRFh2t-rQgOzU_nlvz5muH4RZWVuzt2VvQ0e_yFy3ZE,5062
+ezmsg/baseproc/stateful.py,sha256=-jjAZIyJA5eiTECi1fSfazfqgv__RtyqPp1ZvLFFIDI,11424
+ezmsg/baseproc/units.py,sha256=TRhjDKw0lqUUst7BHYJKP3AhGpRd6mvcdKxULfeWjA0,10283
+ezmsg/baseproc/util/__init__.py,sha256=hvMUJOBuqioER50GZ5-GZiQbQ9NtQYEze13ZlR2jbMA,37
+ezmsg/baseproc/util/asio.py,sha256=0sF5oDc58DSLlcEgoUpNiqjjcbqnZhjSpQrXn6IdosM,4960
+ezmsg/baseproc/util/message.py,sha256=l_b1b6bXX8N6VF9RbUELzsHs73cKkDURBdIr0lt3CY0,909
+ezmsg/baseproc/util/profile.py,sha256=QlBcIE5H6pA8Z2xbR08NYO3ANjCrJRWy8_BDIURWyOc,5760
+ezmsg/baseproc/util/typeresolution.py,sha256=WCHHYIrMMZ1CfwJWVlJPQgFyY2gnGRNFJVQynAsee7Y,3113
+ezmsg_baseproc-1.0.dist-info/METADATA,sha256=nevLbn7a_ZNfR3KgUA1UUa-WVjq8xYFUnUcfQGIx2YM,3308
+ezmsg_baseproc-1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+ezmsg_baseproc-1.0.dist-info/licenses/LICENSE,sha256=BDD8rfac1Ur7mp0_3izEdr6fHgSA3Or6U1Kb0ZAWsow,1066
+ezmsg_baseproc-1.0.dist-info/RECORD,,

ezmsg_baseproc-1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ezmsg_baseproc-1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ezmsg-org
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.