Merge pull request #10 from gjbex/development

gjbex · web-flow · commit f4db5594f950 · 2023-04-18T13:33:46.000+02:00
Development
diff --git a/source-code/README.md b/source-code/README.md
@@ -25,7 +25,10 @@ was used to develop it.
 1. `testing`: illustrates writing unit tests with `unittest` and
    `pytest`.
 1. `oo_vs_functional.ipynb`: comparing object-oriented approach to
-  functional approach, including coroutines.
+   functional approach, including coroutines.
 1. `metaclasses`: illustration of the use of metaclasses in Python.
 1. `data-structures`: illustration of Python and standard library data
    structures.
+1. `code-organization`: illustration of how to organize code in packages
+   and modules.
+1. `error-handling`: simple illustration of error handling.
diff --git a/source-code/code-organization/README.md b/source-code/code-organization/README.md
@@ -0,0 +1,12 @@
+# Code organization
+
+Simple example of code organization in packages, modules.
+
+## What is it?
+
+1. `my_pkg`: Python package.
+  1. `__init__.py`: package-level documentation and version
+     information.
+  1. `my_module.py`: simple module in the `my_pkg` package.
+1. `my_script.py`: Python script that uses the `my_module`
+  module in the `my_pkg` package.
diff --git a/source-code/code-organization/my_pkg/__init__.py b/source-code/code-organization/my_pkg/__init__.py
@@ -0,0 +1,5 @@
+'''
+This is the my_pkg documentation
+'''
+
+__version__ = '1.0'
diff --git a/source-code/code-organization/my_pkg/my_module.py b/source-code/code-organization/my_pkg/my_module.py
@@ -0,0 +1,2 @@
+def hello(name):
+    return f'hello {name}'
diff --git a/source-code/code-organization/my_script.py b/source-code/code-organization/my_script.py
@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+
+import my_pkg.my_module
+
+print(my_pkg.my_module.hello('world'))
diff --git a/source-code/error-handling/README.md b/source-code/error-handling/README.md
@@ -0,0 +1,10 @@
+# Error handling
+
+Illustrations of error handling.
+
+## What is it?
+
+1. `simple.py`: Python scripts that illustrates some
+   ways ot handle errors.
+1. `data.txt`: data file to use as input.
+1. `data_not_ok.txt`: incorrect data file to use as input.
diff --git a/source-code/error-handling/data.txt b/source-code/error-handling/data.txt
@@ -0,0 +1,2 @@
+3.7
+3.3
diff --git a/source-code/error-handling/data_not_ok.txt b/source-code/error-handling/data_not_ok.txt
@@ -0,0 +1,4 @@
+3.7
+5.1
+some_string
+5.2
diff --git a/source-code/error-handling/simple.py b/source-code/error-handling/simple.py
@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+
+import sys
+
+ARG_ERROR = 1
+FILE_ERROR = 2
+DATA_ERROR = 3
+
+def sum_numbers(file):
+    total = 0
+    for line in file:
+        total += float(line)
+    return total
+
+
+if __name__ == '__main__':
+    if len(sys.argv) < 2:
+        print('### error: no argument given', file=sys.stderr)
+        sys.exit(ARG_ERROR)
+    file_name = sys.argv[1]
+    try:
+        file = open(file_name, 'r')
+        print(sum_numbers(file))
+    except IOError as e:
+        print(f'### IO Error on {e.filename}: {e.strerror}')
+        sys.exit(FILE_ERROR)
+    except ValueError:
+        print(f'### Data Error on {file_name}: should contain only numbers')
+        sys.exit(DATA_ERROR)
diff --git a/source-code/oo_vs_functional.ipynb b/source-code/oo_vs_functional.ipynb
@@ -285,8 +285,8 @@
     "    '''create a coroutine that keeps track of descriptive\n",
     "    statistics of a data stream\n",
     "    \n",
-    "    Params\n",
-    "    ------\n",
+    "    Parameters\n",
+    "    ----------\n",
     "    stats : dict\n",
     "        dictrionary that will hold the statistics, i.e., number of values,\n",
     "        mean and standard deviation.  The dictionary will contain None for\n",
