Merge branch 'issue/7'

Author: rambasnet

notebooks/CodingBestPractices.ipynb

@@ -316,6 +316,51 @@
     "odd('hi')"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## annotating advanced types\n",
+    "\n",
+    "- only primitive types can be annotated directly\n",
+    "    - int, float, str, and bool\n",
+    "- for advanced types, import capitalized type names from `typing` module\n",
+    "- Union, Optional, Any, Tuple, List, Dict, Set, etc.\n",
+    "- `List[int]` - list of integers\n",
+    "- `Dict[str, int]` - dictionary with string keys and integer values\n",
+    "- `Tuple[int, str, float]` - tuple with an integer, string, and float\n",
+    "- `Set[bool]` - set of booleans\n",
+    "- `Optional[str]` - optional string (can be None)\n",
+    "- `Union[int, float]` - can be either an integer or a float\n",
+    "- `Any` - any type\n",
+    "- `Callable[[int, int], int]` - function that takes two integers and returns an integer\n",
+    "- `Iterable[str]` - iterable of strings\n",
+    "- `Iterator[int]` - iterator of integers\n",
+    "- `a: int | float` - variable `a` can be either an integer or a float\n",
+    "- `def foo(a: int | float) -> int | float:` - function `foo` takes an integer or a float and returns an integer or a float\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from typing import List, Tuple\n",
+    "\n",
+    "def max_min(lst: List[float]) -> Tuple[float, float]:\n",
+    "    return max(lst), min(lst)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "assert max_min([1.0, 2.0, 3.0, 4.0]) == (4.0, 1.0)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -869,7 +914,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "oop",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },
@@ -883,7 +928,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.12.1"
   }
  },
  "nbformat": 4,