Merge branch 'main' into nk/auto_deps_auto_callable_model

Author: Nijat Khanbabayev

.copier-answers.yaml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: b74d698
+_commit: 3160d4c
 _src_path: https://github.com/python-project-templates/base.git
 add_docs: false
 add_extension: python

.github/workflows/build.yaml

@@ -53,7 +53,7 @@ jobs:
       run: make coverage
 
     - name: Upload test results (Python)
-      uses: actions/upload-artifact@v6
+      uses: actions/upload-artifact@v7
       with:
         name: py-test-results-${{ matrix.os }}-${{ matrix.python-version }}-
         path: junit.xml
@@ -74,7 +74,7 @@ jobs:
     - name: Twine check
       run: make dist
 
-    - uses: actions/upload-artifact@v6
+    - uses: actions/upload-artifact@v7
       with:
         name: dist-${{matrix.os}}
         path: dist

.gitignore

@@ -11,6 +11,9 @@ __pycache__/
 *.exp
 *.lib
 
+# Rust
+target
+
 # Distribution / packaging
 .Python
 build/
@@ -55,26 +58,12 @@ junit.xml
 .hypothesis/
 .pytest_cache/
 
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
+# Django
 *.log
 local_settings.py
 db.sqlite3
 db.sqlite3-journal
 
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# PyBuilder
-target/
-
 # IPython
 profile_default/
 ipython_config.py
@@ -85,15 +74,12 @@ ipython_config.py
 # pipenv
 Pipfile.lock
 
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
+# Celery
 celerybeat-schedule
 celerybeat.pid
 
-# SageMath parsed files
-*.sage.py
+# Airspeed Velocity
+.asv
 
 # Environments
 .env
