Fix test in Object-Oriented Example 4 (empa-scientific-it#262)

despadam · edoardob90 · web-flow · commit 656d3d25f404 · 2024-11-18T12:27:28.000+01:00
* Add __eq__ validation in Example 4
* Add a comment to explain the rationale behind __closure__ testing

---------
Co-authored-by: edoardob90 &lt;edoardob90@gmail.com&gt;
diff --git a/object_oriented_programming.ipynb b/object_oriented_programming.ipynb
@@ -19,7 +19,7 @@
     "    - [Example 1](#Example-1)\n",
     "  - [Properties and methods](#Properties-and-methods)\n",
     "    - [Example 2](#Example-2)\n",
-    "  - [Python's *special methods*](#Python's-*special-methods*)\n",
+    "  - [Python's special methods](#Python's-special-methods)\n",
     "    - [`__str__` and `__repr__`](#__str__-and-__repr__)\n",
     "      - [Example 3](#Example-3)\n",
     "    - [Comparison methods](#Comparison-methods)\n",
@@ -220,7 +220,7 @@
     "    \"\"\"\n",
     "\n",
     "    # Write your solution here\n",
-    "    pass"
+    "    return"
    ]
   },
   {
@@ -357,7 +357,7 @@
     "    \"\"\"\n",
     "\n",
     "    # Write your solution here\n",
-    "    pass"
+    "    return"
    ]
   },
   {
@@ -367,7 +367,7 @@
     "tags": []
    },
    "source": [
-    "# Python's *special methods*"
+    "# Python's special methods"
    ]
   },
   {
@@ -684,7 +684,7 @@
     "    \"\"\"\n",
     "\n",
     "    # Write your solution here\n",
-    "    pass"
+    "    return"
    ]
   },
   {
@@ -974,7 +974,7 @@
     "    \"\"\"\n",
     "\n",
     "    # Write your solution here\n",
-    "    pass"
+    "    return"
    ]
   },
   {
@@ -1429,7 +1429,7 @@
     "    \"\"\"\n",
     "\n",
     "    # Write your solution here\n",
-    "    pass"
+    "    return"
    ]
   },
   {
@@ -1476,11 +1476,11 @@
     "    Args:\n",
     "        flavors: all available ice cream flavors\n",
     "    Returns:\n",
-    "        - a bowl\n",
+    "        - a Bowl instance\n",
     "    \"\"\"\n",
     "\n",
     "    # Write your solution here\n",
-    "    pass"
+    "    return"
    ]
   },
   {
@@ -1538,7 +1538,7 @@
     "    \"\"\"\n",
     "\n",
     "    # Write your solution here\n",
-    "    pass"
+    "    return"
    ]
   },
   {
@@ -1680,7 +1680,7 @@
     "    \"\"\"\n",
     "\n",
     "    # Write your solution here\n",
-    "    pass"
+    "    return"
    ]
   }
  ],
@@ -1700,7 +1700,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.15"
+   "version": "3.10.13"
   }
  },
  "nbformat": 4,
diff --git a/tutorial/tests/test_object_oriented_programming.py b/tutorial/tests/test_object_oriented_programming.py
@@ -13,6 +13,17 @@ def __init__(self):
 # Example 1: Person
 #
 
+# NOTE:
+# When testing the classes returned by the solutions function in the Examples 1-4
+# we often need to check if a class method is implemented and it's using the right attributes.
+# One way to check both is to check if the class's method has the __closure__ attribute.
+# Why?
+#   1. If __method__ is not implemented, Python will fetch object.__method__ instead, which obviously is not a closure
+#       `hasattr(solution_result.__method__, "__closure__")` will return False.
+#   2. If __method__ is implemented, but it's not using the class attributes, it will be a closure
+#       `solution_result.__method__.__closure__ is None` will return False.
+# Reference: https://github.com/empa-scientific-it/python-tutorial/pull/249#discussion_r1836867387
+
 
 def reference_oop_person(first_name: str, last_name: str):
     class Person:
@@ -211,6 +222,9 @@ def validate_oop_compare_persons(solution_result):
     assert (
         type(solution_result).__name__ == "Person"
     ), "The class should be named 'Person'."
+    assert hasattr(
+        solution_result.__eq__, "__closure__"
+    ), "Make sure that the class is properly implementing the __eq__() method."
     # Check the class attributes
     try:
         attrs = list(vars(solution_result))

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`" - [Example 1](#Example-1)\n",`
`20`	`20`	`" - [Properties and methods](#Properties-and-methods)\n",`
`21`	`21`	`" - [Example 2](#Example-2)\n",`
`22`		`- " - [Python's special methods](#Python's-special-methods)\n",`
	`22`	`+ " - [Python's special methods](#Python's-special-methods)\n",`
