Improve linting (#20)

## 2.4.3 2025-07-07

### Changed

* Configure linter to be slightly more strict
* Format and resolve new lints

Author: jlogan-cfs

CHANGELOG_PYTHON.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 2.4.3 2025-07-07
+
+### Changed
+
+* Configure linter to be slightly more strict
+* Format and resolve new lints
+
 ## 2.4.2 2025-06-16
 
 ### Changed

CHANGELOG_RUST.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.4.3 2025-07-07
+
+### Changed
+
+* No changes to rust side; version roll for lock-step versioning with python
+
 ## 2.4.2 2025-06-16
 
 ### Changed

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "cfsem"
-version = "2.4.2"
+version = "2.4.3"
 edition = "2024"
 authors = ["Commonwealth Fusion Systems <jlogan@cfs.energy>"]
 license = "MIT"

Cargo.toml

@@ -1,30 +1,28 @@
 """Quasi-steady electromagnetics calcs"""
 
-from typing import Tuple
 import numpy as np
-from numpy.typing import NDArray
 from interpn import MulticubicRectilinear
-
-from cfsem.types import Array3xN
+from numpy.typing import NDArray
 
 from cfsem.bindings import (
+    body_force_density_circular_filament_cartesian,
+    body_force_density_linear_filament,
+    filament_helix_path,
     flux_circular_filament,
-    flux_density_linear_filament,
     flux_density_biot_savart,
     flux_density_circular_filament,
+    flux_density_circular_filament_cartesian,
+    flux_density_dipole,
+    flux_density_linear_filament,
     gs_operator_order2,
     gs_operator_order4,
     inductance_piecewise_linear_filaments,
-    filament_helix_path,
+    mutual_inductance_circular_to_linear,
     rotate_filaments_about_path,
-    vector_potential_linear_filament,
     vector_potential_circular_filament,
-    flux_density_circular_filament_cartesian,
-    mutual_inductance_circular_to_linear,
-    flux_density_dipole,
-    body_force_density_circular_filament_cartesian,
-    body_force_density_linear_filament,
+    vector_potential_linear_filament,
 )
+from cfsem.types import Array3xN
 
 from .cfsem import ellipe, ellipk
 
@@ -171,9 +169,7 @@ def mutual_inductance_piecewise_linear_filaments(
     return inductance  # [H]
 
 
-def flux_density_ideal_solenoid(
-    current: float, num_turns: float, length: float
-) -> float:
+def flux_density_ideal_solenoid(current: float, num_turns: float, length: float) -> float:
     """
     Axial B-field on centerline of an ideal (infinitely long) solenoid.
 
@@ -194,8 +190,8 @@ def flux_density_ideal_solenoid(
 def self_inductance_lyle6(r: float, dr: float, dz: float, n: float) -> float:
     """
     Self-inductance of a cylindrically-symmetric coil of rectangular
-    cross-section, estimated to 6th order. 
-    
+    cross-section, estimated to 6th order.
+
     This estimate is viable up to an L/D of about 1.5, above which it
     rapidly accumulates error and eventually produces negative values.
 
@@ -239,13 +235,7 @@ def self_inductance_lyle6(r: float, dr: float, dz: float, n: float) -> float:
     f = (
         ml
         + (1 + u + v - 8 * (w + ww)) / 12.0  # 0th order in d/a
-        + (
-            da2
-            * (
-                cd2 * (221 + 60 * ml - 6 * v)
-                + 3 * bd2 * (69 + 60 * ml + 10 * u - 64 * w)
-            )
-        )
+        + (da2 * (cd2 * (221 + 60 * ml - 6 * v) + 3 * bd2 * (69 + 60 * ml + 10 * u - 64 * w)))
         / 5760.0  # 2nd order
         + (
             da2**2
@@ -275,9 +265,7 @@ def self_inductance_lyle6(r: float, dr: float, dz: float, n: float) -> float:
     return self_inductance  # [H]
 
 
-def mutual_inductance_of_circular_filaments(
-    rzn1: NDArray, rzn2: NDArray, par: bool = True
-) -> float:
+def mutual_inductance_of_circular_filaments(rzn1: NDArray, rzn2: NDArray, par: bool = True) -> float:
     """
     Analytic mutual inductance between a pair of ideal cylindrically-symmetric coaxial filaments.
 
@@ -294,16 +282,12 @@ def mutual_inductance_of_circular_filaments(
         float: [H] mutual inductance
     """
 
-    m = mutual_inductance_of_cylindrical_coils(
-        rzn1.reshape((3, 1)), rzn2.reshape((3, 1)), par
-    )
+    m = mutual_inductance_of_cylindrical_coils(rzn1.reshape((3, 1)), rzn2.reshape((3, 1)), par)
 
     return m  # [H]
 
 
-def mutual_inductance_of_cylindrical_coils(
-    f1: NDArray, f2: NDArray, par: bool = True
-) -> float:
+def mutual_inductance_of_cylindrical_coils(f1: NDArray, f2: NDArray, par: bool = True) -> float:
     """
     Analytical mutual inductance between two coaxial collections of ideal filaments.
 
@@ -324,16 +308,12 @@ def mutual_inductance_of_cylindrical_coils(
 
     # Using n2 as the current per filament is equivalent to examining a 1A reference current,
     # which gives us the flux per amp (inductance)
-    m = np.sum(
-        n1 * flux_circular_filament(n2, r2, z2, r1, z1, par)
-    )  # [H] total mutual inductance
+    m = np.sum(n1 * flux_circular_filament(n2, r2, z2, r1, z1, par))  # [H] total mutual inductance
 
     return m  # [H]
 
 
-def filament_coil(
-    r: float, z: float, w: float, h: float, nt: float, nr: int, nz: int
-) -> NDArray:
+def filament_coil(r: float, z: float, w: float, h: float, nt: float, nr: int, nz: int) -> NDArray:
     """
     Create an array of filaments from coil cross-section, evenly spaced
     _inside_ the winding pack. No filaments are coincident with the coil surface.
@@ -365,9 +345,7 @@ def filament_coil(
     return filaments  # [m], [m], [dimensionless]
 
 
-def self_inductance_circular_ring_wien(
-    major_radius: NDArray, minor_radius: NDArray
-) -> NDArray:
+def self_inductance_circular_ring_wien(major_radius: NDArray, minor_radius: NDArray) -> NDArray:
     """
     Wien's formula for the self-inductance of a circular ring
     with thin circular cross section.
@@ -391,21 +369,19 @@ def self_inductance_circular_ring_wien(
     ra2 = (minor_radius / major_radius) ** 2  # [], (rho / a)^2, dimensionless
     # Equation 7 in Rosa & Cohen lacks the factor of 1e-7
     # because it is not in SI base units.
-    self_inductance = (
-        MU_0 * major_radius * ((1 + 0.125 * ra2) * np.log(8 * ar) - 0.0083 * ra2 - 1.75)
-    )  # [H]
+    self_inductance = MU_0 * major_radius * ((1 + 0.125 * ra2) * np.log(8 * ar) - 0.0083 * ra2 - 1.75)  # [H]
     return self_inductance  # [H]
 
 
 def self_inductance_distributed_axisymmetric_conductor(
     current: float,
-    grid: Tuple[NDArray, NDArray],
-    mesh: Tuple[NDArray, NDArray],
-    b_part: Tuple[NDArray, NDArray],
+    grid: tuple[NDArray, NDArray],
+    mesh: tuple[NDArray, NDArray],
+    b_part: tuple[NDArray, NDArray],
     psi_part: NDArray,
     mask: NDArray,
-    edge_path: Tuple[NDArray, NDArray],
-) -> Tuple[float, float, float]:
+    edge_path: tuple[NDArray, NDArray],
+) -> tuple[float, float, float]:
     """
     Calculation of a distributed conductor's self-inductance from two components:
 
@@ -546,7 +522,8 @@ def self_inductance_annular_ring(r: float, a: float, b: float) -> float:
     and `(b/r)^2`.
 
     References:
-        [1] E. B. Rosa and F. W. Grover, “Formulas and tables for the calculation of mutual and self-inductance (Revised),”
+        [1] E. B. Rosa and F. W. Grover,
+            “Formulas and tables for the calculation of mutual and self-inductance (Revised),”
             BULL. NATL. BUR. STAND., vol. 8, no. 1, p. 1, Jan. 1912,
             doi: [10.6028/bulletin.185](https://doi.org/10.6028/bulletin.185)
 

cfsem/__init__.py

@@ -5,42 +5,40 @@
 passed as contiguous and reallocating into contiguous inputs if necessary.
 """
 
-from cfsem.types import Array3xN
-
 from numpy import ascontiguousarray, float64, zeros_like
 from numpy.typing import NDArray
 
-from .cfsem import flux_circular_filament as em_flux_circular_filament
-from .cfsem import flux_density_linear_filament as em_flux_density_linear_filament
-from .cfsem import flux_density_circular_filament as em_flux_density_circular_filament
+from cfsem.types import Array3xN
+
 from .cfsem import (
-    flux_density_circular_filament_cartesian as em_flux_density_circular_filament_cartesian,
+    body_force_density_circular_filament_cartesian as em_body_force_density_circular_filament_cartesian,
 )
 from .cfsem import (
-    mutual_inductance_circular_to_linear as em_mutual_inductance_circular_to_linear,
+    body_force_density_linear_filament as em_body_force_density_linear_filament,
 )
+from .cfsem import filament_helix_path as em_filament_helix_path
+from .cfsem import flux_circular_filament as em_flux_circular_filament
+from .cfsem import flux_density_circular_filament as em_flux_density_circular_filament
 from .cfsem import (
-    body_force_density_circular_filament_cartesian as em_body_force_density_circular_filament_cartesian,
+    flux_density_circular_filament_cartesian as em_flux_density_circular_filament_cartesian,
 )
-
+from .cfsem import flux_density_dipole as em_flux_density_dipole
+from .cfsem import flux_density_linear_filament as em_flux_density_linear_filament
 from .cfsem import gs_operator_order2 as em_gs_operator_order2
 from .cfsem import gs_operator_order4 as em_gs_operator_order4
 from .cfsem import (
     inductance_piecewise_linear_filaments as em_inductance_piecewise_linear_filaments,
 )
-from .cfsem import filament_helix_path as em_filament_helix_path
+from .cfsem import (
+    mutual_inductance_circular_to_linear as em_mutual_inductance_circular_to_linear,
+)
 from .cfsem import rotate_filaments_about_path as em_rotate_filaments_about_path
 from .cfsem import (
     vector_potential_circular_filament as em_vector_potential_circular_filament,
 )
 from .cfsem import (
     vector_potential_linear_filament as em_vector_potential_linear_filament,
 )
-from .cfsem import (
-    body_force_density_linear_filament as em_body_force_density_linear_filament,
-)
-
-from .cfsem import flux_density_dipole as em_flux_density_dipole
 
 
 def flux_circular_filament(
@@ -290,9 +288,7 @@ def inductance_piecewise_linear_filaments(
     xyzfil1 = _3tup_contig(xyzfil1)
     dlxyzfil1 = _3tup_contig(dlxyzfil1)
 
-    return em_inductance_piecewise_linear_filaments(
-        xyzfil0, dlxyzfil0, xyzfil1, dlxyzfil1, self_inductance
-    )
+    return em_inductance_piecewise_linear_filaments(xyzfil0, dlxyzfil0, xyzfil1, dlxyzfil1, self_inductance)
 
 
 def gs_operator_order2(rs: NDArray[float64], zs: NDArray[float64]) -> Array3xN:
@@ -381,9 +377,7 @@ def filament_helix_path(
     return helix  # [m]
 
 
-def rotate_filaments_about_path(
-    path: Array3xN, angle_offset: float, fils: Array3xN
-) -> Array3xN:
+def rotate_filaments_about_path(path: Array3xN, angle_offset: float, fils: Array3xN) -> Array3xN:
     """
     Rotate a path of point about another path.
 
@@ -436,9 +430,7 @@ def flux_density_circular_filament_cartesian(
     """
     ifil, rfil, zfil = _3tup_contig((ifil, rfil, zfil))
     xyzp = _3tup_contig(xyzp)
-    bx, by, bz = em_flux_density_circular_filament_cartesian(
-        ifil, rfil, zfil, xyzp, par
-    )  # [T]
+    bx, by, bz = em_flux_density_circular_filament_cartesian(ifil, rfil, zfil, xyzp, par)  # [T]
 
     return bx, by, bz  # type: ignore
 
@@ -562,17 +554,16 @@ def body_force_density_linear_filament(
     ifil = ascontiguousarray(ifil).flatten()
     obs = _3tup_contig(obs)
     j = _3tup_contig(j)
-    jxbx, jxby, jxbz = em_body_force_density_linear_filament(
-        xyzfil, dlxyzfil, ifil, obs, j, par
-    )  # [N/m^3]
+    jxbx, jxby, jxbz = em_body_force_density_linear_filament(xyzfil, dlxyzfil, ifil, obs, j, par)  # [N/m^3]
 
     return jxbx, jxby, jxbz  # type: ignore
 
 
 def _3tup_contig(
     t: Array3xN,
 ) -> tuple[NDArray[float64], NDArray[float64], NDArray[float64]]:
-    """Make contiguous references or copies to arrays in a 3-tuple. Only copies data if it is not already contiguous."""
+    """Make contiguous references or copies to arrays in a 3-tuple.
+    Only copies data if it is not already contiguous."""
     return (
         ascontiguousarray(t[0]).flatten(),
         ascontiguousarray(t[1]).flatten(),
@@ -583,5 +574,6 @@ def _3tup_contig(
 def _2tup_contig(
     t: tuple[NDArray[float64], NDArray[float64]],
 ) -> tuple[NDArray[float64], NDArray[float64]]:
-    """Make contiguous references or copies to arrays in a 2-tuple. Only copies data if it is not already contiguous."""
+    """Make contiguous references or copies to arrays in a 2-tuple.
+    Only copies data if it is not already contiguous."""
     return (ascontiguousarray(t[0]).flatten(), ascontiguousarray(t[1]).flatten())

cfsem/bindings.py

@@ -1,7 +1,7 @@
-from typing import Tuple, Union
-from numpy.typing import NDArray
+from typing import Union
+
 from numpy import float64
+from numpy.typing import NDArray
 
-Array3xN = Union[
-    NDArray[float64], Tuple[NDArray[float64], NDArray[float64], NDArray[float64]]
-]
+Array3xN = Union[NDArray[float64], tuple[NDArray[float64], NDArray[float64], NDArray[float64]]]
+"""A 3xN array expressed as either a 2D numpy array or a tuple of 1D numpy arrays"""

cfsem/types.py

@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "cfsem"
-version = "2.4.2"
+version = "2.4.3"
 description = "Quasi-steady electromagnetics including filamentized approximations, Biot-Savart, and Grad-Shafranov."
 authors = [{name = "Commonwealth Fusion Systems", email = "jlogan@cfs.energy"}]
 requires-python = ">=3.9, <3.14"
@@ -40,7 +40,24 @@ features = ["pyo3/extension-module", "python"]
 module-name = "cfsem.cfsem"
 
 [tool.ruff]
-target-version = "py311"
+target-version = "py39"
+line-length = 110
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+]
 
 [tool.coverage.report]
 fail_under = 100