@@ -141,14 +127,12 @@ js/node_modules
 js/test-results
 js/playwright-report
 js/*.tgz
-ccflow/extension
 
 # Jupyter
 .ipynb_checkpoints
 .autoversion
 Untitled*.ipynb
-!ccflow/extension/ccflow.json
-!ccflow/extension/install.json
+ccflow/extension
 ccflow/nbextension
 ccflow/labextension
 
@@ -158,8 +142,11 @@ ccflow/labextension
 # Rust
 target
 
+# Hydra
+outputs/
+multirun/
+
 # Examples
-outputs
 raw.html
 extracted.csv
 etl.db

Makefile

@@ -46,12 +46,15 @@ format: fix
 ################
 # Other Checks #
 ################
-.PHONY: check-manifest checks check
+.PHONY: check-dist check-types checks check
 
-check-manifest:  ## check python sdist manifest with check-manifest
-	check-manifest -v
+check-dist:  ## check python sdist and wheel with check-dist
+	check-dist -v
 
-checks: check-manifest
+check-types:  ## check python types with ty
+	ty check --python $$(which python)
+
+checks: check-dist
 
 # Alias
 check: checks

ccflow/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.8.0"
+__version__ = "0.8.1"
 
 # Import exttypes early so modules that import `from ccflow import PyObjectPath` during
 # initialization find it (avoids circular import issues with functions that import utilities

ccflow/base.py

@@ -150,7 +150,7 @@ def __new__(self, name: str, bases: Tuple[type], namespaces: Dict[str, Any], **k
 
 
 class BaseModel(PydanticBaseModel, _RegistryMixin, metaclass=_SerializeAsAnyMeta):
-    """BaseModel is a base class for all pydantic models within the cubist flow framework.
+    """BaseModel is a base class for all pydantic models within the ccflow framework.
 
     This gives us a way to add functionality to the framework, including
         - Type of object is part of serialization/deserialization
@@ -241,6 +241,34 @@ def get_widget(
         # Can't use self.model_dump_json or self.model_dump because they don't expose the fallback argument
         return JSON(self.__pydantic_serializer__.to_python(self, **kwargs), **(widget_kwargs or {}))
 
+    def __panel__(self):
+        """Return a Panel viewable for this model.
+
+        Requires ccflow UI dependencies (panel, panel_material_ui).
+        """
+        try:
+            from ccflow.ui.model import ModelViewer
+        except ImportError:
+            raise ImportError(
+                "panel and other optional dependencies must be installed to use ModelViewer. Pip install ccflow[full] to install all optional dependencies."
+            ) from None
+
+        return ModelViewer(model=self)
+
+    def get_panel(self):
+        """Get a Panel pane for this model.
+
+        Requires panel to be installed.
+        """
+        try:
+            import panel as pn
+        except ImportError:
+            raise ImportError(
+                "panel and other optional dependencies must be installed to use get_panel(). Pip install ccflow[full] to install all optional dependencies."
+            ) from None
+
+        return pn.panel(self)
+
     @model_validator(mode="wrap")
     def _base_model_validator(cls, v, handler, info):
         if isinstance(v, str):
@@ -400,6 +428,15 @@ def models(self) -> MappingProxyType:
         """Return an immutable pointer to the models dictionary."""
         return MappingProxyType(self._models)
 
+    def __panel__(self):
+        """Return a Panel viewable for this registry.
+
+        Requires ccflow UI dependencies (panel, panel_material_ui).
+        """
+        from ccflow.ui.registry import ModelRegistryViewer
+
+        return ModelRegistryViewer(self)
+
     @classmethod
     def root(cls) -> Self:
         """Return a static instance of the root registry."""

ccflow/context.py

@@ -1,6 +1,5 @@
 """This module defines re-usable contexts for the "Callable Model" framework defined in flow.callable.py."""
 
-import warnings
 from datetime import date, datetime
 from typing import Any, Generic, Hashable, Optional, Sequence, Set, TypeVar
 
@@ -11,9 +10,6 @@
 from .exttypes import Frequency
 from .validators import normalize_date, normalize_datetime
 
-warnings.simplefilter("always", DeprecationWarning)
-
-
 __all__ = (
     "FlowContext",
     "NullContext",

ccflow/exttypes/narwhals.py

@@ -59,6 +59,13 @@ def validate_from_any(value: Any):
                 if source_args and source_args[0] and source_args[0] is not Any:
                     backend = source_args[0].__module__.split(".", 1)[0]
 
+                if "backend" in value:
+                    if backend is None:
+                        # backend in source args takes precedence
+                        backend = value["backend"]
+
+                    value = value["data"]
+
                 try:
                     try:
                         value = nw.from_dict(value, backend=backend)
@@ -89,7 +96,10 @@ def validate_from_any(value: Any):
 
         def serialize(value: Any):
             if isinstance(value, nw.DataFrame):
-                return value.to_dict(as_series=False)
+                return {
+                    "data": value.to_dict(as_series=False),
+                    "backend": value.implementation.value,
+                }
             else:
                 raise ValueError("Cannot serialize a LazyFrame to JSON. Please use the collect() method to convert it to a DataFrame first.")
 

ccflow/tests/evaluators/util.py

@@ -1,5 +1,5 @@
 import logging
-from datetime import date, datetime
+from datetime import date, datetime, timezone
 from typing import Any, ClassVar, List, Optional
 
 import pandas as pd
@@ -36,7 +36,7 @@ class MyDateCallable(CallableModel):
 
     @Flow.call(volatile=True, validate_result=False)
     def current_time(self, context: DateContext):
-        out = datetime.utcnow()
+        out = datetime.now(timezone.utc)
         log.info("Current datetime: %s", out)
         return out
 

ccflow/tests/result/test_narwhals.py

@@ -3,6 +3,7 @@
 import narwhals.stable.v1 as nw
 import polars as pl
 import pytest
+from polars.testing import assert_frame_equal
 
 from ccflow.exttypes.narwhals import (
     DataFrameT,
@@ -90,3 +91,10 @@ class MyNarwhalsResult(NarwhalsDataFrameResult):
     df = pl.DataFrame(data)
     result = MyNarwhalsResult(df=df)
     assert result.df.schema["d"] == nw.Float64()
+
+
+def test_serialization(data):
+    df = pl.DataFrame(data)
+    result = NarwhalsDataFrameResult(df=df)
+    result2 = NarwhalsDataFrameResult.model_validate_json(result.model_dump_json())
+    assert_frame_equal(result.df.to_native(), result2.df.to_native())