Merge pull request #38 from pyiron/change_to_plural

Make triple and restriction plural
pyiron · Jan 19, 2025 · 8181a5a · 8181a5a
2 parents d21c168 + 257e19a
commit 8181a5a
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 17 deletions.
diff --git a/semantikon/converter.py b/semantikon/converter.py
@@ -42,7 +42,7 @@ def parse_metadata(value):
 
     Returns:
         dictionary of the metadata. Available keys are `units`, `label`,
-        `triple`, `uri` and `shape`. See `semantikon.typing.u` for more details.
+        `triples`, `uri` and `shape`. See `semantikon.typing.u` for more details.
     """
     # When there is only one metadata `use_list=False` must have been used
     if len(value.__metadata__) == 1 and isinstance(value.__metadata__[0], str):
@@ -63,10 +63,10 @@ def _meta_to_dict(value):
         return {
             "units": None,
             "label": None,
-            "triple": None,
+            "triples": None,
             "uri": None,
             "shape": None,
-            "restriction": None,
+            "restrictions": None,
             "dtype": value,
         }
     else:
@@ -82,7 +82,7 @@ def parse_input_args(func: callable):
 
     Returns:
         dictionary of the input arguments. Available keys are `units`, `label`,
-        `triple`, `uri` and `shape`. See `semantikon.typing.u` for more details.
+        `triples`, `uri` and `shape`. See `semantikon.typing.u` for more details.
     """
     return {
         key: _meta_to_dict(value.annotation)
@@ -100,7 +100,7 @@ def parse_output_args(func: callable):
     Returns:
         dictionary of the output arguments if there is only one output. Otherwise,
         a list of dictionaries is returned. Available keys are `units`,
-        `label`, `triple`, `uri` and `shape`. See `semantikon.typing.u` for
+        `label`, `triples`, `uri` and `shape`. See `semantikon.typing.u` for
         more details.
     """
     sig = inspect.signature(func)

diff --git a/semantikon/typing.py b/semantikon/typing.py
@@ -18,10 +18,10 @@ def u(
     /,
     units: str | None = None,
     label: str | None = None,
-    triple: tuple[tuple[str, str, str], ...] | tuple[str, str, str] | None = None,
+    triples: tuple[tuple[str, str, str], ...] | tuple[str, str, str] | None = None,
     uri: str | None = None,
     shape: tuple[int] | None = None,
-    restriction: tuple[tuple[str, str]] | None = None,
+    restrictions: tuple[tuple[str, str]] | None = None,
     use_list: bool = True,
     **kwargs,
 ):
@@ -32,10 +32,10 @@ def u(
     result = {
         "units": units,
         "label": label,
-        "triple": triple,
+        "triples": triples,
         "uri": uri,
         "shape": shape,
-        "restriction": restriction,
+        "restrictions": restrictions,
     }
     for key, value in parent_result.items():
         if result[key] is None:

diff --git a/tests/unit/test_dataclass.py b/tests/unit/test_dataclass.py
@@ -53,10 +53,10 @@ def test_parse_metadata(self):
                 "units": "eV",
                 "label": "TotalEnergy",
                 "associate_to_sample": True,
-                "triple": None,
+                "triples": None,
                 "shape": None,
                 "uri": None,
-                "restriction": None,
+                "restrictions": None,
             },
         )
 

diff --git a/tests/unit/test_parsers.py b/tests/unit/test_parsers.py
@@ -19,10 +19,10 @@ def get_speed(
             for key in [
                 "units",
                 "uri",
-                "triple",
+                "triples",
                 "shape",
                 "label",
-                "restriction",
+                "restrictions",
                 "dtype"
             ]:
                 self.assertTrue(key in input_args["distance"])
@@ -32,10 +32,10 @@ def get_speed(
             for key in [
                 "units",
                 "uri",
-                "triple",
+                "triples",
                 "shape",
                 "label",
-                "restriction",
+                "restrictions",
                 "dtype"
             ]:
                 self.assertTrue(key in output_args)
@@ -60,10 +60,10 @@ def get_speed(
                 for key in [
                     "units",
                     "uri",
-                    "triple",
+                    "triples",
                     "shape",
                     "label",
-                    "restriction",
+                    "restrictions",
                     "dtype"
                 ]:
                     self.assertTrue(key in output_arg)