Migrating unittest to pytest 6 (#4354)

* Migrating unittest to pytest 6

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

* Removing errors

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

* Removing regex errors

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

* Replace square bracket with a curly one

Co-authored-by: Arjun Verma <[email protected]>

* Fixing errors

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

* Removing failure

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

* Delete test_spm_2024_09_13-PM03_52.json

---------

Signed-off-by: Pradyot Ranjan <[email protected]>
Co-authored-by: Pradyot Ranjan <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Agriya Khetarpal <[email protected]>
Co-authored-by: Arjun Verma <[email protected]>
Co-authored-by: Saransh Chopra <[email protected]>

src/pybamm/models/full_battery_models/base_battery_model.py

@@ -749,7 +749,7 @@ def print_options(self):
         Print the possible options with the ones currently selected
         """
         for key, value in self.items():
-            print(f"{key!r}: {value!r} (possible: {self.possible_options[key]!r})")
+            print(rf"{key!r}: {value!r} (possible: {self.possible_options[key]!r})")
 
     def print_detailed_options(self):
         """

tests/unit/test_expression_tree/test_symbolic_diff.py

@@ -2,28 +2,28 @@
 # Tests for the symbolic differentiation methods
 #
 
+import pytest
 import numpy as np
 import pybamm
-import unittest
 from numpy import testing
 
 
-class TestSymbolicDifferentiation(unittest.TestCase):
+class TestSymbolicDifferentiation:
     def test_advanced(self):
         a = pybamm.StateVector(slice(0, 1))
         b = pybamm.StateVector(slice(1, 2))
         y = np.array([5, 3])
 
         #
         func = (a * 2 + 5 * (-b)) / (a * b)
-        self.assertEqual(func.diff(a).evaluate(y=y), 1 / 5)
-        self.assertEqual(func.diff(b).evaluate(y=y), -2 / 9)
+        assert func.diff(a).evaluate(y=y) == 1 / 5
+        assert func.diff(b).evaluate(y=y) == -2 / 9
         #
         func = a * b**a
         testing.assert_array_almost_equal(
             func.diff(a).evaluate(y=y)[0], 3**5 * (5 * np.log(3) + 1)
         )
-        self.assertEqual(func.diff(b).evaluate(y=y), 5**2 * 3**4)
+        assert func.diff(b).evaluate(y=y) == 5**2 * 3**4
 
     def test_advanced_functions(self):
         a = pybamm.StateVector(slice(0, 1))
@@ -32,84 +32,68 @@ def test_advanced_functions(self):
 
         #
         func = a * pybamm.exp(b)
-        self.assertAlmostEqual(func.diff(a).evaluate(y=y)[0], np.exp(3))
+        assert func.diff(a).evaluate(y=y)[0] == pytest.approx(np.exp(3))
         func = pybamm.exp(a + 2 * b + a * b) + a * pybamm.exp(b)
-        self.assertEqual(
-            func.diff(a).evaluate(y=y), (4 * np.exp(3 * 5 + 5 + 2 * 3) + np.exp(3))
-        )
-        self.assertEqual(
-            func.diff(b).evaluate(y=y), np.exp(3) * (7 * np.exp(3 * 5 + 5 + 3) + 5)
-        )
+        assert func.diff(a).evaluate(y=y) == (4 * np.exp(3 * 5 + 5 + 2 * 3) + np.exp(3))
+        assert func.diff(b).evaluate(y=y) == np.exp(3) * (7 * np.exp(3 * 5 + 5 + 3) + 5)
         #
         func = pybamm.sin(pybamm.cos(a * 4) / 2) * pybamm.cos(4 * pybamm.exp(b / 3))
-        self.assertEqual(
-            func.diff(a).evaluate(y=y),
-            -2 * np.sin(20) * np.cos(np.cos(20) / 2) * np.cos(4 * np.exp(1)),
-        )
-        self.assertEqual(
-            func.diff(b).evaluate(y=y),
-            -4 / 3 * np.exp(1) * np.sin(4 * np.exp(1)) * np.sin(np.cos(20) / 2),
-        )
+        assert func.diff(a).evaluate(y=y) == -2 * np.sin(20) * np.cos(
+            np.cos(20) / 2
+        ) * np.cos(4 * np.exp(1))
+        assert func.diff(b).evaluate(y=y) == -4 / 3 * np.exp(1) * np.sin(
+            4 * np.exp(1)
+        ) * np.sin(np.cos(20) / 2)
         #
         func = pybamm.sin(a * b)
-        self.assertEqual(func.diff(a).evaluate(y=y), 3 * np.cos(15))
+        assert func.diff(a).evaluate(y=y) == 3 * np.cos(15)
 
     def test_diff_zero(self):
         a = pybamm.StateVector(slice(0, 1))
         b = pybamm.StateVector(slice(1, 2))
         func = (a * 2 + 5 * (-a)) / (a * a)
-        self.assertEqual(func.diff(b), pybamm.Scalar(0))
-        self.assertNotEqual(func.diff(a), pybamm.Scalar(0))
+        assert func.diff(b) == pybamm.Scalar(0)
+        assert func.diff(a) != pybamm.Scalar(0)
 
     def test_diff_state_vector_dot(self):
         a = pybamm.StateVectorDot(slice(0, 1))
         b = pybamm.StateVector(slice(1, 2))
-        self.assertEqual(a.diff(a), pybamm.Scalar(1))
-        self.assertEqual(a.diff(b), pybamm.Scalar(0))
+        assert a.diff(a) == pybamm.Scalar(1)
+        assert a.diff(b) == pybamm.Scalar(0)
 
     def test_diff_heaviside(self):
         a = pybamm.Scalar(1)
         b = pybamm.StateVector(slice(0, 1))
 
         func = (a < b) * (2 * b)
-        self.assertEqual(func.diff(b).evaluate(y=np.array([2])), 2)
-        self.assertEqual(func.diff(b).evaluate(y=np.array([-2])), 0)
+        assert func.diff(b).evaluate(y=np.array([2])) == 2
+        assert func.diff(b).evaluate(y=np.array([-2])) == 0
 
     def test_diff_modulo(self):
         a = pybamm.Scalar(3)
         b = pybamm.StateVector(slice(0, 1))
 
         func = (a % b) * (b**2)
-        self.assertEqual(func.diff(b).evaluate(y=np.array([2])), 0)
-        self.assertEqual(func.diff(b).evaluate(y=np.array([5])), 30)
-        self.assertEqual(func.diff(b).evaluate(y=np.array([-2])), 12)
+        assert func.diff(b).evaluate(y=np.array([2])) == 0
+        assert func.diff(b).evaluate(y=np.array([5])) == 30
+        assert func.diff(b).evaluate(y=np.array([-2])) == 12
 
     def test_diff_maximum_minimum(self):
         a = pybamm.Scalar(1)
         b = pybamm.StateVector(slice(0, 1))
 
         func = pybamm.minimum(a, b**3)
-        self.assertEqual(func.diff(b).evaluate(y=np.array([10])), 0)
-        self.assertEqual(func.diff(b).evaluate(y=np.array([2])), 0)
-        self.assertEqual(func.diff(b).evaluate(y=np.array([-2])), 3 * (-2) ** 2)
+        assert func.diff(b).evaluate(y=np.array([10])) == 0
+        assert func.diff(b).evaluate(y=np.array([2])) == 0
+        assert func.diff(b).evaluate(y=np.array([-2])) == 3 * (-2) ** 2
 
         func = pybamm.maximum(a, b**3)
-        self.assertEqual(func.diff(b).evaluate(y=np.array([10])), 3 * 10**2)
-        self.assertEqual(func.diff(b).evaluate(y=np.array([2])), 3 * 2**2)
-        self.assertEqual(func.diff(b).evaluate(y=np.array([-2])), 0)
+        assert func.diff(b).evaluate(y=np.array([10])) == 3 * 10**2
+        assert func.diff(b).evaluate(y=np.array([2])) == 3 * 2**2
+        assert func.diff(b).evaluate(y=np.array([-2])) == 0
 
     def test_exceptions(self):
         a = pybamm.Symbol("a")
         b = pybamm.Symbol("b")
-        with self.assertRaises(NotImplementedError):
+        with pytest.raises(NotImplementedError):
             a._diff(b)
-
-
-if __name__ == "__main__":
-    print("Add -v for more debug output")
-    import sys
-
-    if "-v" in sys.argv:
-        debug = True
-    pybamm.settings.debug_mode = True
-    unittest.main()