Merge pull request #510 from gerlero/names

Switch preprocessing.system functions to PEP 8/`FoamCase`-like names

Author: gerlero

foamlib/preprocessing/system.py

@@ -1,38 +1,81 @@
-# ruff: noqa: N802, D100
+# ruff: noqa: D100
 from __future__ import annotations
 
+import sys
 from pathlib import Path
 
+if sys.version_info >= (3, 13):
+    from warnings import deprecated
+else:
+    from typing_extensions import deprecated
+
 from foamlib.preprocessing.of_dict import FoamDictInstruction
 
 
-def simulationParameters(keys: list[str]) -> FoamDictInstruction:
+def simulation_parameters(keys: list[str]) -> FoamDictInstruction:
     """Return the FoamDictInstruction for simulationParameters."""
     return FoamDictInstruction(
         file_name=Path("system/simulationParameters"),
         keys=keys,
     )
 
+    """
+    Alias for :func:`simulation_parameters`.
+
+    Deprecated since version 1.3.0: use :func:`simulation_parameters` instead.
+    """
+    return simulation_parameters(keys)
+
 
-def controlDict(keys: list[str]) -> FoamDictInstruction:
+def control_dict(keys: list[str]) -> FoamDictInstruction:
     """Return the FoamDictInstruction for controlDict."""
     return FoamDictInstruction(
         file_name=Path("system/controlDict"),
         keys=keys,
     )
 
 
-def fvSchemes(keys: list[str]) -> FoamDictInstruction:
+@deprecated("Use 'control_dict' instead")
+def controlDict(keys: list[str]) -> FoamDictInstruction:  # noqa: N802
+    """
+    Alias for :func:`control_dict`.
+
+    Deprecated since version 1.3.0: use :func:`control_dict` instead.
+    """
+    return control_dict(keys)
+
+
+def fv_schemes(keys: list[str]) -> FoamDictInstruction:
     """Return the FoamDictInstruction for fvSchemes."""
     return FoamDictInstruction(
         file_name=Path("system/fvSchemes"),
         keys=keys,
     )
 
 
-def fvSolution(keys: list[str]) -> FoamDictInstruction:
+@deprecated("Use 'fv_schemes' instead")
+def fvSchemes(keys: list[str]) -> FoamDictInstruction:  # noqa: N802
+    """
+    Alias for :func:`fv_schemes`.
+
+    Deprecated since version 1.3.0: use :func:`fv_schemes` instead.
+    """
+    return fv_schemes(keys)
+
+
+def fv_solution(keys: list[str]) -> FoamDictInstruction:
     """Return the FoamDictInstruction for fvSolution."""
     return FoamDictInstruction(
         file_name=Path("system/fvSolution"),
         keys=keys,
     )
+
+
+@deprecated("Use 'fv_solution' instead")
+def fvSolution(keys: list[str]) -> FoamDictInstruction:  # noqa: N802
+    """
+    Alias for :func:`fv_solution`.
+
+    Deprecated since version 1.3.0: use :func:`fv_solution` instead.
+    """
+    return fv_solution(keys)

pyproject.toml

@@ -35,7 +35,7 @@ dependencies = [
     "numpy>=1,<3",
     "pyparsing>=3.1.2,<4",
     "rich>=13,<15",
-    "typing-extensions>=4.4,<5; python_version<'3.12'",
+    "typing-extensions>=4.5,<5; python_version<'3.13'",
 ]
 
 [project.optional-dependencies]

tests/test_preprocessing/test_grid_generator.py

@@ -14,7 +14,7 @@
 from foamlib.preprocessing.grid_parameter_sweep import CaseParameter, GridParameter
 from foamlib.preprocessing.of_dict import FoamDictInstruction
 from foamlib.preprocessing.parameter_study import grid_generator
-from foamlib.preprocessing.system import simulationParameters
+from foamlib.preprocessing.system import simulation_parameters
 
 CSV_FILE = "tests/test_preprocessing/test_parastudy.csv"
 OUTPUT_FOLDER = "tests/test_preprocessing/Cases/"
@@ -49,7 +49,7 @@ def test_grid_parameter() -> None:
         #         file_name=Path("system/simulationParameters"),
         #         keys=[f"res{i}"],
         #      )
-        modify_dict=[simulationParameters(keys=[f"res{i}"]) for i in range(1, 6)],
+        modify_dict=[simulation_parameters(keys=[f"res{i}"]) for i in range(1, 6)],
         parameters=[
             CaseParameter(name="coarse", values=grid_parameters(1)),
             CaseParameter(name="mid", values=grid_parameters(2)),