underscore prefix for _adaptors.py; abstracting df_type in default_title

Author: nathanjmcdougall

pins/adaptors.py renamed to pins/_adaptors.py

@@ -68,11 +68,13 @@ def data_preview(self) -> str:
         return json.dumps({})
 
     def default_title(self, name: str) -> str:
-        return f"{name}: a pinned {self._obj_name} object"
+        # TODO(compat): title says CSV rather than data.frame
+        # see https://github.com/machow/pins-python/issues/5
+        return f"{name}: a pinned {self._obj_name}"
 
     @property
     def _obj_name(self) -> str:
-        return type(self._d).__qualname__
+        return f"{type(self._d).__qualname__} object"
 
 
 class _DFAdaptor(_Adaptor):
@@ -81,6 +83,11 @@ class _DFAdaptor(_Adaptor):
     def __init__(self, data: _DataFrame) -> None:
         super().__init__(data)
 
+    @property
+    def df_type(self) -> str:
+        # Consider over-riding this for specialized dataframes
+        return "DataFrame"
+
     @property
     @abstractmethod
     def columns(self) -> list[Any]: ...
@@ -107,11 +114,13 @@ def data_preview(self) -> str:
 
         return json.dumps({"data": data_no_nulls, "columns": columns})
 
+    @property
+    def _obj_name(self) -> str:
+        return f"{type(self._d).__qualname__} object"
+
     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"
+        row, col = self.shape
+        return f"{name}: a pinned {row} x {col} {self.df_type}"
 
 
 class _PandasAdaptor(_DFAdaptor):

pins/boards.py

@@ -11,7 +11,7 @@
 
 from importlib_resources import files
 
-from .adaptors import _create_adaptor
+from ._adaptors import _create_adaptor
 from .cache import PinsCache
 from .config import get_allow_rsc_short_name
 from .drivers import default_title, load_data, load_file, save_data

pins/drivers.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 from typing import Any, Sequence
 
-from pins.adaptors import _create_adaptor
+from pins._adaptors import _create_adaptor
 
 from .config import PINS_ENV_INSECURE_READ, get_allow_pickle_read
 from .errors import PinsInsecureReadError

pins/tests/test_adaptors.py

@@ -5,7 +5,7 @@
 import pytest
 from pandas.testing import assert_frame_equal
 
-from pins.adaptors import (
+from pins._adaptors import (
     _AbstractPandasFrame,
     _Adaptor,
     _create_adaptor,
@@ -78,6 +78,11 @@ def test_default_title(self):
 
 
 class TestPandasAdaptor:
+    def test_df_type(self):
+        df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6]})
+        adaptor = _PandasAdaptor(df)
+        assert adaptor.df_type == "DataFrame"
+
     def test_columns(self):
         df = pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6]})
         adaptor = _PandasAdaptor(df)