update Unittest chapter

Author: rambasnet

notebooks/TestingFunctions-unittest.ipynb

@@ -150,46 +150,6 @@
     "    4. THEN we see steam escaping"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "aa37aafc",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Optional, List"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "1e758601",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def average(data: List[Optional[int]]) -> float:\n",
-    "    \"\"\"\n",
-    "    GIVEN a list, data = [1, 2, None, 3, 4]\n",
-    "    WHEN we compute m = average(data)\n",
-    "    THEN the result, m is 2.5\n",
-    "    \n",
-    "    Finds and returns average of a List of optional integers.\n",
-    "    \n",
-    "    Assumptions:\n",
-    "        - Ignore None.\n",
-    "        - Throw ZeroDivisionError if data is an empty list.\n",
-    "    \"\"\"\n",
-    "    tmp: float = 0\n",
-    "    len_data: int = len(data)\n",
-    "    for x in data:\n",
-    "        try:\n",
-    "            tmp += x\n",
-    "        except TypeError:\n",
-    "            len_data -= 1\n",
-    "            \n",
-    "    return tmp/len_data\n"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "e9e0ec4f",
@@ -214,7 +174,43 @@
     "\n",
     "1. test the boundary values: 1 and 1000\n",
     "2. test data just below the extreme values: 0 and 999\n",
-    "3. test data just above the extreme values: 2 and 1001"
+    "3. test data just above the extreme values: 2 and 1001\n",
+    "\n",
+    "\n",
+    "### Example of Test Driven Development (TDD)\n",
+    "\n",
+    "- write a function that finds the average of a list of numbers\n",
+    "- input assumptions:\n",
+    "    - input is a list of integers\n",
+    "    - list can be empty\n",
+    "    - list may contain None for missing values\n",
+    "- output assumptions:\n",
+    "    - output is a float\n",
+    "    - if the list is empty or contains only None throw DivisionByZeroError exception\n",
+    "    - answer should be correct to 7 decimal places"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "8ff412e9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from typing import Optional, List\n",
+    "\n",
+    "def average(data: List[Optional[int]]) -> float:\n",
+    "    \"\"\"\n",
+    "    GIVEN a list, data = [1, 2, None, 3, 4]\n",
+    "    WHEN we compute m = average(data)\n",
+    "    THEN the result, m is 2.5\n",
+    "    \n",
+    "    Finds and returns average of a List of optional integers.\n",
+    "    \n",
+    "    Assumptions:\n",
+    "        - Ignore None.\n",
+    "        - Throw ZeroDivisionError if data is an empty list.\n",
+    "    \"\"\""
    ]
   },
   {
@@ -281,35 +277,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 26,
-   "id": "c5ab7a9e",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "2.6666666666666665"
-      ]
-     },
-     "execution_count": 26,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "average([1, 3, 4])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 39,
+   "execution_count": null,
    "id": "477fdb48",
    "metadata": {},
    "outputs": [],
    "source": [
     "def test_average6():\n",
     "    # float literal comparison or code comparison\n",
     "    # float literal comparison may require tolerance (error less than 0.0001 or 10^-4, e.g.)\n",
+    "    # average([1, 3, 4]) = 2.6666666666666665...\n",
     "    assert abs(average([1, 3, 4]) - 2.6666666) < 10**-7"
    ]
   },
@@ -327,72 +303,29 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 29,
-   "id": "b62bc7f7",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "test_average1()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 30,
-   "id": "59c6d5ac",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "test_average2()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 31,
-   "id": "466f4670",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "test_average3()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 32,
-   "id": "fd5bade7",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "test_average4()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 33,
-   "id": "c5044622",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "test_average5()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 40,
-   "id": "3151739e",
+   "execution_count": null,
+   "id": "c603e248",
    "metadata": {},
    "outputs": [],
    "source": [
-    "test_average6()"
+    "def run_all_tests():\n",
+    "    test_average1()\n",
+    "    test_average2()\n",
+    "    test_average3()\n",
+    "    test_average4()\n",
+    "    test_average5()\n",
+    "    test_average6()\n",
+    "    test_average7()"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "33dad625",
+   "id": "b62bc7f7",
    "metadata": {},
    "outputs": [],
    "source": [
-    "test_average7()"
+    "run_all_tests()"
    ]
   },
   {
@@ -501,7 +434,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },
@@ -515,12 +448,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.8"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "1a1af0ee75eeea9e2e1ee996c87e7a2b11a0bebd85af04bb136d915cefc0abce"
-   }
+   "version": "3.9.6"
   }
  },
  "nbformat": 4,