♻️ REFACTOR: yaml format

make a mapping and use title as keys

Author: chrisjsewell

README.md

@@ -25,14 +25,14 @@ expected output content
 
 `yaml` format:
 ```yaml
-- title: name1
-  description: description
+name1:
+  description: optional description
   input: |-
     input content
   expected: |-
     expected output content
-- title: name2
-  description: description
+name2:
+  description: optional description
   input: |-
     input content
   expected: |-

pytest_param_files/__init__.py

@@ -1,5 +1,5 @@
 """Create pytest parametrize decorators from external files."""
 from .main import ParamTestData
 
-__version__ = "0.4.0"
+__version__ = "0.5.0"
 __all__ = ("ParamTestData",)

pytest_param_files/main.py

@@ -265,23 +265,25 @@ def read(self) -> Iterator[ParamTestData]:
         """
         text = self.path.read_text(encoding=self.encoding)
         node = yaml.compose(text, yaml.SafeLoader)
-        if not isinstance(node, yaml.SequenceNode):
+        if not isinstance(node, yaml.MappingNode):
             raise TypeError(f"Expected sequence, got {type(node)}")
-        data = yaml.safe_load(text)
+        data: dict = yaml.safe_load(text)
         assert len(node.value) == len(data), "YAML node count mismatch"
-        item_node: yaml.Node
-        for index, (item_node, item) in enumerate(zip(node.value, data)):
-            line = item_node.start_mark.line + 1
+        title_node: yaml.Node
+        for index, ((title_node, _), (title, item)) in enumerate(
+            zip(node.value, data.items())
+        ):
+            line = title_node.start_mark.line + 1
             if not isinstance(item, dict):
                 raise TypeError(
-                    f"Expected mapping at line {line}, got {type(item_node)}"
+                    f"Expected mapping value at line {line}, got {type(item)}"
                 )
-            for key in ("title", "content", "expected"):
+            for key in ("content", "expected"):
                 if key not in item:
                     raise KeyError(f"Missing '{key}' key for item at line {line}")
             yield ParamTestData(
                 line,
-                item["title"],
+                title,
                 item.get("description"),
                 item["content"],
                 item["expected"],
@@ -326,7 +328,7 @@ def regen_file(self, data: ParamTestData, actual: Any, **kwargs: Any) -> None:
         # TODO ideally here we would maintain comments and formatting
         # perhaps using ruamel.yaml, although that is a pain
         new = yaml.safe_load(self.path.read_text(encoding=self.encoding))
-        new[data.index]["expected"] = actual
+        new[data.title]["expected"] = actual
         text = yaml.dump(
             new, Dumper=CustomDumper, default_flow_style=False, sort_keys=False
         )

tests/fixtures/basic.yaml

@@ -1,8 +1,8 @@
-- title: name1
+name1:
   description: description
   content: Something
   expected: Other
-- title: name2
+name2:
   description: description
   content: Something
   expected: Other

tests/test_basic.py

@@ -31,7 +31,7 @@ def test_basic_yaml(file_params):
     assert file_params.title.startswith("name")
     assert file_params.description == "description"
     assert file_params.content.rstrip() == "Something"
-    # assert file_params.expected.rstrip() == "Other"
+    assert file_params.expected.rstrip() == "Other"
     file_params.assert_expected("Other", rstrip=True)
-    # with pytest.raises(AssertionError, match="basic.yaml"):
-    #     file_params.assert_expected("Otherx", rstrip=True)
+    with pytest.raises(AssertionError, match="basic.yaml"):
+        file_params.assert_expected("Otherx", rstrip=True)