Use actual outcome
Review the result from a failed test, then update its expected value.
test_total.py
Before
def test_total():
total = calculate_total([10, 20])
assert total == 25
After
def test_total():
total = calculate_total([10, 20])
assert total == 30
Make optional
Make a required parameter optional, right at its declaration.
greetings.py
Before
def greet(
name: str,
title: str,
):
return f"{title} {name}"
After
def greet(
name: str,
title: str | None = None,
):
return f"{title} {name}"
Introduce parameter object
Group related parameters, then update callers across files.
orders.py
Before
def place_order(customer: str, quantity: int):
return f"{customer}: {quantity}"
After
from dataclasses import dataclass
@dataclass(frozen=True)
class OrderRequest:
customer: str
quantity: int
def place_order(request: OrderRequest):
return f"{request.customer}: {request.quantity}"
checkout.py
Before
from orders import place_order
place_order("Ada", 2)
After
from orders import OrderRequest, place_order
place_order(OrderRequest("Ada", 2))
Structure filters
Hide private members while keeping the public interface visible.
service.py
Before
class Service:
def run(self): pass
def _helper(self): pass
def __repr__(self): return "Service"
After
class Service:
def run(self): pass
def _helper(self): pass
def __repr__(self): return "Service"