🚀 feat(tests) add time_series named 'a/b' in sample tests (#91)

* feat(tests) add scalar named 'a/b' in sample tests

* add test for time_series with name containing /

* (.gitignore) add venv/ dir

* (sample.py) add check that names does not contain /

* (sample.py) fix check_names

* (sample.py) fix check_names for str argument

* (sample.py) fix check_names tests

---------

Co-authored-by: Fabien Casenave <[email protected]>
Co-authored-by: Xavier Roynard <[email protected]>

Author: 3 people

.gitignore

@@ -5,6 +5,9 @@ tests/post/*.yaml
 tests/problem_definition/*.csv
 examples/**/*.png
 tests/problem_definition/split.csv
+# Heavy data
+*.cgns
+!notebooks/ex_rotor37_pv.cgns
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -13,6 +16,7 @@ __pycache__/
 
 # Distribution / packaging
 .Python
+venv/
 build/
 develop-eggs/
 dist/
@@ -32,6 +36,7 @@ share/python-wheels/
 *.egg
 MANIFEST
 _version.py
+oryx-build-commands.txt
 
 # Unit test / coverage reports
 htmlcov/
@@ -69,10 +74,6 @@ docs/_extra/
 docs/source/notebooks/*.png
 docs/source/notebooks/*.yaml
 
-# Heavy data
-*.cgns
-!notebooks/ex_rotor37_pv.cgns
-
 ###############################################################################
 # .gitignore PATTERN FORMAT:
 #  - A blank line matches no files, so it can serve as a separator for readability.
@@ -106,4 +107,4 @@ docs/source/notebooks/*.yaml
 #    For example, "abc/**" matches all files inside directory "abc", relative to the location of the .gitignore file, with infinite depth.
 #  - A slash followed by two consecutive asterisks then a slash matches zero or more directories.
 #    For example, "a/**/b" matches "a/b", "a/x/b", "a/x/y/b" and so on.
-#  - Other consecutive asterisks are considered regular asterisks and will match according to the previous rules.
+#  - Other consecutive asterisks are considered regular asterisks and will match according to the previous rules.

src/plaid/containers/sample.py

@@ -57,6 +57,24 @@
 # %% Classes
 
 
+def _check_names(names: Union[str, list[str]]):
+    """Check that names do not contain invalid character ``/``.
+
+    Args:
+        names (Union[str, list[str]]): The names to check.
+
+    Raises:
+        ValueError: If any name contains the invalid character ``/``.
+    """
+    if isinstance(names, str):
+        names = [names]
+    for name in names:
+        if (name is not None) and ("/" in name):
+            raise ValueError(
+                f"feature_names containing `/` are not allowed, but {name=}, you should first replace any occurence of `/` with something else, for example: `name.replace('/','__')`"
+            )
+
+
 def read_index(pyTree: list, dim: list[int]):
     """Read Index Array or Index Range from CGNS.
 
@@ -809,6 +827,8 @@ def init_base(
         Returns:
             CGNSNode: The created Base node.
         """
+        _check_names([base_name])
+
         time = self.get_time_assignment(time)
 
         if base_name is None:
@@ -951,6 +971,8 @@ def init_zone(
         Returns:
             CGLNode: The newly initialized zone node within the CGNS tree.
         """
+        _check_names([zone_name])
+
         # init_tree will look for default time
         self.init_tree(time)
         # get_base will look for default base_name and time
@@ -1138,6 +1160,7 @@ def add_scalar(self, name: str, value: ScalarType) -> None:
             name (str): The name of the scalar value.
             value (ScalarType): The scalar value to add or update in the dictionary.
         """
+        _check_names([name])
         if self._scalars is None:
             self._scalars = {name: value}
         else:
@@ -1211,6 +1234,7 @@ def add_time_series(
         Raises:
             TypeError: Raised if the length of `time_sequence` is not equal to the length of `values`.
         """
+        _check_names([name])
         assert len(time_sequence) == len(values), (
             "time sequence and values do not have the same size"
         )
@@ -1573,6 +1597,7 @@ def add_field(
         Raises:
             KeyError: Raised if the specified zone does not exist in the given base.
         """
+        _check_names([name])
         # init_tree will look for default time
         self.init_tree(time)
         # get_zone will look for default zone_name, base_name and time

tests/containers/test_sample.py

@@ -18,6 +18,7 @@
 
 from plaid.containers.sample import (
     Sample,
+    _check_names,
     read_index,
     read_index_array,
     read_index_range,
@@ -115,6 +116,17 @@ def sample_with_tree_and_scalar_and_time_series(
 # %% Test
 
 
+def test_check_names():
+    _check_names("test name")
+    _check_names(["test name", "test_name_2"])
+    with pytest.raises(ValueError):
+        _check_names("test/name")
+    with pytest.raises(ValueError):
+        _check_names(["test/name"])
+    with pytest.raises(ValueError):
+        _check_names([r"test\/name"])
+
+
 def test_read_index(tree, physical_dim):
     read_index(tree, physical_dim)