fix: do not error for new pins manifest

Author: machow

pins/boards.py

@@ -53,6 +53,8 @@ def info(self, path):
 
 
 class BaseBoard:
+    reserved_pin_names = {"_pins.yaml"}
+
     def __init__(
         self,
         board: "str | Path",
@@ -174,8 +176,11 @@ def pin_list(self):
         This is a low-level function; use pin_search() to get more data about
         each pin in a convenient form.
         """
+
         full_paths = self.fs.ls(self.board)
-        return list(map(self.keep_final_path_component, full_paths))
+        pin_names = map(self.keep_final_path_component, full_paths)
+
+        return [name for name in pin_names if name not in self.reserved_pin_names]
 
     def pin_fetch(self, name: str, version: Optional[str] = None) -> Meta:
         meta = self.pin_meta(name, version)
@@ -513,6 +518,8 @@ def validate_pin_name(self, name: str) -> None:
 
         if "/" in name:
             raise ValueError(f"Invalid pin name: {name}")
+        elif name in self.reserved_pin_names:
+            raise ValueError(f"The pin name '{name}' is reserved for internal use.")
 
     def path_to_pin(self, name: str) -> str:
         self.validate_pin_name(name)

pins/tests/conftest.py

@@ -12,6 +12,7 @@
 PATH_TO_EXAMPLE_VERSION = PATH_TO_EXAMPLE_BOARD / "df_csv/20220214T163720Z-9bfad/"
 EXAMPLE_PIN_NAME = "df_csv"
 
+PATH_TO_MANIFEST_BOARD = files("pins") / "tests/pin-board"
 
 # Based on https://github.com/machow/siuba/blob/main/siuba/tests/helpers.py
 BACKEND_MARKS = ["fs_s3", "fs_file", "fs_gcs", "fs_abfs", "fs_rsc"]

pins/tests/pin-board/_pins.yaml

@@ -0,0 +1,5 @@
+x:
+- x/20221215T180351Z-c3943/
+'y':
+- y/20221215T180357Z-9ae7a/
+- y/20221215T180400Z-b81d5/

pins/tests/pin-board/x/20221215T180351Z-c3943/data.txt

@@ -0,0 +1,9 @@
+file: x.json
+file_size: 23
+pin_hash: c3943ca5a9aab2df
+type: json
+title: 'x: a pinned integer vector'
+description: ~
+tags: ~
+created: 20221215T180351Z
+api_version: 1.0

pins/tests/pin-board/x/20221215T180351Z-c3943/x.json

@@ -0,0 +1 @@
+[1,2,3,4,5,6,7,8,9,10]

pins/tests/pin-board/y/20221215T180357Z-9ae7a/data.txt

@@ -0,0 +1,9 @@
+file: y.rds
+file_size: 61
+pin_hash: 9ae7a970010c84e0
+type: rds
+title: 'y: a pinned integer vector'
+description: ~
+tags: ~
+created: 20221215T180357Z
+api_version: 1.0

pins/tests/pin-board/y/20221215T180357Z-9ae7a/y.rds

@@ -0,0 +1,9 @@
+file: y.json
+file_size: 53
+pin_hash: b81d5bea9e760608
+type: json
+title: 'y: a pinned integer vector'
+description: ~
+tags: ~
+created: 20221215T180400Z
+api_version: 1.0

pins/tests/pin-board/y/20221215T180400Z-b81d5/data.txt

@@ -0,0 +1 @@
+[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20]

pins/tests/pin-board/y/20221215T180400Z-b81d5/y.json

@@ -4,7 +4,7 @@
 
 from pins.errors import PinsError
 from pins.tests.helpers import xfail_fs
-from pins.tests.conftest import PATH_TO_EXAMPLE_BOARD
+from pins.tests.conftest import PATH_TO_EXAMPLE_BOARD, PATH_TO_MANIFEST_BOARD
 
 
 NOT_A_PIN = "not_a_pin_abcdefg"
@@ -22,6 +22,15 @@ def board(backend):
     backend.teardown_board(board)
 
 
+@pytest.fixture(scope="session")
+def board_manifest(backend):
+    board = backend.create_tmp_board(str(PATH_TO_MANIFEST_BOARD.absolute()))
+
+    yield board
+
+    backend.teardown_board(board)
+
+
 # pin_list --------------------------------------------------------------------
 
 
@@ -145,3 +154,40 @@ def test_compat_pin_read_supported(board):
 
 
 # pin_write ----
+
+# manifest -----
+
+
+def test_board_pin_write_manifest_name_error(board_manifest):
+    if board_manifest.fs.protocol == "rsc":
+        pytest.skip()
+
+    with pytest.raises(PinsError) as exc_info:
+        board_manifest.pin_write([1], "_pins.yaml", type="json")
+
+    assert "name '_pins.yaml' is reserved for internal use." in exc_info.value.args[0]
+
+
+def test_board_manifest_pin_list_no_internal_name(board_manifest):
+    assert board_manifest.pin_list() == ["x", "y"]
+
+
+def test_board_manifest_pin_exist_internal_name_errors(board_manifest):
+    with pytest.raises(PinsError) as exc_info:
+        board_manifest.pin_exists("_pins.yaml")
+
+    assert "reserved for internal use." in exc_info.value.args[0]
+
+
+def test_board_manifest_pin_read_internal_errors(board_manifest):
+    with pytest.raises(PinsError) as exc_info:
+        board_manifest.pin_read("_pins.yaml")
+
+    assert "reserved for internal use." in exc_info.value.args[0]
+
+
+def test_board_manifest_pin_search(board_manifest):
+    res = board_manifest.pin_search("x", as_df=False)
+
+    assert len(res) == 1
+    assert res[0].name == "x"