Merge remote-tracking branch 'origin/development' into development

Author: gjbex

source-code/decorators/README.md

@@ -14,5 +14,9 @@ What is it?
     large.  The decorated function in this example is the factorial.
     Also it illustrates `functools` wrap decorator to retain the wrapped
     function's name, docstring, etc.
+1. `decorator_arguments.py`: an example of a decorator that takes arguments.
+   The `check_range` decorator takes a minimum and maximum value as arguments
+   and checks if the wrapped function's argument falls within that range,
+   throwing an exception if it does not.
 1. `memoize.py`: an example of adding a cache to a function using a simple
     custom decorator, as well as `functools`'s `lru_cache` decorator.

source-code/decorators/decorator_arguments.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+
+import functools
+
+
+def check_bounds(min_value, max_value):
+    '''Check bounds of a function argument
+
+    Parameters
+    ----------
+    min_value: float
+        Smallest value allowed for the function's parameter
+    max_value: float
+        Largest value allowed for the function's parameter
+
+    Raises
+    ------
+    ValueError:
+        If the argument is outside the specified bounds
+    '''
+    def check_bounds_wrapper(_func):
+        @functools.wraps(_func)
+        def wrapper(x):
+            if min_value > x or x > max_value:
+                raise ValueError(f'argument {x} not in [{min_value}, {max_value}]')
+            return _func(x)
+        return wrapper
+    return check_bounds_wrapper
+
+
+@check_bounds(min_value=-1.0, max_value=1.0)
+def silly(x):
+    '''Compute a rather uninteresting function
+
+    Parameters
+    ----------
+    x: float
+        Argument for the function
+
+    Returns
+    -------
+    float:
+        Value computed by the function
+    '''
+    return x**2 - 2.0
+
+
+if __name__ == '__main__':
+    print(silly(0.5))
+    try:
+        print(silly(2.5))
+    except ValueError as e:
+        print(f'Excepton raised as expected: {e.message}')

source-code/object-orientation/dynamic_classes.ipynb

@@ -119,7 +119,15 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "Cat = make_dataclass('Cat', [('species', str, 'cat'), ('nr_legs', int, 4), ('sound', str, 'meow')], bases=(Animal, ))"
+    "Cat = make_dataclass(\n",
+    "    'Cat',\n",
+    "    [\n",
+    "        ('species', str, 'cat'),\n",
+    "        ('nr_legs', int, 4),\n",
+    "        ('sound', str, 'meow')\n",
+    "    ],\n",
+    "    bases=(Animal, )\n",
+    ")"
    ]
   },
   {
@@ -202,7 +210,15 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "Dog = make_dataclass('Dog', [('nr_legs', int, 4), ('species', str, 'dog'), ('sound', str, 'woof')], bases=(Animal, ))"
+    "Dog = make_dataclass(\n",
+    "    'Dog',\n",
+    "    [\n",
+    "        ('nr_legs', int, 4),\n",
+    "        ('species', str, 'dog'),\n",
+    "        ('sound', str, 'woof')\n",
+    "    ],\n",
+    "    bases=(Animal, )\n",
+    ")"
    ]
   },
   {
@@ -423,7 +439,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "Animal = type('Animal', tuple(), {'name': None, 'species': None, 'nr_legs': None, '__init__': animal_init})"
+    "Animal = type(\n",
+    "    'Animal',\n",
+    "    tuple(),\n",
+    "    {\n",
+    "        'name': None,\n",
+    "        'species': None,\n",
+    "        'nr_legs': None,\n",
+    "        '__init__': animal_init,\n",
+    "    }\n",
+    ")"
    ]
   },
   {
@@ -579,7 +604,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "Cat = type('Cat', (Animal, ), {'name': None, 'species': 'cat', 'nr_legs': 4, 'sound': 'meow'})"
+    "Cat = type(\n",
+    "    'Cat',\n",
+    "    (Animal, ),\n",
+    "    {\n",
+    "        'name': None,\n",
+    "        'species': 'cat',\n",
+    "        'nr_legs': 4,\n",
+    "        'sound': 'meow',\n",
+    "    }\n",
+    ")"
    ]
   },
   {
@@ -970,7 +1004,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,