chore: cleanup mypy config

.git-blame-ignore-revs

@@ -10,3 +10,5 @@ a63e49ece0f9336d1f5c2562f7459e555c6e6693
 ff6d81c01331c7d269303b4a8321d9881bdf98fa
 # migrated to ruff-format - https://github.com/pybamm-team/PyBaMM/pull/3655
 60ebd4148059a95428a496f4f55c1175ead362d3
+# activated isort - https://github.com/pybamm-team/PyBaMM/pull/3853
+36e6c5a5a36976591275ed4de700dc1b27567ba1

.pre-commit-config.yaml

@@ -37,3 +37,12 @@ repos:
         - id: rst-backticks
         - id: rst-directive-colons
         - id: rst-inline-touching-normal
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+        files: pybamm
+        additional_dependencies:
+          - numpy
+          - packaging

benchmarks/benchmark_utils.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import numpy as np
 
 

benchmarks/different_model_options.py

@@ -1,6 +1,9 @@
+from __future__ import annotations
+
+import numpy as np
+
 import pybamm
 from benchmarks.benchmark_utils import set_random_seed
-import numpy as np
 
 
 def compute_discretisation(model, param):

benchmarks/memory_sims.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pybamm
 from benchmarks.benchmark_utils import set_random_seed
 

benchmarks/memory_unit_benchmarks.py

@@ -1,6 +1,9 @@
+from __future__ import annotations
+
+import numpy as np
+
 import pybamm
 from benchmarks.benchmark_utils import set_random_seed
-import numpy as np
 
 
 class MemCreateExpression:

benchmarks/time_setup_models_and_sims.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pybamm
 from benchmarks.benchmark_utils import set_random_seed
 

benchmarks/time_sims_experiments.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import pybamm
 from benchmarks.benchmark_utils import set_random_seed
 

benchmarks/time_solve_models.py

@@ -1,9 +1,11 @@
 # Write the benchmarking functions here.
 # See "Writing benchmarks" in the asv docs for more information.
+from __future__ import annotations
+
+import numpy as np
 
 import pybamm
 from benchmarks.benchmark_utils import set_random_seed
-import numpy as np
 
 
 def solve_model_once(model, solver, t_eval):

benchmarks/unit_benchmarks.py

@@ -1,5 +1,8 @@
-import pybamm
+from __future__ import annotations
+
 import numpy as np
+
+import pybamm
 from benchmarks.benchmark_utils import set_random_seed
 
 

benchmarks/work_precision_sets/time_vs_abstols.py

@@ -1,8 +1,11 @@
-import pybamm
-import numpy as np
-import matplotlib.pyplot as plt
+from __future__ import annotations
+
 import itertools
 
+import matplotlib.pyplot as plt
+import numpy as np
+
+import pybamm
 
 parameters = ["Marquis2019", "Ecker2015", "Ramadass2004", "Chen2020"]
 

benchmarks/work_precision_sets/time_vs_dt_max.py

@@ -1,7 +1,9 @@
-import pybamm
-import numpy as np
+from __future__ import annotations
+
 import matplotlib.pyplot as plt
+import numpy as np
 
