flowrep 0.6.0__tar.gz → 0.6.1__tar.gz

{flowrep-0.6.0 → flowrep-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flowrep
-Version: 0.6.0
+Version: 0.6.1
 Summary: flowrep - Your premier tool for workflow representations
 Project-URL: Homepage, https://pyiron.org/
 Project-URL: Documentation, https://flowrep.readthedocs.io
@@ -51,6 +51,8 @@ Requires-Dist: packaging<=26.2,>=24.2
 Requires-Dist: pydantic<2.13.0,>=2.12.0
 Requires-Dist: pyiron-snippets<2.0.0,>=1.3.0
 Requires-Dist: typing-extensions<4.17.0,>=4.14.1
+Provides-Extra: dataviewer
+Requires-Dist: ipython; extra == 'dataviewer'
 Provides-Extra: notebooks
 Requires-Dist: numpy==2.4.6; extra == 'notebooks'
 Provides-Extra: pwd

{flowrep-0.6.0 → flowrep-0.6.1}/pyproject.toml

@@ -32,6 +32,7 @@ pwd = [ "python-workflow-definition==0.1.5",]
 notebooks = [ "numpy==2.4.6",]
 storage = [ "bagofholding==0.1.12",]
 storage-widget = [ "flowrep[storage]", "ipytree==0.2.2",]
+dataviewer = [ "ipython",]
 
 [tool.ruff]
 exclude = [ "docs", "notebooks", "_version.py",]

{flowrep-0.6.0 → flowrep-0.6.1}/src/flowrep/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.6.0'
-__version_tuple__ = version_tuple = (0, 6, 0)
+__version__ = version = '0.6.1'
+__version_tuple__ = version_tuple = (0, 6, 1)
 
 __commit_id__ = commit_id = None

{flowrep-0.6.0 → flowrep-0.6.1}/src/flowrep/retrospective/datastructures.py

@@ -33,6 +33,7 @@ from flowrep.prospective import (
     while_recipe,
     workflow_recipe,
 )
+from flowrep.retrospective import viewer
 
 
 class NotData(metaclass=singleton.Singleton):
@@ -93,6 +94,16 @@ class NodeData(Generic[RecipeType], abc.ABC):
     @abc.abstractmethod
     def from_recipe(cls, recipe: RecipeType) -> Self: ...
 
+    def view(self, expanded: bool = False):
+        """
+        Display this data object as structured JSON in a notebook and return the display
+        object. Falls back to a plain-text representation when IPython is not available.
+        """
+        return viewer.view(self, expanded=expanded)
+
+    def _repr_json_(self):
+        return self.view()._repr_json_()
+
 
 def recipe2data(
     recipe: union_types.RecipeDiscrimination, allow_variadic_inputs: bool = True

flowrep-0.6.1/src/flowrep/retrospective/viewer.py

@@ -0,0 +1,77 @@
+"""
+Viewer helpers for retrospective data objects.
+
+Provides a notebook-friendly JSON view and a plain-text fallback.
+"""
+
+from __future__ import annotations
+
+import dataclasses
+import inspect
+from collections.abc import Mapping, Sequence
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from flowrep.retrospective.datastructures import NodeData
+
+try:
+    from IPython.display import JSON as _JSON
+
+    _has_ipython = True
+except ImportError:  # pragma: no cover
+    _has_ipython = False
+
+
+def _to_jsonable(data: Any) -> Any:
+    if data is None or isinstance(data, bool | int | float | str):
+        return data
+    if isinstance(data, Mapping):
+        return {
+            _to_jsonable_key(key): _to_jsonable(value) for key, value in data.items()
+        }
+    if isinstance(data, Sequence) and not isinstance(data, str):
+        return [_to_jsonable(item) for item in data]
+    if dataclasses.is_dataclass(data) and not isinstance(data, type):
+        serialized = {
+            field.name: _to_jsonable(getattr(data, field.name))
+            for field in dataclasses.fields(data)
+        }
+        serialized["type"] = data.__class__.__name__
+        return serialized
+    if hasattr(data, "model_dump"):
+        model_dump = data.model_dump(mode="json")
+        if isinstance(model_dump, Mapping):
+            model_dump = {**model_dump, "type": data.__class__.__name__}
+        return _to_jsonable(model_dump)
+    if isinstance(data, type):
+        return f"{data.__module__}.{data.__qualname__}"
+    if inspect.isroutine(data):
+        return f"{data.__module__}.{data.__qualname__}"
+    return repr(data)
+
+
+def _to_jsonable_key(key: Any) -> str:
+    jsonable = _to_jsonable(key)
+    if isinstance(jsonable, str):
+        return jsonable
+    return repr(jsonable)
+
+
+def _view_json(data: NodeData, *, expanded: bool = False):
+    """Display *data* as structured JSON (requires IPython)."""
+    return _JSON(_to_jsonable(data), expanded=expanded)
+
+
+def _view_str(data: NodeData) -> str:
+    """Return a plain-text representation of *data*."""
+    return str(data)
+
+
+def view(data: NodeData, *, expanded: bool = False):
+    """
+    Display *data* as structured JSON when IPython is available, otherwise
+    return a plain-text representation.
+    """
+    if _has_ipython:
+        return _view_json(data, expanded=expanded)
+    return _view_str(data)