fix: do not support type file in pin_write

Author: machow

pins/boards.py

@@ -225,7 +225,7 @@ def pin_read(self, name, version: Optional[str] = None, hash: Optional[str] = No
             meta, self.construct_path([pin_name, meta.version.version])
         )
 
-    def pin_write(
+    def _pin_store(
         self,
         x,
         name: Optional[str] = None,
@@ -236,32 +236,6 @@ def pin_write(
         versioned: Optional[bool] = None,
         created: Optional[datetime] = None,
     ) -> Meta:
-        """Write a pin object to the board.
-
-        Parameters
-        ----------
-        x:
-            An object (e.g. a pandas DataFrame) to pin.
-        name:
-            Pin name.
-        type:
-            File type used to save `x` to disk. May be "csv", "arrow", "parquet",
-            "joblib", "json", or "file".
-        title:
-            A title for the pin; most important for shared boards so that others
-            can understand what the pin contains. If omitted, a brief description
-            of the contents will be automatically generated.
-        description:
-            A detailed description of the pin contents.
-        metadata:
-            A dictionary containing additional metadata to store with the pin.
-            This gets stored on the Meta.user field.
-        versioned:
-            Whether the pin should be versioned. Defaults to versioning.
-        created:
-            A date to store in the Meta.created field. This field may be used as
-            part of the pin version name.
-        """
 
         if type == "feather":
             warn_deprecated(
@@ -334,6 +308,54 @@ def pin_write(
 
         return meta
 
+    def pin_write(
+        self,
+        x,
+        name: Optional[str] = None,
+        type: Optional[str] = None,
+        title: Optional[str] = None,
+        description: Optional[str] = None,
+        metadata: Optional[Mapping] = None,
+        versioned: Optional[bool] = None,
+        created: Optional[datetime] = None,
+    ) -> Meta:
+        """Write a pin object to the board.
+
+        Parameters
+        ----------
+        x:
+            An object (e.g. a pandas DataFrame) to pin.
+        name:
+            Pin name.
+        type:
+            File type used to save `x` to disk. May be "csv", "arrow", "parquet",
+            "joblib", "json", or "file".
+        title:
+            A title for the pin; most important for shared boards so that others
+            can understand what the pin contains. If omitted, a brief description
+            of the contents will be automatically generated.
+        description:
+            A detailed description of the pin contents.
+        metadata:
+            A dictionary containing additional metadata to store with the pin.
+            This gets stored on the Meta.user field.
+        versioned:
+            Whether the pin should be versioned. Defaults to versioning.
+        created:
+            A date to store in the Meta.created field. This field may be used as
+            part of the pin version name.
+        """
+
+        if type == "file":
+            raise NotImplementedError(
+                ".pin_write() does not support type='file'. "
+                "Use .pin_upload() to save a file as a pin."
+            )
+
+        return self._pin_store(
+            x, name, type, title, description, metadata, versioned, created
+        )
+
     def pin_download(self, name, version=None, hash=None) -> Sequence[str]:
         """Download the files contained in a pin.
 
@@ -380,7 +402,7 @@ def pin_upload(self, paths, name=None, title=None, description=None, metadata=No
         using [](`~pins.boards.BaseBoard.pin_download`).
         """
 
-        return self.pin_write(
+        return self._pin_store(
             paths,
             name,
             type="file",

pins/tests/test_boards.py

@@ -123,18 +123,15 @@ def test_board_pin_write_feather_deprecated(board):
         board.pin_write(df, "cool_pin", type="feather")
 
 
-def test_board_pin_write_file(board, tmp_path):
+def test_board_pin_write_file_raises_error(board, tmp_path):
     df = pd.DataFrame({"x": [1, 2, 3]})
 
     path = tmp_path.joinpath("data.csv")
     df.to_csv(path, index=False)
 
     # TODO: should this error?
-    meta = board.pin_write(path, "cool_pin", type="file")
-    assert meta.type == "file"
-
     with pytest.raises(NotImplementedError):
-        (pin_path,) = board.pin_read("cool_pin")
+        board.pin_write(path, "cool_pin", type="file")
 
 
 def test_board_pin_download(board_with_cache, tmp_path):
@@ -151,6 +148,9 @@ def test_board_pin_download(board_with_cache, tmp_path):
     df = pd.read_csv(pin_path)
     assert df.x.tolist() == [1, 2, 3]
 
+    with pytest.raises(NotImplementedError):
+        board_with_cache.pin_read("cool_pin")
+
 
 def test_board_pin_download_filename(board_with_cache, tmp_path):
     # create and save data