Use adaptor for default_title

Author: nathanjmcdougall

pins/adaptors.py

@@ -67,6 +67,13 @@ def data_preview(self) -> str:
         # TODO(compat): set display none in index.html
         return json.dumps({})
 
+    def default_title(self, name: str) -> str:
+        return f"{name}: a pinned {self._obj_name} object"
+
+    @property
+    def _obj_name(self) -> str:
+        return type(self._d).__qualname__
+
 
 class _DFAdaptor(_Adaptor):
     _d: ClassVar[_DataFrame]
@@ -78,6 +85,10 @@ def __init__(self, data: _DataFrame) -> None:
     @abstractmethod
     def columns(self) -> list[Any]: ...
 
+    @property
+    @abstractmethod
+    def shape(self) -> tuple[int, int]: ...
+
     @abstractmethod
     def head(self, n: int) -> Self: ...
 
@@ -96,6 +107,12 @@ def data_preview(self) -> str:
 
         return json.dumps({"data": data_no_nulls, "columns": columns})
 
+    def default_title(self, name: str) -> str:
+        # TODO(compat): title says CSV rather than data.frame
+        # see https://github.com/machow/pins-python/issues/5
+        shape_str = " x ".join(map(str, self.shape))
+        return f"{name}: a pinned {shape_str} DataFrame"
+
 
 class _PandasAdaptor(_DFAdaptor):
     def __init__(self, data: _AbstractPandasFrame) -> None:
@@ -105,6 +122,10 @@ def __init__(self, data: _AbstractPandasFrame) -> None:
     def columns(self) -> list[Any]:
         return self._d.columns.tolist()
 
+    @property
+    def shape(self) -> tuple[int, int]:
+        return self._d.shape
+
     def head(self, n: int) -> Self:
         return _PandasAdaptor(self._d.head(n))
 

pins/drivers.py

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import Sequence
+from typing import Any, Sequence
 
 from pins.adaptors import _create_adaptor
 
@@ -176,14 +176,6 @@ def save_data(obj, fname, type=None, apply_suffix: bool = True) -> "str | Sequen
     return final_name
 
 
-def default_title(obj, name):
-    import pandas as pd
-
-    if isinstance(obj, pd.DataFrame):
-        # TODO(compat): title says CSV rather than data.frame
-        # see https://github.com/machow/pins-python/issues/5
-        shape_str = " x ".join(map(str, obj.shape))
-        return f"{name}: a pinned {shape_str} DataFrame"
-    else:
-        obj_name = type(obj).__qualname__
-        return f"{name}: a pinned {obj_name} object"
+def default_title(obj: Any, name: str) -> str:
+    # Kept for backward compatibility only.
+    return _create_adaptor(obj).default_title(name)

pins/tests/test_adaptors.py

@@ -72,6 +72,10 @@ def test_dict(self):
             adaptor = _Adaptor(data)
             assert adaptor.data_preview == "{}"
 
+    def test_default_title(self):
+        adaptor = _Adaptor(42)
+        assert adaptor.default_title("my_data") == "my_data: a pinned int object"
+
 
 class TestPandasAdaptor:
     def test_columns(self):
@@ -81,6 +85,13 @@ def test_columns(self):
         assert isinstance(adaptor, _PandasAdaptor)
         assert adaptor.columns == ["a", "b"]
 
+    def test_shape(self):
+        df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6]})
+        adaptor = _PandasAdaptor(df)
+        assert isinstance(adaptor, _DFAdaptor)
+        assert isinstance(adaptor, _PandasAdaptor)
+        assert adaptor.shape == (3, 2)
+
     def test_head(self):
         df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6]})
         adaptor = _PandasAdaptor(df)
@@ -128,6 +139,11 @@ def test_data_preview(self):
         )
         assert adaptor.data_preview == expected
 
+    def test_default_title(self):
+        df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6]})
+        adaptor = _PandasAdaptor(df)
+        assert adaptor.default_title("my_df") == "my_df: a pinned 3 x 2 DataFrame"
+
 
 class TestAbstractBackends:
     class TestAbstractPandasFrame: