resolved issues raised by ruff and pyright

Author: ClaasRostock

src/sim_explorer/case.py

@@ -33,7 +33,7 @@
 from sim_explorer.models import Temporal
 from sim_explorer.system_interface import SystemInterface
 from sim_explorer.system_interface_osp import SystemInterfaceOSP
-from sim_explorer.utils.json5 import json5_check
+from sim_explorer.utils.json5 import json5_check, json5_path, json5_read, json5_update, json5_write
 from sim_explorer.utils.misc import from_xml
 from sim_explorer.utils.paths import relative_path
 from sim_explorer.utils.types import (
@@ -749,7 +749,7 @@ def read_cases(self) -> None:
         """
 
         if not isinstance(self.js_py.get("base"), dict) or json5_path(self.js_py, "$.base.spec", dict) is None:
-            raise CaseInitError(f"Main section 'base' is needed. Found {list(self.js_py.js_py.keys())}") from None
+            raise CaseInitError(f"Main section 'base' is needed. Found {list(self.js_py.keys())}") from None
 
         # we need to peek into the base case where startTime and stopTime should be defined
         start_time: float = json5_path(self.js_py, "$.base.spec.startTime", float) or 0.0
@@ -830,8 +830,6 @@ def disect_variable(
                         raise ValueError(f"Unhandled index {p}[{i}] for variable {pre}") from e
                     if not 0 <= idx < cvar_len:
                         raise ValueError(f"Index {idx} of variable {pre} out of range") from None
-                    if not isinstance(rng, list):
-                        raise ValueError(f"A list was expected as range here. Found {rng}") from None
                     rng.append(idx)
                 else:
                     assert len(parts_ellipses) == 2, f"RangeError: Exactly two indices expected in {p} of {pre}"  # noqa: PLR2004
@@ -939,7 +937,7 @@ def __init__(
     ) -> None:
         self.file: Path | None  # None denotes that results are not automatically saved
         self.case: Case | None = None
-        self.res: Json5
+        self.res: dict[str, Any] = {}
         if (case is None or isinstance(case, str | Path)) and file is not None:
             self._init_from_existing(file)  # instantiating from existing results file (work with data)
         elif isinstance(case, Case):  # instantiating from cases file (for data collection)
@@ -962,7 +960,7 @@ def _init_from_existing(self, file: str | Path) -> None:
             raise CaseInitError(f"Cases {Path(_cases)} instantiation error") from ValueError
         case_name: str | None = header.get("case")
         assert case_name is not None, f"Case name not found in results file {file}"
-        self.case: Case | None = cases.case_by_name(case_name)
+        self.case = cases.case_by_name(case_name)
         assert self.case is not None, f"Case {case_name} not found."
         assert isinstance(self.case.cases, Cases), "Cases object not defined."
         self.case.add_results_object(res=self)  # make Results object known to self.case

src/sim_explorer/system_interface.py

@@ -87,7 +87,7 @@ def read_system_structure(
         -------
             The system structure as (json) dict as if the structure was read through osp_system_structure_from_js5
         """
-        system_structure: dict[str, Any] | Json5
+        system_structure: dict[str, Any]
         assert file.exists(), f"System structure {file} not found"
         if file.suffix == ".xml":  # assume the standard OspSystemStructure.xml file
             system_structure = read_system_structure_xml(file)

src/sim_explorer/utils/json5.py

@@ -3,12 +3,12 @@
 import codecs
 import logging
 import re
+from collections.abc import Sequence
 from pathlib import Path
-from typing import Any, Sequence
+from typing import Any
 
 import pyjson5 as json5
-from jsonpath_ng.ext import parse  # type: ignore
-from jsonpath_ng.jsonpath import DatumInContext  # type: ignore
+from jsonpath_ng.ext import parse
 from pyjson5 import Json5Exception, Json5IllegalCharacter
 
 logger = logging.getLogger(__name__)
@@ -29,7 +29,13 @@ def json5_check(js5: dict[str, Any]) -> bool:
     return json5.encode_noop(js5)
 
 
-def json5_write(js5: dict, file: Path | str, *, indent: int = 3, compact: bool = True):
+def json5_write(  # noqa: C901, PLR0915
+    js5: dict[str, Any],
+    file: Path | str,
+    *,
+    indent: int = 3,
+    compact: bool = True,
+) -> None:
     """Use pyjson5 to print the json5 code to file, optionally using indenting the code to make it human-readable.
 
     Args:
@@ -38,7 +44,7 @@ def json5_write(js5: dict, file: Path | str, *, indent: int = 3, compact: bool =
         compact (bool) = True: compact file writing, i.e. try to keep keys unquoted and avoid escapes
     """
 
-    def _unescape(chars: str):
+    def _unescape(chars: str) -> str:
         """Try to unescape chars. If that results in a valid Json5 value we keep the unescaped version."""
         if len(chars) and chars[0] in ("[", "{"):
             pre = chars[0]
@@ -59,7 +65,7 @@ def _unescape(chars: str):
         else:  # unescaped this is still valid Json5
             return pre + unescaped + post
 
-    def _pretty_print(chars: str):
+    def _pretty_print(chars: str) -> None:  # noqa: C901
         nonlocal fp, level, indent, _list, _collect
 
         # first all actions with explicit fp.write
@@ -72,8 +78,8 @@ def _pretty_print(chars: str):
                 except Json5Exception:
                     _collect += ": "
                 else:
-                    _collect = no_quote + ": "
-                fp.write(_collect)
+                    _collect = f"{no_quote}: "
+                _ = fp.write(_collect)
                 _collect = ""
         elif chars == "{":
             level += 1
@@ -90,37 +96,36 @@ def _pretty_print(chars: str):
         elif chars == "]":
             _list -= 1
         # write to file and reset _collect
-        if chars in ("{", "}", "[", "]", ","):
-            fp.write(_unescape(_collect))
+        if chars in {"{", "}", "[", "]", ","}:
+            _ = fp.write(_unescape(_collect))
             _collect = ""
 
     assert json5.encode_noop(js5), f"Python object {js5} is not serializable as Json5"
     if indent == -1:  # just dump it no pretty print, Json5 features, ...
         txt = json5.encode(js5, quotationmark="'")
         with Path.open(Path(file), "w") as fp:
-            fp.write(txt)
+            _ = fp.write(txt)
 
     elif indent >= 0:  # pretty-print and other features are taken into account
         level: int = 0
         _list: int = 0
         _collect: str = ""
         with Path.open(Path(file), "w") as fp:
-            json5.encode_callback(js5, _pretty_print, supply_bytes=False, quotationmark="'")
+            _ = json5.encode_callback(js5, _pretty_print, supply_bytes=False, quotationmark="'")
 
 
-def json5_find_identifier_start(txt: str, pos: int):
+def json5_find_identifier_start(txt: str, pos: int) -> int:
     """Find the position of the start of the identifier in txt going backwards from pos."""
     p: int = pos - 1
     while True:
         if p < 0:
             return 0
-        elif txt[p] in (",", "{", "}", "[", "]", ":"):
+        if txt[p] in (",", "{", "}", "[", "]", ":"):
             return p + 1
-        else:
-            p -= 1
+        p -= 1
 
 
-def json5_try_correct(txt: str, pos: int):
+def json5_try_correct(txt: str, pos: int) -> tuple[bool, str]:
     """Try to repair the json5 illegal character found at pos in txt.
 
     1. Check whether pos points to a key and set the key in quotation marks.
@@ -145,7 +150,7 @@ def json5_try_correct(txt: str, pos: int):
     return (success, txt)
 
 
-def json5_read(file: Path | str, *, save: int = 0) -> dict:
+def json5_read(file: Path | str, *, save: int = 0) -> dict[str, Any]:  # noqa: C901, PLR0912
     """Read the Json5 file.
     If key or comment errors are encountered they are tried fixed 'en route'.
     save: 0: do not save, 1: save if changed, 2: save in any case. Overwrite file when saving.
@@ -161,8 +166,7 @@ def get_line(txt: str, pos: int) -> int:
             _p = txt.find("\n", _p) + 1
             if _p > pos or _p <= 0:
                 return line + 1
-            else:
-                line += 1
+            line += 1
 
     with Path.open(Path(file), "r") as fp:
         txt = fp.read()
@@ -177,7 +181,7 @@ def get_line(txt: str, pos: int) -> int:
                 _line = get_line(txt, pos)
                 if err.args[0].startswith("Expected b'comma'"):
                     raise ValueError(f"Missing comma? in {file}, line {_line} at {txt[pos : pos + 20]}") from err
-                elif err.args[0].startswith("Expected b'IdentifierStart'"):
+                if err.args[0].startswith("Expected b'IdentifierStart'"):
                     success, txt = json5_try_correct(txt, pos)
                     if not success:
                         raise ValueError(
@@ -197,13 +201,17 @@ def get_line(txt: str, pos: int) -> int:
             break
     if save == 0 and num_warn > 0:
         logger.warning(f"Decoding the file {file}, {num_warn} illegal characters were detected. Not saved.")
-    elif (save == 1 and num_warn > 0) or save == 2:
+    elif (save == 1 and num_warn > 0) or save == 2:  # noqa: PLR2004
         logger.warning(f"Decoding the file {file}, {num_warn} illegal characters were detected. File re-saved.")
         json5_write(js5, file, indent=3, compact=True)
     return js5
 
 
-def json5_path(js5: dict[str, Any], path: str, typ: type | None = None) -> Any:
+def json5_path(
+    js5: dict[str, Any],
+    path: str,
+    typ: type | None = None,
+) -> Any:  # noqa: ANN401
     """Evaluate a JsonPath expression on the Json5 code and return the result.
 
     Syntax see `RFC9535 <https://datatracker.ietf.org/doc/html/rfc9535>`_
@@ -231,26 +239,23 @@ def json5_path(js5: dict[str, Any], path: str, typ: type | None = None) -> Any:
     """
     compiled = parse(path)
     data = compiled.find(js5)
-    #        print("DATA", data)
     val = None
-    if not len(data):  # not found
+    if not data:  # not found
         return None
-    elif len(data) == 1:  # found a single element
-        val = data[0].value
-    else:  # multiple elements
-        if isinstance(data[0], DatumInContext):
-            val = [x.value for x in data]
-
-    if val is not None and typ is not None:  # check also the type
-        if not isinstance(val, typ):
-            try:  # try to convert
-                val = typ(val)
-            except ValueError:
-                raise ValueError(f"{path} matches, but type {typ} does not match {type(val)} in {js5}.") from None
+    val = data[0].value if len(data) == 1 else [x.value for x in data]
+    if val is not None and typ is not None and not isinstance(val, typ):
+        try:  # try to convert
+            val = typ(val)
+        except ValueError:
+            raise ValueError(f"{path} matches, but type {typ} does not match {type(val)} in {js5}.") from None
     return val
 
 
-def json5_update(js5: dict[str, Any], keys: Sequence[str], data: Any):
+def json5_update(
+    js5: dict[str, Any],
+    keys: Sequence[str],
+    data: Any,  # noqa: ANN401
+) -> None:
     """Append data to the js_py dict at the path pointed to by keys.
     So far this is a minimum implementation for adding data.
 
@@ -259,20 +264,19 @@ def json5_update(js5: dict[str, Any], keys: Sequence[str], data: Any):
         keys (Sequence): Sequence of keys. All keys down to the place where to update the dict shall be included
         data (Any): the data to be added/updated. Dicts are updated, lists are appended
     """
+    value: Any = None
     for i, k in enumerate(keys):
         if k not in js5:
             for j in range(len(keys) - 1, i - 1, -1):
                 data = {keys[j]: data}
             break
-        else:
-            parent = js5
-            js5 = js5[k]  # type: ignore [assignment]
-    # print(f"UPDATE path:{path}, parent:{parent}, k:{k}: {data}")
-    if isinstance(js5, list):
-        js5.append(data)
-    elif isinstance(js5, dict):
-        js5.update(data)
+        parent = js5
+        value = js5[k]
+    if isinstance(value, list):
+        value.append(data)
+    elif isinstance(value, dict):
+        value.update(data)
     elif isinstance(parent, dict):  # update the parent dict (replace a value)
-        js5.update({k: data})
+        parent.update({k: data})
     else:
-        raise ValueError(f"Unknown type of path: {js5}")
+        raise TypeError(f"Unknown type of path: {js5}")

tests/test_case.py

@@ -152,7 +152,7 @@ def test_case_range(timetable: Cases):
     case_x = timetable.case_by_name("caseX")
     assert case_x is not None, "Case with name 'caseX' does not exist."
     with pytest.raises(ValueError) as err:
-        assert case_x.cases.disect_variable("x[99]")
+        _ = case_x.cases.disect_variable("x[99]")
     assert err.value.args[0] == "Index 99 of variable x out of range"
     assert case_x.cases.disect_variable("x[1]")[2] == [1]
     var_info = case_x.cases.disect_variable("i")[1]

tests/test_cases.py

@@ -34,10 +34,12 @@ def test_cases():
         "modelFile not as expected"
     )
     for c in ("base", "restitution", "restitutionAndGravity", "gravity"):
-        assert c in cases.js_py.js_py, f"The case '{c}' is expected to be defined in {list(cases.js_py.js_py.keys())}"
-    assert cases.js_py.jspath("$.header.variables.g[0]") == "bb"
-    assert cases.js_py.jspath("$.header.variables.g[1]") == "g", f"Found {cases.js_py.jspath('$.variables.g[1]')}"
-    assert cases.js_py.jspath("$.header.variables.g[2]") == "Gravity acting on the ball"
+        assert c in cases.js_py, f"The case '{c}' is expected to be defined in {list(cases.js_py.keys())}"
+    assert json5_path(cases.js_py, "$.header.variables.g[0]") == "bb"
+    assert json5_path(cases.js_py, "$.header.variables.g[1]") == "g", (
+        f"Found {json5_path(cases.js_py, '$.variables.g[1]')}"
+    )
+    assert json5_path(cases.js_py, "$.header.variables.g[2]") == "Gravity acting on the ball"
     # find_by_name
     for c in cases.base.list_cases(as_name=False, flat=True):
         assert isinstance(c, Case)

tests/test_pyjson5.py

@@ -1,6 +1,7 @@
 import logging
 import time
 from pathlib import Path
+from typing import Any
 
 import pytest
 
@@ -67,7 +68,7 @@ def repair_all_json5(folder: Path, do_change: int):
     for f2 in ("data/BouncingBall3D/test_case", "data/BouncingBall3D/test_results"):
         f = Path(__file__).parent / f2
         js5 = json5_read(f, save=0)  # we do not change these as the comments will vanish
-        json5_check(js5)
+        _ = json5_check(js5)
         logger.info(f"File {f} ok")
 
 
@@ -76,7 +77,7 @@ def do_change() -> int:
     return 0
 
 
-def test_all_json5(do_change):
+def test_all_json5(do_change: int) -> None:
     repair_all_json5(Path(__file__).parent, do_change=do_change)
 
 
@@ -93,7 +94,7 @@ def test_all_json5(do_change):
 
 
 def test_write():
-    js5: dict[str, str|int|float|list|dict] = {
+    js5: dict[str, str | int | float | list[Any] | dict[str, Any]] = {
         "Hello": "World",
         "t@his": ["is", "a", "simple", "test"],
         "h[0]w": "this dict",
@@ -106,8 +107,7 @@ def test_write():
     }
     # print("AS STRING", json5.dumps(js5, quotationmark="'", quote_keys=False))
     json5_write(js5, "test_write.js5", indent=3)
-    with open("test_write.js5", "r") as fp:
-        txt = fp.read()
+    txt = Path("test_write.js5").read_text()
     expected = """
 {
    Hello: 'World',
@@ -121,7 +121,7 @@ def test_write():
    notANumber: 'NaN'}"""
     assert txt != expected, f"EXPECTED:\n{expected}\nFOUND:\n{txt}"
     # print(txt)
-    json5_read("test_write.js5")
+    _ = json5_read("test_write.js5")
 
 
 if __name__ == "__main__":

tests/test_run_bouncingball0.py

@@ -131,7 +131,7 @@ def test_run_cases():  # noqa: PLR0915
     }
     """
     # key results data for base case
-    h0 = res.jspath("$.['0'].bb.h")
+    h0 = json5_path(res, "$.['0'].bb.h")
     assert h0 is not None
     t0 = sqrt(2 * h0 / 9.81)  # half-period time with full restitution
     v_max = sqrt(2 * h0 * 9.81)  # speed when hitting bottom

tests/test_system_interface_osp.py

@@ -61,7 +61,7 @@ def di(
         caus: str,
         expected: str,
     ):
-        res = SystemInterfaceOSP.valid_initial(causality=caus, variability=var, only_default=only_default)[0]
+        res = SystemInterfaceOSP.valid_initial(causality=caus, variability=var)[0]
         assert res == expected, f"valid_initial({var}, {caus}): Found {res} but expected {expected}"
 
     di(var="constant", caus="parameter", expected="ERROR_a")