Fixed mypy sp check guidelines

CHANGELOG.md

@@ -21,6 +21,7 @@
 - Moved concentration inside x-averaged when calculating LLI due to LAM variables ([#4858](https://github.com/pybamm-team/PyBaMM/pull/4858))
 - Fixed a bug that caused the variable `"Loss of lithium due to {domain} lithium plating"`to have the domain `"current collector"` (should not have any domain at all) if the `"x-average side reactions"` option was set to `"true"`. ([#4844](https://github.com/pybamm-team/PyBaMM/pull/4844))
 - Fixed interpolation bug in `pybamm.QuickPlot` with spatial variables. ([#4841](https://github.com/pybamm-team/PyBaMM/pull/4841))
+- Fixed mypy sp check guidelines ([#4887](https://github.com/pybamm-team/PyBaMM/pull/4887))
 
 ## Optimizations
 

examples/scripts/SPM_compare_particle_grid.py

@@ -2,6 +2,7 @@
 # Compare different discretisations in the particle
 #
 import argparse
+from typing import Any
 import numpy as np
 import pybamm
 import matplotlib.pyplot as plt
@@ -48,7 +49,7 @@
     disc.process_model(model)
 
 # solve model
-solutions = [None] * len(models)
+solutions: Any = [None] * len(models)
 t_eval = np.linspace(0, 3600, 100)
 for i, model in enumerate(models):
     solutions[i] = model.default_solver.solve(model, t_eval)

examples/scripts/SPMe_step.py

@@ -43,13 +43,14 @@
     time += dt
 
 # plot
-time_in_seconds = solution["Time [s]"].entries
-step_time_in_seconds = step_solution["Time [s]"].entries
-voltage = solution["Voltage [V]"].entries
-step_voltage = step_solution["Voltage [V]"].entries
-plt.plot(time_in_seconds, voltage, "b-", label="SPMe (continuous solve)")
-plt.plot(step_time_in_seconds, step_voltage, "ro", label="SPMe (stepped solve)")
-plt.xlabel(r"$t$")
-plt.ylabel("Voltage [V]")
-plt.legend()
-plt.show()
+if step_solution is not None:
+    time_in_seconds = solution["Time [s]"].entries
+    step_time_in_seconds = step_solution["Time [s]"].entries
+    voltage = solution["Voltage [V]"].entries
+    step_voltage = step_solution["Voltage [V]"].entries
+    plt.plot(time_in_seconds, voltage, "b-", label="SPMe (continuous solve)")
+    plt.plot(step_time_in_seconds, step_voltage, "ro", label="SPMe (stepped solve)")
+    plt.xlabel(r"$t$")
+    plt.ylabel("Voltage [V]")
+    plt.legend()
+    plt.show()

examples/scripts/heat_equation.py

@@ -106,7 +106,7 @@ def T_exact(x, t):
 # Plot ------------------------------------------------------------------------
 x_nodes = mesh["rod"].nodes  # numerical gridpoints
 xx = np.linspace(0, 2, 101)  # fine mesh to plot exact solution
-plot_times = np.linspace(0, 1, 5)
+plot_times: np.ndarray = np.linspace(0, 1, 5)
 
 plt.figure(figsize=(15, 8))
 cmap = plt.get_cmap("inferno")

examples/scripts/minimal_example_of_lookup_tables.py

@@ -34,12 +34,12 @@ def process_2D(name, data):
 D_s_n_data = process_2D("Negative particle diffusivity [m2.s-1]", df)
 
 
-def D_s_n(sto, T):
+def D_s_n_func(sto, T):
     name, (x, y) = D_s_n_data
     return pybamm.Interpolant(x, y, [T, sto], name)
 
 
-parameter_values["Negative particle diffusivity [m2.s-1]"] = D_s_n
+parameter_values["Negative particle diffusivity [m2.s-1]"] = D_s_n_func
 
 k_n = parameter_values["Negative electrode exchange-current density [A.m-2]"]
 

pyproject.toml

@@ -252,6 +252,10 @@ concurrency = ["multiprocessing"]
 ignore_missing_imports = true
 allow_redefinition = true
 disable_error_code = ["call-overload", "operator"]
+strict = false
+warn_unreachable = true
+enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
+exclude = "^(build/|docs/conf\\.py)$"
 
 [[tool.mypy.overrides]]
 module = [

src/pybamm/experiment/experiment.py

@@ -40,7 +40,9 @@ class Experiment:
 
     def __init__(
         self,
-        operating_conditions: list[str | tuple[str] | BaseStep],
+        operating_conditions: list[
+            str | tuple[str, ...] | tuple[str | BaseStep] | BaseStep
+        ],
         period: str | None = None,
         temperature: float | None = None,
         termination: list[str] | None = None,

src/pybamm/experiment/step/base_step.py

@@ -140,7 +140,7 @@ def __init__(
             self.value = pybamm.Interpolant(
                 t,
                 y,
-                pybamm.t - pybamm.InputParameter("start time"),
+                pybamm.t - pybamm.InputParameter("start time"),  # type: ignore[arg-type]
                 name="Drive Cycle",
             )
             self.period = np.diff(t).min()

src/pybamm/expression_tree/binary_operators.py

@@ -2,7 +2,6 @@
 # Binary operator classes
 #
 from __future__ import annotations
-import numbers
 
 import numpy as np
 import sympy
@@ -33,8 +32,8 @@ def _preprocess_binary(
             raise ValueError("right must be a 1D array")
         right = pybamm.Vector(right)
 
-    # Check both left and right are pybamm Symbols
-    if not (isinstance(left, pybamm.Symbol) and isinstance(right, pybamm.Symbol)):
+    # Check right is pybamm Symbol
+    if not isinstance(right, pybamm.Symbol):
         raise NotImplementedError(
             f"BinaryOperator not implemented for symbols of type {type(left)} and {type(right)}"
         )
@@ -113,6 +112,9 @@ def __str__(self):
             right_str = f"{self.right!s}"
         return f"{left_str} {self.name} {right_str}"
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return self.__class__(self.name, left, right)  # pragma: no cover
+
     def create_copy(
         self,
         new_children: list[pybamm.Symbol] | None = None,
@@ -127,7 +129,7 @@ def create_copy(
         children = self._children_for_copying(new_children)
 
         if not perform_simplifications:
-            out = self.__class__(children[0], children[1])
+            out = self._new_instance(children[0], children[1])
         else:
             # creates a new instance using the overloaded binary operator to perform
             # additional simplifications, rather than just calling the constructor
@@ -224,6 +226,9 @@ def __init__(
         """See :meth:`pybamm.BinaryOperator.__init__()`."""
         super().__init__("**", left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return Power(left, right)
+
     def _diff(self, variable: pybamm.Symbol):
         """See :meth:`pybamm.Symbol._diff()`."""
         # apply chain rule and power rule
@@ -273,6 +278,9 @@ def __init__(
         """See :meth:`pybamm.BinaryOperator.__init__()`."""
         super().__init__("+", left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return Addition(left, right)
+
     def _diff(self, variable: pybamm.Symbol):
         """See :meth:`pybamm.Symbol._diff()`."""
         return self.left.diff(variable) + self.right.diff(variable)
@@ -300,6 +308,9 @@ def __init__(
 
         super().__init__("-", left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return Subtraction(left, right)
+
     def _diff(self, variable: pybamm.Symbol):
         """See :meth:`pybamm.Symbol._diff()`."""
         return self.left.diff(variable) - self.right.diff(variable)
@@ -329,6 +340,9 @@ def __init__(
 
         super().__init__("*", left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return Multiplication(left, right)
+
     def _diff(self, variable: pybamm.Symbol):
         """See :meth:`pybamm.Symbol._diff()`."""
         # apply product rule
@@ -369,6 +383,9 @@ def __init__(
         """See :meth:`pybamm.BinaryOperator.__init__()`."""
         super().__init__("@", left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return MatrixMultiplication(left, right)  # pragma: no cover
+
     def diff(self, variable):
         """See :meth:`pybamm.Symbol.diff()`."""
         # We shouldn't need this
@@ -418,6 +435,9 @@ def __init__(
         """See :meth:`pybamm.BinaryOperator.__init__()`."""
         super().__init__("/", left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return Division(left, right)
+
     def _diff(self, variable: pybamm.Symbol):
         """See :meth:`pybamm.Symbol._diff()`."""
         # apply quotient rule
@@ -466,6 +486,9 @@ def __init__(
         """See :meth:`pybamm.BinaryOperator.__init__()`."""
         super().__init__("inner product", left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return Inner(left, right)  # pragma: no cover
+
     def _diff(self, variable: pybamm.Symbol):
         """See :meth:`pybamm.Symbol._diff()`."""
         # apply product rule
@@ -543,6 +566,9 @@ def __init__(
         """See :meth:`pybamm.BinaryOperator.__init__()`."""
         super().__init__("==", left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return Equality(left, right)
+
     def diff(self, variable):
         """See :meth:`pybamm.Symbol.diff()`."""
         # Equality should always be multiplied by something else so hopefully don't
@@ -601,6 +627,9 @@ def __init__(
         """See :meth:`pybamm.BinaryOperator.__init__()`."""
         super().__init__(name, left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return _Heaviside(left, right)  # pragma: no cover
+
     def diff(self, variable):
         """See :meth:`pybamm.Symbol.diff()`."""
         # Heaviside should always be multiplied by something else so hopefully don't
@@ -678,6 +707,9 @@ def __init__(
     ):
         super().__init__("%", left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return Modulo(left, right)
+
     def _diff(self, variable: pybamm.Symbol):
         """See :meth:`pybamm.Symbol._diff()`."""
         # apply chain rule and power rule
@@ -720,6 +752,9 @@ def __init__(
     ):
         super().__init__("minimum", left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return Minimum(left, right)
+
     def __str__(self):
         """See :meth:`pybamm.Symbol.__str__()`."""
         return f"minimum({self.left!s}, {self.right!s})"
@@ -764,6 +799,9 @@ def __init__(
     ):
         super().__init__("maximum", left, right)
 
+    def _new_instance(self, left: pybamm.Symbol, right: pybamm.Symbol) -> pybamm.Symbol:
+        return Maximum(left, right)
+
     def __str__(self):
         """See :meth:`pybamm.Symbol.__str__()`."""
         return f"maximum({self.left!s}, {self.right!s})"
@@ -1538,7 +1576,7 @@ def source(
         corresponding to a source term in the bulk.
     """
     # Broadcast if left is number
-    if isinstance(left, numbers.Number):
+    if isinstance(left, (int, float)):
         left = pybamm.PrimaryBroadcast(left, "current collector")
 
     # force type cast for mypy

src/pybamm/expression_tree/broadcasts.py

@@ -78,8 +78,7 @@ def _from_json(cls, snippet):
         )
 
     def _unary_new_copy(self, child: pybamm.Symbol, perform_simplifications=True):
-        """See :meth:`pybamm.UnaryOperator._unary_new_copy()`."""
-        return self.__class__(child, self.broadcast_domain)
+        pass  # pragma: no cover
 
 
 class PrimaryBroadcast(Broadcast):
@@ -191,6 +190,10 @@ def reduce_one_dimension(self):
         """Reduce the broadcast by one dimension."""
         return self.orphans[0]
 
+    def _unary_new_copy(self, child: pybamm.Symbol, perform_simplifications=True):
+        """See :meth:`pybamm.UnaryOperator._unary_new_copy()`."""
+        return self.__class__(child, self.broadcast_domain)
+
 
 class PrimaryBroadcastToEdges(PrimaryBroadcast):
     """A primary broadcast onto the edges of the domain."""
@@ -321,6 +324,10 @@ def reduce_one_dimension(self):
         """Reduce the broadcast by one dimension."""
         return self.orphans[0]
 
+    def _unary_new_copy(self, child: pybamm.Symbol, perform_simplifications=True):
+        """See :meth:`pybamm.UnaryOperator._unary_new_copy()`."""
+        return self.__class__(child, self.broadcast_domain)
+
 
 class SecondaryBroadcastToEdges(SecondaryBroadcast):
     """A secondary broadcast onto the edges of a domain."""
@@ -438,6 +445,10 @@ def reduce_one_dimension(self):
         """Reduce the broadcast by one dimension."""
         raise NotImplementedError
 
+    def _unary_new_copy(self, child: pybamm.Symbol, perform_simplifications=True):
+        """See :meth:`pybamm.UnaryOperator._unary_new_copy()`."""
+        return self.__class__(child, self.broadcast_domain)
+
 
 class TertiaryBroadcastToEdges(TertiaryBroadcast):
     """A tertiary broadcast onto the edges of a domain."""
@@ -463,7 +474,7 @@ def __init__(
         self,
         child_input: Numeric | pybamm.Symbol,
         broadcast_domain: DomainType = None,
-        auxiliary_domains: AuxiliaryDomainType = None,
+        auxiliary_domains: AuxiliaryDomainType | str = None,
         broadcast_domains: DomainsType = None,
         name: str | None = None,
     ):

src/pybamm/expression_tree/concatenations.py

@@ -473,7 +473,7 @@ def __init__(self, *children, name: Optional[str] = None):
         if name is None:
             # Name is the intersection of the children names (should usually make sense
             # if the children have been named consistently)
-            name = intersect(children[0].name, children[1].name)
+            name = intersect(children[0].name, children[1].name) or ""
             for child in children[2:]:
                 name = intersect(name, child.name)
             if len(name) == 0:
@@ -514,7 +514,7 @@ def substrings(s: str):
             yield s[i : j + 1]
 
 
-def intersect(s1: str, s2: str):
+def intersect(s1: str, s2: str) -> str:
     # find all the common strings between two strings
     all_intersects = set(substrings(s1)) & set(substrings(s2))
     # intersect is the longest such intercept
@@ -525,7 +525,7 @@ def intersect(s1: str, s2: str):
     return intersect.lstrip().rstrip()
 
 
-def simplified_concatenation(*children, name: Optional[str] = None):
+def simplified_concatenation(*children, name=None):
     """Perform simplifications on a concatenation."""
     # remove children that are None
     children = list(filter(lambda x: x is not None, children))

src/pybamm/expression_tree/functions.py

@@ -6,7 +6,7 @@
 import numpy as np
 from scipy import special
 import sympy
-from typing import Callable
+from typing import Callable, cast
 from collections.abc import Sequence
 from typing_extensions import TypeVar
 
@@ -32,7 +32,7 @@ class Function(pybamm.Symbol):
     def __init__(
         self,
         function: Callable,
-        *children: pybamm.Symbol,
+        *children: pybamm.Symbol | float | int,
         name: str | None = None,
         differentiated_function: Callable | None = None,
     ):
@@ -42,6 +42,7 @@ def __init__(
             if isinstance(child, (float, int, np.number)):
                 children[idx] = pybamm.Scalar(child)
 
+        children = cast(Sequence[pybamm.Symbol], children)
         if name is not None:
             self.name = name
         else: