Merge pull request #92 from machow/feat-auto-title

feat: generalize automatic titles

Author: machow

pins/boards.py

@@ -531,7 +531,7 @@ def prepare_pin_version(
             raise NotImplementedError("Type argument is required.")
 
         if title is None:
-            title = default_title(x, type)
+            title = default_title(x, name)
 
         # create metadata from object on disk ---------------------------------
         # save all pin data to a temporary folder (including data.txt), so we

pins/drivers.py

@@ -1,5 +1,3 @@
-import builtins
-
 from pathlib import Path
 
 from .config import get_allow_pickle_read, PINS_ENV_INSECURE_READ
@@ -119,17 +117,14 @@ def save_data(
     return fname
 
 
-def default_title(obj, type):
-    if type == "csv":
-        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"A pinned {shape_str} CSV"
-        raise NotImplementedError(
-            f"No default csv title support for class: {builtins.type(obj)}"
-        )
+def default_title(obj, name):
+    import pandas as pd
 
-    raise NotImplementedError(f"Cannot create default title for type: {type}")
+    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"

pins/tests/test_boards.py

@@ -38,7 +38,7 @@ def test_board_pin_write_default_title(board):
 
     df = pd.DataFrame({"x": [1, 2, 3], "y": [4, 5, 6]})
     meta = board.pin_write(df, "df_csv", title=None, type="csv")
-    assert meta.title == "A pinned 3 x 2 CSV"
+    assert meta.title == "df_csv: a pinned 3 x 2 DataFrame"
 
 
 def test_board_pin_write_prepare_pin(board, tmp_dir2):

pins/tests/test_drivers.py

@@ -1,13 +1,14 @@
 import fsspec
 import pytest
+import pandas as pd
 
 from pathlib import Path
 
 from pins.tests.helpers import rm_env
 
 from pins.meta import MetaRaw
 from pins.config import PINS_ENV_INSECURE_READ
-from pins.drivers import load_data, save_data
+from pins.drivers import load_data, save_data, default_title
 from pins.errors import PinsInsecureReadError
 
 
@@ -21,6 +22,29 @@ def some_joblib(tmp_dir2):
     return p_obj
 
 
+# default title ---------------------------------------------------------------
+
+
+class ExC:
+    class D:
+        pass
+
+
+@pytest.mark.parametrize(
+    "obj, dst_title",
+    [
+        (pd.DataFrame({"x": [1, 2]}), "somename: a pinned 2 x 1 DataFrame"),
+        (pd.DataFrame({"x": [1], "y": [2]}), "somename: a pinned 1 x 2 DataFrame"),
+        (ExC(), "somename: a pinned ExC object"),
+        (ExC().D(), "somename: a pinned ExC.D object"),
+        ([1, 2, 3], "somename: a pinned list object"),
+    ],
+)
+def test_default_title(obj, dst_title):
+    res = default_title(obj, "somename")
+    assert res == dst_title
+
+
 def test_driver_roundtrip_csv(tmp_dir2):
     # TODO: I think this test highlights the challenge of getting the flow
     # between metadata, drivers, and the metafactory right.