@@ -396,8 +396,8 @@
     "    '''create a coroutine that keeps track of descriptive\n",
     "    statistics of a data stream\n",
     "    \n",
-    "    Params\n",
-    "    ------\n",
+    "    Parameters\n",
+    "    ----------\n",
     "    stats : dict\n",
     "        dictrionary that will hold the statistics, i.e., number of values,\n",
     "        mean and standard deviation.  The dictionary will contain None for\n",
@@ -710,8 +710,8 @@
     "    def __init__(self, sum_value: float=0.0, sum2: float=0.0, n: int=0):\n",
     "        '''constructor for Stats objects\n",
     "        \n",
-    "        Params\n",
-    "        ------\n",
+    "        Parameters\n",
+    "        ----------\n",
     "        Either none, which initializes an object that has seen no data yet, or\n",
     "        \n",
     "        sum_value: float\n",
@@ -777,8 +777,8 @@
     "        '''functional operator, creates a new Stats object when a value is added\n",
     "           called as stats + value\n",
     "        \n",
-    "        Params\n",
-    "        ------\n",
+    "        Parameters\n",
+    "        ----------\n",
     "        value: float\n",
     "            new data value to be added to the statistics\n",
     "            \n",
@@ -792,8 +792,8 @@
     "    def __iadd__(self, value: float):\n",
     "        '''non-functional operator, updates the Stats object when a value is added\n",
     "        \n",
-    "        Params\n",
-    "        ------\n",
+    "        Parameters\n",
+    "        ----------\n",
     "        value: float\n",
     "            new data value to be added to the statistics\n",
     "            \n",
@@ -1568,7 +1568,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.11.2"
   }
  },
  "nbformat": 4,
diff --git a/source-code/typing/README.md b/source-code/typing/README.md
@@ -36,3 +36,7 @@ Type checking can be done using [mypy](http://mypy-lang.org/index.html).
    false positive.
 1. `numpy_typing.py`: illustration of a script using both numpy and
    matplotlib with type hints.
+1. `classes.py`: illustration of using type hints with a user-defined
+   class.
+1. `classes_incorrect.py`: illustration of using type hints with a
+   user-defined class with errors.
diff --git a/source-code/typing/classes.py b/source-code/typing/classes.py
@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+
+from typing import Any
+
+
+class MyClass:
+
+    def __init__(self, data: Any) -> None:
+        self.data = data
+
+    @property
+    def data(self) -> int:
+        return self.data
+
+    @data.setter
+    def data(self, value: Any) -> None:
+        self.data = int(value)
+
+    def __repr__(self) -> str:
+        return f'data: {self.data}'
+
+
+def print_data(data: MyClass) -> None:
+    print(data)
+
+
+if __name__ == '__main__':
+    data = MyClass('25')
+    print_data(data)
diff --git a/source-code/typing/classes_incorrect.py b/source-code/typing/classes_incorrect.py
@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+
+from typing import Any
+
+
+class MyClass:
+
+    def __init__(self, data: Any) -> None:
+        self.data = data
+
+    @property
+    def data(self) -> int:
+        return self.data
+
+    @data.setter
+    def data(self, value: Any) -> None:
+        self.data = int(value)
+
+    def __repr__(self) -> str:
+        return f'data: {self.data}'
+
+
+def print_data(data: MyClass) -> None:
+    print(data)
+
+
+def print_all(datas: list[MyClass]) -> None:
+    for data in datas:
+        print_data(data)
+
+
+if __name__ == '__main__':
+    data = MyClass('25')
+    print_data(data)
+    datas = [data]
+    print_all(datas)
+    datas.append('354')
+    print_all(datas)
diff --git a/source-code/typing/incorrect_01.py b/source-code/typing/incorrect_01.py
diff --git a/source-code/typing/incorrect_02.py b/source-code/typing/incorrect_02.py

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +'''
 +This is the my_pkg documentation
 +'''
++
 +__version__ = '1.0'
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+def hello(name):`
	`2`	`+ return f'hello {name}'`