Merge pull request #646 from realpython/python-code-quality

Sample code for the article on code quality

Author: brendaweles

python-code-quality/README.md

@@ -0,0 +1,3 @@
+# Python Code Quality: Best Practices and Tools
+
+This folder provides the code examples for the Real Python tutorial [Python Code Quality: Best Practices and Tools](https://realpython.com/python-code-quality/).

python-code-quality/compilance.py

@@ -0,0 +1,7 @@
+# def calcTotal(price,taxRate=0.05): return price*(1+taxRate)
+
+
+def calculate_price_with_taxes(
+    base_price: float, tax_rate: float = 0.05
+) -> float:
+    return base_price * (1 + tax_rate)

python-code-quality/documentation.py

@@ -0,0 +1,18 @@
+# def multiply(a, b):
+#     return a * b
+
+
+def multiply(a: float, b: float) -> float:
+    """Multiply two numbers
+
+    Args:
+        a (float): First number.
+        b (float): Second number.
+
+    Returns:
+        float: Product of a and b.
+    """
+    return a * b
+
+
+print(multiply(2, 3))

python-code-quality/efficiency_v1.py

@@ -0,0 +1,14 @@
+from time import perf_counter
+
+
+def fibonacci_of(n):
+    if n in {0, 1}:
+        return n
+    return fibonacci_of(n - 1) + fibonacci_of(n - 2)
+
+
+start = perf_counter()
+[fibonacci_of(n) for n in range(35)]
+end = perf_counter()
+
+print(f"Execution time: {end - start:.2f} seconds")

python-code-quality/efficiency_v2.py

@@ -0,0 +1,17 @@
+from time import perf_counter
+
+cache = {0: 0, 1: 1}
+
+
+def fibonacci_of(n):
+    if n in cache:
+        return cache[n]
+    cache[n] = fibonacci_of(n - 1) + fibonacci_of(n - 2)
+    return cache[n]
+
+
+start = perf_counter()
+[fibonacci_of(n) for n in range(35)]
+end = perf_counter()
+
+print(f"Execution time: {end - start:.2f} seconds")

python-code-quality/functionality.py

@@ -0,0 +1,11 @@
+# def add_numbers(a, b):
+#     return a + b
+
+
+def add_numbers(a: int | float, b: int | float) -> int | float:
+    a, b = float(a), float(b)
+    return a + b
+
+
+print(add_numbers(2, 3))
+print(add_numbers(2, "3"))

python-code-quality/input_v1.py

@@ -0,0 +1,5 @@
+user_input = "Amount to withdraw? "
+amount = int(input(user_input))
+available_balance = 1000
+print(f"Here are your {amount:.2f}USD")
+print(f"Your available balance is {available_balance - amount:.2f}USD")

python-code-quality/input_v2.py

@@ -0,0 +1,10 @@
+user_input = "Amount to withdraw? "
+amount = int(input(user_input))
+available_balance = 1000
+if amount > available_balance:
+    print("Insufficient funds")
+    amount = 0
+else:
+    print(f"Here are your {amount:.2f}USD")
+
+print(f"Your available balance is {available_balance - amount:.2f}USD")

python-code-quality/maintainability.py

@@ -0,0 +1,18 @@
+def process(numbers):
+    cleaned = [number for number in numbers if number >= 0]
+    return sum(cleaned)
+
+
+print(process([1, 2, 3, -1, -2, -3]))
+
+
+def clean_data(numbers: list[int]) -> list[int]:
+    return [number for number in numbers if number >= 0]
+
+
+def calculate_total(numbers: list[int]) -> int:
+    return sum(numbers)
+
+
+cleaned = clean_data([1, 2, 3, -1, -2, -3])
+print(calculate_total(cleaned))

python-code-quality/readability.py

@@ -0,0 +1,10 @@
+def ca(w, h):
+    return w * h
+
+
+def calculate_rectangle_area(width: float, height: float) -> float:
+    return width * height
+
+
+print(ca(12, 20))
+print(calculate_rectangle_area(12, 20))