Merge pull request #515 from realpython/python-unittest

Sample code for the article on `unittest`

Author: brendaweles

python-unittest/README.md

@@ -0,0 +1,3 @@
+# Python's unittest: Writing Unit Tests for Your Code
+
+This folder provides the code examples for the Real Python tutorial [Python's unittest: Writing Unit Tests for Your Code](https://realpython.com/python-unittest/).

python-unittest/age.py

@@ -0,0 +1,11 @@
+def categorize_by_age(age):
+    if 0 <= age <= 9:
+        return "Child"
+    elif 9 < age <= 18:
+        return "Adolescent"
+    elif 18 < age <= 65:
+        return "Adult"
+    elif 65 < age <= 150:
+        return "Golden age"
+    else:
+        return f"Invalid age: {age}"

python-unittest/calculations.py

@@ -0,0 +1,36 @@
+from collections import Counter
+
+
+def add(x, y):
+    return x + y
+
+
+def subtract(x, y):
+    return x - y
+
+
+def multiply(x, y):
+    return x * y
+
+
+def divide(x, y):
+    if y == 0:
+        raise ZeroDivisionError("Cannot divide by zero.")
+    return x / y
+
+
+def mean(data):
+    return sum(data) / len(data)
+
+
+def median(data):
+    n = len(data)
+    index = n // 2
+    if n % 2:
+        return sorted(data)[index]
+    return sum(sorted(data)[index - 1 : index + 1]) / 2
+
+
+def mode(data):
+    c = Counter(data)
+    return [k for k, v in c.items() if v == c.most_common(1)[0][1]]

python-unittest/employee.py

@@ -0,0 +1,38 @@
+import csv
+
+
+class Employee:
+    __slots__ = ["name", "age", "job", "salary"]
+
+    def __init__(self, name, age, job, salary):
+        self.name = name
+        self.age = age
+        self.job = job
+        self.salary = salary
+
+    def profile(self):
+        for attr in self.__slots__:
+            print(f"{attr.capitalize()}: {getattr(self, attr)}")
+        print()
+
+
+def from_csv_file(file_path):
+    with open(file_path) as file:
+        reader = csv.DictReader(file)
+        employees = []
+        for row in reader:
+            employees.append(
+                Employee(
+                    name=row["name"],
+                    age=int(row["age"]),
+                    job=row["job"],
+                    salary=float(row["salary"]),
+                )
+            )
+        return employees
+
+
+if __name__ == "__main__":
+    employees = from_csv_file("employees.csv")
+    for employee in employees:
+        employee.profile()

python-unittest/employees.csv

@@ -0,0 +1,5 @@
+name,age,job,salary
+Alice,25,Engineer,50000
+Bob,30,Analyst,60000
+Jane,35,Manager,80000
+John,40,CEO,100000

python-unittest/even.py

@@ -0,0 +1,2 @@
+def is_even(number):
+    return number % 2 == 0

python-unittest/fizzbuzz.py

@@ -0,0 +1,20 @@
+# def fizzbuzz(number):
+#     if number % 3 == 0:
+#         return "fizz"
+#     elif number % 5 == 0:
+#         return "buzz"
+#     elif number % 15 == 0:
+#         return "fizz buzz"
+#     else:
+#         return number
+
+
+def fizzbuzz(number):
+    if number % 15 == 0:
+        return "fizz buzz"
+    elif number % 3 == 0:
+        return "fizz"
+    elif number % 5 == 0:
+        return "buzz"
+    else:
+        return number

python-unittest/game.py

@@ -0,0 +1,6 @@
+def rock_paper_scissors(choice):
+    if choice < 0 or choice > 2:
+        raise ValueError("number must be 0, 1, or 2")
+
+    choices = ["rock", "paper", "scissors"]
+    return choices[choice]

python-unittest/prime_v1.py

@@ -0,0 +1,10 @@
+import math
+
+
+def is_prime(number):
+    if number <= 1:
+        return False
+    for i in range(2, int(math.sqrt(number)) + 1):
+        if number % i == 0:
+            return False
+    return True

python-unittest/prime_v2.py

@@ -0,0 +1,14 @@
+from math import sqrt
+
+
+def is_prime(number):
+    if not isinstance(number, int):
+        raise TypeError(
+            f"integer number expected, got {type(number).__name__}"
+        )
+    if number < 2:
+        raise ValueError(f"integer above 1 expected, got {number}")
+    for candidate in range(2, int(sqrt(number)) + 1):
+        if number % candidate == 0:
+            return False
+    return True