funcnodes 0.2.1__tar.gz → 0.2.2__tar.gz

{funcnodes-0.2.1 → funcnodes-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: funcnodes
-Version: 0.2.1
+Version: 0.2.2
 Summary: funcnodes
 Author: Julian Kimmig
 Author-email: julian.kimmig@linkdlab.de

{funcnodes-0.2.1 → funcnodes-0.2.2}/funcnodes/__init__.py

@@ -22,6 +22,7 @@ from .worker import (
     WorkerManager,
     assert_worker_manager_running,
 )
+from .data import DataEnum
 
 from . import config
 from .config import RenderOptions
@@ -62,8 +63,9 @@ __all__ = [
     "config",
     "RenderOptions",
     "NoValue",
+    "DataEnum",
 ]
 
-__version__ = "0.2.1"
+__version__ = "0.2.2"
 
 DEBUG = True

funcnodes-0.2.2/funcnodes/data.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+import enum
+from exposedfunctionality.function_parser.types import add_type
+from typing import Union, Any, TypeVar, Type, Generic
+
+
+ET = TypeVar("ET", bound="DataEnum")
+
+
+class DataEnum(enum.Enum):
+    """
+    Base class for data enums. They should be used as a type hint for a function argument for funcnodes.
+    In the function the value can be accessed by using the v method.
+    The reson for this is to be more robust that the values to the function can be
+    passed as the Enum, as a value or as a enum key.
+
+    Example:
+    ```python
+    class TestEnum(DataEnum):
+        A = 1
+        B = 2
+        C = 3
+
+    @NodeDecorator(node_id="test_enum")
+    def test_enum_node(a: TestEnum) -> int:
+        a = TestEnum.v(a)
+        return a
+    """
+
+    def __init_subclass__(cls) -> None:
+        add_type(
+            cls,
+            cls.__name__,
+        )
+
+    @classmethod
+    def interfere(cls: Type[ET], a: Union[ET, str, Any]) -> ET:
+        if isinstance(a, str) and a in cls.__members__:
+            return cls[a]
+        elif isinstance(a, cls):
+            return a
+        else:
+            return cls(a)
+
+    @classmethod
+    def v(cls: Type[ET], a: Union[ET, str, Any]) -> Any:
+        return cls.interfere(a).value

{funcnodes-0.2.1 → funcnodes-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "funcnodes"
-version = "0.2.1"
+version = "0.2.2"
 description = "funcnodes"
 authors = ["Julian Kimmig <julian.kimmig@linkdlab.de>"]
 readme = "README.md"