+import pybamm
 
 parameters = [
     "Marquis2019",

benchmarks/work_precision_sets/time_vs_mesh_size.py

@@ -1,8 +1,10 @@
-import pybamm
+from __future__ import annotations
 
-import matplotlib.pyplot as plt
 import itertools
 
+import matplotlib.pyplot as plt
+
+import pybamm
 
 parameters = [
     "Marquis2019",

benchmarks/work_precision_sets/time_vs_no_of_states.py

@@ -1,7 +1,10 @@
-import pybamm
-import matplotlib.pyplot as plt
+from __future__ import annotations
+
 import itertools
 
+import matplotlib.pyplot as plt
+
+import pybamm
 
 parameters = [
     "Marquis2019",

benchmarks/work_precision_sets/time_vs_reltols.py

@@ -1,8 +1,11 @@
-import pybamm
-import numpy as np
-import matplotlib.pyplot as plt
+from __future__ import annotations
+
 import itertools
 
+import matplotlib.pyplot as plt
+import numpy as np
+
+import pybamm
 
 parameters = [
     "Marquis2019",

docs/conf.py

@@ -11,8 +11,11 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
+from __future__ import annotations
+
 import os
 import sys
+
 import pybamm
 
 # Path for repository root

docs/source/examples/notebooks/batch_study.ipynb

@@ -31,6 +31,8 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
     "import pybamm\n",
     "\n",

docs/source/examples/notebooks/change-settings.ipynb

@@ -43,11 +43,15 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
-    "import pybamm\n",
-    "import numpy as np\n",
     "import os\n",
+    "\n",
     "import matplotlib.pyplot as plt\n",
+    "import numpy as np\n",
+    "\n",
+    "import pybamm\n",
     "\n",
     "os.chdir(pybamm.__path__[0] + \"/..\")\n",
     "\n",

docs/source/examples/notebooks/creating_models/1-an-ode-model.ipynb

@@ -36,10 +36,13 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
-    "import pybamm\n",
+    "import matplotlib.pyplot as plt\n",
     "import numpy as np\n",
-    "import matplotlib.pyplot as plt"
+    "\n",
+    "import pybamm"
    ]
   },
   {

docs/source/examples/notebooks/creating_models/2-a-pde-model.ipynb

@@ -41,10 +41,13 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
-    "import pybamm\n",
+    "import matplotlib.pyplot as plt\n",
     "import numpy as np\n",
-    "import matplotlib.pyplot as plt"
+    "\n",
+    "import pybamm"
    ]
   },
   {

docs/source/examples/notebooks/creating_models/3-negative-particle-problem.ipynb

@@ -58,10 +58,13 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
-    "import pybamm\n",
-    "import numpy as np\n",
     "import matplotlib.pyplot as plt\n",
+    "import numpy as np\n",
+    "\n",
+    "import pybamm\n",
     "\n",
     "model = pybamm.BaseModel()"
    ]

docs/source/examples/notebooks/creating_models/4-comparing-full-and-reduced-order-models.ipynb

@@ -62,10 +62,13 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
-    "import pybamm\n",
-    "import numpy as np\n",
     "import matplotlib.pyplot as plt\n",
+    "import numpy as np\n",
+    "\n",
+    "import pybamm\n",
     "\n",
     "full_model = pybamm.BaseModel(name=\"full model\")\n",
     "reduced_model = pybamm.BaseModel(name=\"reduced model\")"

docs/source/examples/notebooks/creating_models/5-half-cell-model.ipynb

@@ -71,10 +71,13 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
-    "import pybamm\n",
     "import numpy as np\n",
     "\n",
+    "import pybamm\n",
+    "\n",
     "model = pybamm.BaseModel()"
    ]
   },

docs/source/examples/notebooks/creating_models/6-a-simple-SEI-model.ipynb

@@ -123,11 +123,15 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
-    "import pybamm\n",
-    "import numpy as np\n",
     "import os\n",
     "\n",
+    "import numpy as np\n",
+    "\n",
+    "import pybamm\n",
+    "\n",
     "os.chdir(pybamm.__path__[0] + \"/..\")"
    ]
   },

docs/source/examples/notebooks/expression_tree/broadcasts.ipynb

@@ -24,9 +24,12 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
-    "import pybamm\n",
-    "import numpy as np"
+    "import numpy as np\n",
+    "\n",
+    "import pybamm"
    ]
   },
   {

docs/source/examples/notebooks/expression_tree/expression-tree.ipynb

@@ -35,10 +35,13 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
-    "import pybamm\n",
     "import numpy as np\n",
     "\n",
+    "import pybamm\n",
+    "\n",
     "y = pybamm.StateVector(slice(0, 1))\n",
     "t = pybamm.t\n",
     "equation = 2 * y * (1 - y) + t\n",

docs/source/examples/notebooks/getting_started/tutorial-1-how-to-run-a-model.ipynb

@@ -34,6 +34,8 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
     "import pybamm"
    ]

docs/source/examples/notebooks/getting_started/tutorial-10-creating-a-model.ipynb

@@ -40,6 +40,8 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
     "import pybamm"
    ]

docs/source/examples/notebooks/getting_started/tutorial-11-creating-a-submodel.ipynb

@@ -32,6 +32,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
     "import pybamm"
    ]

docs/source/examples/notebooks/getting_started/tutorial-2-compare-models.ipynb

@@ -32,6 +32,8 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
     "import pybamm"
    ]

docs/source/examples/notebooks/getting_started/tutorial-3-basic-plotting.ipynb

@@ -40,10 +40,13 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
-    "import pybamm\n",
     "import matplotlib.pyplot as plt\n",
     "\n",
+    "import pybamm\n",
+    "\n",
     "model_dfn = pybamm.lithium_ion.DFN()\n",
     "sim_dfn = pybamm.Simulation(model_dfn)\n",
     "sim_dfn.solve([0, 3600])"

docs/source/examples/notebooks/getting_started/tutorial-4-setting-parameter-values.ipynb

@@ -32,10 +32,13 @@
     }
    ],
    "source": [
+    "from __future__ import annotations\n",
+    "\n",
     "%pip install \"pybamm[plot,cite]\" -q    # install PyBaMM if it is not installed\n",
-    "import pybamm\n",
     "import os\n",
     "\n",
+    "import pybamm\n",
+    "\n",
     "os.chdir(pybamm.__path__[0] + \"/..\")"
    ]
   },