differences for PR #56

Author: actions-user

05-defensive_programming.md

@@ -75,16 +75,24 @@ TypeError: '>' not supported between instances of 'str' and 'int'
 
 ::::::::::::::::::::::::::::::::::::::::::::::::::
 
-We can avoid problems like this by wrapping our code in an `if` statement:
+We can avoid problems like this by wrapping our code in an `if` statement.
+To make things simpler, we will first write the test as a function:
 
 ```python
-if type(val) is int or type(val) is float:
+def check_value(val):
     if val>0 and val<10:
         print('Value: ', val, 'is a digit.')
     elif val==0:
         print('Value ', val, 'is nul')
     else:
         print('Value: ', val, 'is a number.')
+```
+
+Then wrap the function call in an `if` statement:
+
+```python
+if type(val) is int or type(val) is float:
+    check_value(val)
 else:
     print('val is not a number')
 ```
@@ -95,29 +103,21 @@ Python provides the `try-except` structure to avoid this issue, enabling develop
 
 ```python
 try:
-    if val>0 and val<10:
-        print('Value: ', val, 'is a digit.')
-    elif val==0:
-        print('Value ', val, 'is nul')
-    else:
-        print('Value: ', val, 'is a number.')
+    check_value(val)
 except:
     print('Val is not a number')
     print('Enter a new number')
 ```
 
 At the top of the statement is the code that we are interested in executing, which is run in the `try` statement. If that fails then the `except` statement comes into effect, (hopefully) returning helpful information to the user about what happened and giving them some guidance on how to avoid the problem in future.
 
+Using `try-except` statements results in clearer, easier to understand code by following the common Python coding style of [EAFP](https://docs.python.org/3.6/glossary.html#term-eafp) (it's easier to ask for forgiveness than permission). This style shows the code we want to execute first, assuming that the incoming data is correct, before dealing with exceptions if the assumptions prove false.
+
 The `except` statement will catch all errors and so we do not, initially at least, need to know exactly what errors we are trying to avoid. However, python does provide error codes, which we can use to expand the structure to capture specific error types. For the example above, we would want to capture a `TypeError`:
 
 ```python
 try:
-    if val>0 and val<10:
-        print('Value: ', val, 'is a digit.')
-    elif val==0:
-        print('Value ', val, 'is nul')
-    else:
-        print('Value: ', val, 'is a number.')
+    check_value(val)
 except TypeError as err:
     print('Val is not a number')
     print('But our code does not crash anymore')
@@ -130,12 +130,7 @@ As with `if` statements, multiple `except` statements can be used, each with a d
 
 ```python
 try:
-    if val>0 and val<10:
-        print('Value: ', val, 'is a digit.')
-    elif val==0:
-        print('Value ', val, 'is nul')
-    else:
-        print('Value: ', val, 'is a number.')
+    check_value(val)
 except TypeError as err:
     print('Val is not a number')
     print('But our code does not crash anymore')
@@ -219,12 +214,7 @@ val = 'a'
 
 assert type(val) is float or type(val) is int, "Variable has to be a numerical object"
 
-if val>0 and val<10:
-    print('Value: ', val, 'is a digit.')
-elif val==0:
-    print('Value ', val, 'is nul')
-else:
-    print('Value: ', val, 'is a number.')
+check_value(val)
 ```
 
 ```output
@@ -252,12 +242,7 @@ val = np.nan
 
 assert type(val) is float or type(val) is int, "Variable has to be a numerical object"
 
-if val>0 and val<10:
-  print('Value: ', val, 'is a digit.')
-elif val==0:
-  print('Value ', val, 'is nul')
-else:
-  print('Value: ', val, 'is a number.')
+check_value(val)
 ```
 
 ```output
@@ -281,12 +266,7 @@ val = np.nan
 assert type(val) is float or type(val) is int, "Variable has to be a numerical object"
 assert not np.isnan(val), "Variable must not be a NaN"
 
-if val>0 and val<10:
-    print('Value: ', val, 'is a digit.')
-elif val==0:
-    print('Value ', val, 'is nul')
-else:
-    print('Value: ', val, 'is a number.')
+check_value(val)
 ```
 
 ```output

md5sum.txt

@@ -8,7 +8,7 @@
 "episodes/02-dictionaries.md" "4d66dd7a84d0a6476fbd327812b7a0d4" "site/built/02-dictionaries.md" "2025-04-15"
 "episodes/03-numpy_essential.md" "8be0e5afb556d4f597f31f059488dd15" "site/built/03-numpy_essential.md" "2025-04-15"
 "episodes/04-software_package_management.md" "62db2ba2a4291e16d2bdd07b77bfc961" "site/built/04-software_package_management.md" "2025-04-15"
-"episodes/05-defensive_programming.md" "357bca7361e09066ad71393e21ad0c74" "site/built/05-defensive_programming.md" "2025-04-15"
+"episodes/05-defensive_programming.md" "045cd12997dcdf15e6d79c6b40bcc766" "site/built/05-defensive_programming.md" "2025-11-14"
 "episodes/06-units_and_quantities.md" "f02e82346d2f3b9675c133921f1f922f" "site/built/06-units_and_quantities.md" "2025-04-15"
 "episodes/07-pandas_essential.md" "5dde09b1125f8c30156ae314b5fdcfe1" "site/built/07-pandas_essential.md" "2025-04-15"
 "instructors/instructor-notes.md" "a59fd3b94c07c3fe3218c054a0f03277" "site/built/instructor-notes.md" "2025-04-15"