`23`	`23`	" - [`__str__` and `__repr__`](#__str__-and-__repr__)\n",
`24`	`24`	`" - [Example 3](#Example-3)\n",`
`25`	`25`	`" - [Comparison methods](#Comparison-methods)\n",`
`@@ -220,7 +220,7 @@`
`220`	`220`	`" \"\"\"\n",`
`221`	`221`	`"\n",`
`222`	`222`	`" # Write your solution here\n",`
`223`		`- " pass"`
	`223`	`+ " return"`
`224`	`224`	`]`
`225`	`225`	`},`
`226`	`226`	`{`
`@@ -357,7 +357,7 @@`
`357`	`357`	`" \"\"\"\n",`
`358`	`358`	`"\n",`
`359`	`359`	`" # Write your solution here\n",`
`360`		`- " pass"`
	`360`	`+ " return"`
`361`	`361`	`]`
`362`	`362`	`},`
`363`	`363`	`{`
`@@ -367,7 +367,7 @@`
`367`	`367`	`"tags": []`
`368`	`368`	`},`
`369`	`369`	`"source": [`
`370`		`- "# Python's special methods"`
	`370`	`+ "# Python's special methods"`
`371`	`371`	`]`
`372`	`372`	`},`
`373`	`373`	`{`
`@@ -684,7 +684,7 @@`
`684`	`684`	`" \"\"\"\n",`
`685`	`685`	`"\n",`
`686`	`686`	`" # Write your solution here\n",`
`687`		`- " pass"`
	`687`	`+ " return"`
`688`	`688`	`]`
`689`	`689`	`},`
`690`	`690`	`{`
`@@ -974,7 +974,7 @@`
`974`	`974`	`" \"\"\"\n",`
`975`	`975`	`"\n",`
`976`	`976`	`" # Write your solution here\n",`
`977`		`- " pass"`
	`977`	`+ " return"`
`978`	`978`	`]`
`979`	`979`	`},`
`980`	`980`	`{`
`@@ -1429,7 +1429,7 @@`
`1429`	`1429`	`" \"\"\"\n",`
`1430`	`1430`	`"\n",`
`1431`	`1431`	`" # Write your solution here\n",`
`1432`		`- " pass"`
	`1432`	`+ " return"`
`1433`	`1433`	`]`
`1434`	`1434`	`},`
`1435`	`1435`	`{`
`@@ -1476,11 +1476,11 @@`
`1476`	`1476`	`" Args:\n",`
`1477`	`1477`	`" flavors: all available ice cream flavors\n",`
`1478`	`1478`	`" Returns:\n",`
`1479`		`- " - a bowl\n",`
	`1479`	`+ " - a Bowl instance\n",`
`1480`	`1480`	`" \"\"\"\n",`
`1481`	`1481`	`"\n",`
`1482`	`1482`	`" # Write your solution here\n",`
`1483`		`- " pass"`
	`1483`	`+ " return"`
`1484`	`1484`	`]`
`1485`	`1485`	`},`
`1486`	`1486`	`{`
`@@ -1538,7 +1538,7 @@`
`1538`	`1538`	`" \"\"\"\n",`
`1539`	`1539`	`"\n",`
`1540`	`1540`	`" # Write your solution here\n",`
`1541`		`- " pass"`
	`1541`	`+ " return"`
`1542`	`1542`	`]`
`1543`	`1543`	`},`
`1544`	`1544`	`{`
`@@ -1680,7 +1680,7 @@`
`1680`	`1680`	`" \"\"\"\n",`
`1681`	`1681`	`"\n",`
`1682`	`1682`	`" # Write your solution here\n",`
`1683`		`- " pass"`
	`1683`	`+ " return"`
`1684`	`1684`	`]`
`1685`	`1685`	`}`
`1686`	`1686`	`],`
`@@ -1700,7 +1700,7 @@`
`1700`	`1700`	`"name": "python",`
`1701`	`1701`	`"nbconvert_exporter": "python",`
`1702`	`1702`	`"pygments_lexer": "ipython3",`
`1703`		`- "version": "3.10.15"`
	`1703`	`+ "version": "3.10.13"`
`1704`	`1704`	`}`
`1705`	`1705`	`},`
`1706`	`1706`	`"nbformat": 4,`