Bump ruff from 0.5.5 to 0.5.6 (#3501)

* Bump ruff from 0.5.5 to 0.5.6 Bumps [ruff](https://github.com/astral-sh/ruff) from 0.5.5 to 0.5.6. - [Release notes](https://github.com/astral-sh/ruff/releases) - [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) - [Commits](astral-sh/ruff@0.5.5...0.5.6) --- updated-dependencies: - dependency-name: ruff dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * 🚨 Ruff v0.5.6 update * 🏷️ Fix parameterframe typing location --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: james <james.cook1@ukaea.uk>
Fusion-Power-Plant-Framework · Sep 9, 2024 · 68bff56 · 68bff56
1 parent f60dd99
commit 68bff56
Show file tree

Hide file tree

Showing 53 changed files with 223 additions and 81 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -12,7 +12,7 @@ repos:
         exclude: test_data
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.5
+    rev: v0.5.6
     hooks:
       - id: ruff
         args: [--fix]

diff --git a/bluemira/balance_of_plant/steady_state.py b/bluemira/balance_of_plant/steady_state.py
@@ -30,7 +30,7 @@
 if TYPE_CHECKING:
     from collections.abc import Iterable
 
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike
 
 
 CoolantPumpingT = TypeVar("CoolantPumpingT", bound="CoolantPumping")
@@ -436,7 +436,8 @@ def calculate(*args, **kwargs) -> tuple[float, float, float, float]:
             Parasitic loads to power the tritium plant
         p_other:
             Parasitic loads to power other miscellaneous things
-        """
+        """  # noqa: DOC202
+        ...
 
 
 @dataclass

diff --git a/bluemira/base/builder.py b/bluemira/base/builder.py
@@ -20,7 +20,7 @@
 
 if TYPE_CHECKING:
     from bluemira.base.components import ComponentT
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike
 
 BuildConfig: TypeAlias = dict[str, Union[int, float, str, "BuildConfig"]]
 """

diff --git a/bluemira/base/components.py b/bluemira/base/components.py
@@ -299,10 +299,6 @@ def add_child(self, child: Component):
         child:
             The child to be added
 
-        Returns
-        -------
-        This component.
-
         Raises
         ------
         ComponentError

diff --git a/bluemira/base/designer.py b/bluemira/base/designer.py
@@ -19,7 +19,7 @@
     from collections.abc import Callable
 
     from bluemira.base.builder import BuildConfig
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike, ParameterFrameT
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike, ParameterFrameT
 
 _DesignerReturnT = TypeVar("_DesignerReturnT")
 

diff --git a/bluemira/base/parameter_frame/_frame.py b/bluemira/base/parameter_frame/_frame.py
@@ -39,7 +39,7 @@
     from collections.abc import Generator, Iterable
     from types import GenericAlias
 
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike, ParameterFrameT
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike, ParameterFrameT
     from bluemira.base.reactor_config import ConfigParams
 
 

diff --git a/bluemira/base/parameter_frame/typing.py → bluemira/base/parameter_frame/typed.py b/bluemira/base/parameter_frame/typing.py → bluemira/base/parameter_frame/typed.py
diff --git a/bluemira/base/reactor_config.py b/bluemira/base/reactor_config.py
@@ -21,7 +21,7 @@
     from collections.abc import Iterable
 
     from bluemira.base.parameter_frame._parameter import ParamDictT
-    from bluemira.base.parameter_frame.typing import ParameterFrameT
+    from bluemira.base.parameter_frame.typed import ParameterFrameT
 
 
 @dataclass
@@ -329,7 +329,7 @@ def _extract(self, arg_keys: tuple[str], *, is_config: bool = True) -> dict:
 
         for next_idx, current_arg_key in enumerate(arg_keys, start=1):
             current_layer = current_layer.get(current_arg_key, {})
-            next_arg_key = arg_keys[next_idx] if next_idx < len(arg_keys) else None  # noqa: PLR1736
+            next_arg_key = arg_keys[next_idx] if next_idx < len(arg_keys) else None
 
             to_extract = current_layer
             if not is_config:

diff --git a/bluemira/builders/coil_supports.py b/bluemira/builders/coil_supports.py
@@ -47,8 +47,8 @@
 
 if TYPE_CHECKING:
     from bluemira.base.builder import BuildConfig
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike
-    from bluemira.optimisation.typing import ConstraintT
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike
+    from bluemira.optimisation import ConstraintT
 
 
 @dataclass

diff --git a/bluemira/builders/cryostat.py b/bluemira/builders/cryostat.py
@@ -29,7 +29,7 @@
 from bluemira.geometry.tools import make_polygon
 
 if TYPE_CHECKING:
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike
 
 
 @dataclass

diff --git a/bluemira/builders/divertor.py b/bluemira/builders/divertor.py
@@ -26,7 +26,7 @@
 
 if TYPE_CHECKING:
     from bluemira.base.builder import BuildConfig
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike
     from bluemira.geometry.face import BluemiraFace
 
 

diff --git a/bluemira/builders/pf_coil.py b/bluemira/builders/pf_coil.py
@@ -26,7 +26,7 @@
 
 if TYPE_CHECKING:
     from bluemira.base.builder import BuildConfig
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike
     from bluemira.geometry.wire import BluemiraWire
 
 

diff --git a/bluemira/builders/plasma.py b/bluemira/builders/plasma.py
@@ -23,7 +23,7 @@
 
 if TYPE_CHECKING:
     from bluemira.base.builder import BuildConfig
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike
     from bluemira.geometry.wire import BluemiraWire
 
 

diff --git a/bluemira/builders/radiation_shield.py b/bluemira/builders/radiation_shield.py
@@ -29,7 +29,7 @@
 
 if TYPE_CHECKING:
     from bluemira.base.builder import BuildConfig
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike
 
 
 @dataclass

diff --git a/bluemira/builders/tf_coils.py b/bluemira/builders/tf_coils.py
@@ -31,8 +31,8 @@
 from bluemira.optimisation import optimise
 
 if TYPE_CHECKING:
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike
-    from bluemira.geometry.optimisation.typing import GeomConstraintT
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike
+    from bluemira.geometry.optimisation import GeomConstraintT
     from bluemira.geometry.parameterisations import GeometryParameterisation
     from bluemira.geometry.wire import BluemiraWire
 

diff --git a/bluemira/builders/thermal_shield.py b/bluemira/builders/thermal_shield.py
@@ -42,7 +42,7 @@
 
 if TYPE_CHECKING:
     from bluemira.base.builder import BuildConfig
-    from bluemira.base.parameter_frame.typing import ParameterFrameLike
+    from bluemira.base.parameter_frame.typed import ParameterFrameLike
     from bluemira.geometry.wire import BluemiraWire
 
 

diff --git a/bluemira/codes/typing.py → bluemira/codes/_typing.py b/bluemira/codes/typing.py → bluemira/codes/_typing.py
diff --git a/bluemira/codes/wrapper.py b/bluemira/codes/wrapper.py
@@ -17,6 +17,7 @@
 if TYPE_CHECKING:
     from bluemira.base.builder import BuildConfig
     from bluemira.base.parameter_frame import Parameter as ParameterFrame
+    from bluemira.codes._typing import TransportSolver
     from bluemira.codes.interface import CodesSolver
     from bluemira.codes.params import MappedParameterFrame
 
@@ -86,7 +87,7 @@ def transport_code_solver(
     params: ParameterFrame,
     build_config: BuildConfig,
     module: str = "PLASMOD",
-) -> CodesSolver:
+) -> TransportSolver:
     """
     Transport solver
 

diff --git a/bluemira/display/auto_config.py b/bluemira/display/auto_config.py
@@ -11,7 +11,8 @@
 import functools
 import os
 import sys
-from multiprocessing import Pool, TimeoutError
+from multiprocessing import Pool
+from multiprocessing import TimeoutError as mpTimeoutError
 
 import numpy as np
 import seaborn as sns
@@ -44,7 +45,7 @@ def get_primary_screen_size(timeout: float = 3):
         result = pool.apply_async(_get_primary_screen_size)
         try:
             val = result.get(timeout=timeout)
-        except TimeoutError:
+        except mpTimeoutError:
             pool.terminate()
             bluemira_warn(
                 "Unable to get screensize, please check your X server."

diff --git a/bluemira/equilibria/optimisation/problem/_breakdown.py b/bluemira/equilibria/optimisation/problem/_breakdown.py
@@ -52,7 +52,8 @@ def breakdown_point(self) -> tuple[float, float]:
             Radial coordinate of the breakdown point
         z_c:
             Vertical coordinate of the breakdown point
-        """
+        """  # noqa: DOC202
+        ...
 
     @abc.abstractproperty
     def breakdown_radius(self) -> float:

diff --git a/bluemira/equilibria/optimisation/problem/base.py b/bluemira/equilibria/optimisation/problem/base.py
@@ -25,7 +25,7 @@
 if TYPE_CHECKING:
     from bluemira.equilibria.coils import CoilSet
     from bluemira.optimisation._optimiser import OptimiserResult
-    from bluemira.optimisation.typing import ConstraintT
+    from bluemira.optimisation.typed import ConstraintT
 
 
 @dataclass

diff --git a/bluemira/equilibria/solve.py b/bluemira/equilibria/solve.py
@@ -88,7 +88,8 @@ def __call__(
         Returns
         -------
         True if the convergence criterion is met, else False.
-        """
+        """  # noqa: DOC202
+        ...
 
     def check_converged(self, value: float) -> bool:
         """

diff --git a/bluemira/fuel_cycle/timeline_tools.py b/bluemira/fuel_cycle/timeline_tools.py
@@ -161,7 +161,8 @@ def generate_phase_availabilities(
         Returns
         -------
         Operational availabilities at each operational phase
-        """
+        """  # noqa: DOC202
+        ...
 
 
 class UniformLearningStrategy(LearningStrategy):
@@ -351,7 +352,8 @@ def generate_distribution(self, n: int, integral: float) -> np.ndarray:
         Returns
         -------
         The distribution of size n and of the correct integral value
-        """
+        """  # noqa: DOC202
+        ...
 
 
 class LogNormalAvailabilityStrategy(OperationalAvailabilityStrategy):

diff --git a/bluemira/gen_params.py b/bluemira/gen_params.py
@@ -27,14 +27,18 @@
     bluemira_warn,
     print_banner,
 )
-from bluemira.base.parameter_frame import ParameterFrame
+from bluemira.base.parameter_frame._frame import ParameterFrame
 from bluemira.base.parameter_frame._parameter import ParamDictT
 from bluemira.utilities.tools import get_module, json_writer
 
 
-def def_param() -> dict:
+def def_param() -> dict[str, str]:
     """
     Get the default parameter json skeleton
+
+    Returns
+    -------
+    the default parameter keys and types
     """
     dp = deepcopy(ParamDictT.__annotations__)
     del dp["name"]
@@ -72,6 +76,10 @@ def create_parameterframe(
     header: bool
         add import header
 
+    Returns
+    -------
+    Python parameter frame as a string
+
     """
     param_cls = (
         "from dataclasses import dataclass\n\n"
@@ -98,6 +106,10 @@ def create_parameterframe(
 def parse_args():
     """
     Parse arguments
+
+    Returns
+    -------
+    parsed argument namespace
     """
     parser = argparse.ArgumentParser(
         description="Generate ParameterFrame files from module or package"
@@ -134,6 +146,10 @@ def parse_args():
 def get_param_classes(module) -> dict:
     """
     Get all ParameterFrame classes
+
+    Returns
+    -------
+    all found ParameterFrames
     """
     return {
         f"{m[0]}: {m[1].param_cls.__name__}": m[1].param_cls
@@ -144,7 +160,12 @@ def get_param_classes(module) -> dict:
 
 
 def find_modules(path: str) -> set:
-    """Recursively get modules from package"""
+    """Recursively get modules from package
+
+    Returns
+    -------
+    all found modules
+    """
     modules = set()
     for pkg in find_packages(path):
         if "test" in pkg:

diff --git a/bluemira/geometry/optimisation/__init__.py b/bluemira/geometry/optimisation/__init__.py
@@ -7,9 +7,19 @@
 
 from bluemira.geometry.optimisation._optimise import KeepOutZone, optimise_geometry
 from bluemira.geometry.optimisation.problem import GeomOptimisationProblem
+from bluemira.geometry.optimisation.typed import (
+    GeomClsOptimiserCallable,
+    GeomConstraintT,
+    GeomOptimiserCallable,
+    GeomOptimiserObjective,
+)
 
 __all__ = [
+    "GeomClsOptimiserCallable",
+    "GeomConstraintT",
     "GeomOptimisationProblem",
+    "GeomOptimiserCallable",
+    "GeomOptimiserObjective",
     "KeepOutZone",
     "optimise_geometry",
 ]
diff --git a/bluemira/geometry/optimisation/_optimise.py b/bluemira/geometry/optimisation/_optimise.py
@@ -18,7 +18,7 @@
 
 from bluemira.geometry.optimisation import _tools
 from bluemira.geometry.optimisation._tools import KeepOutZone
-from bluemira.geometry.optimisation.typing import (
+from bluemira.geometry.optimisation.typed import (
     GeomConstraintT,
     GeomOptimiserCallable,
     GeomOptimiserObjective,

diff --git a/bluemira/geometry/optimisation/_tools.py b/bluemira/geometry/optimisation/_tools.py
@@ -7,7 +7,7 @@
 
 import numpy as np
 
-from bluemira.geometry.optimisation.typing import (
+from bluemira.geometry.optimisation.typed import (
     GeomClsOptimiserCallable,
     GeomConstraintT,
     GeomOptimiserCallable,
@@ -16,12 +16,8 @@
 from bluemira.geometry.parameterisations import GeometryParameterisation
 from bluemira.geometry.tools import signed_distance_2D_polygon
 from bluemira.geometry.wire import BluemiraWire
+from bluemira.optimisation import ConstraintT, ObjectiveCallable, OptimiserCallable
 from bluemira.optimisation.error import GeometryOptimisationError
-from bluemira.optimisation.typing import (
-    ConstraintT,
-    ObjectiveCallable,
-    OptimiserCallable,
-)
 
 
 @dataclass

diff --git a/bluemira/geometry/optimisation/problem.py b/bluemira/geometry/optimisation/problem.py
@@ -16,7 +16,7 @@
     KeepOutZone,
     optimise_geometry,
 )
-from bluemira.geometry.optimisation.typing import GeomConstraintT
+from bluemira.geometry.optimisation.typed import GeomConstraintT
 from bluemira.geometry.parameterisations import GeometryParameterisation
 from bluemira.optimisation._algorithm import Algorithm, AlgorithmType
 from bluemira.optimisation.problem import OptimisationProblemBase

diff --git a/bluemira/geometry/optimisation/typing.py → bluemira/geometry/optimisation/typed.py b/bluemira/geometry/optimisation/typing.py → bluemira/geometry/optimisation/typed.py
diff --git a/bluemira/geometry/parameterisations.py b/bluemira/geometry/parameterisations.py
@@ -223,7 +223,8 @@ def create_shape(self, label: str = "") -> BluemiraWire:
         Returns
         -------
         CAD Wire of the geometry
-        """
+        """  # noqa: DOC202
+        ...
 
     def to_json(self, file: str):
         """

diff --git a/bluemira/magnetostatics/baseclass.py b/bluemira/magnetostatics/baseclass.py
@@ -68,7 +68,8 @@ def field(
         Returns
         -------
         The magnetic field vector {Bx, By, Bz} in [T]
-        """
+        """  # noqa: DOC202
+        ...
 
     @abstractmethod
     def plot(self, ax: Axes | None, **kwargs):