Introduce static typing into an existing project without rewriting it all at once.
What It Does and Why It Matters
Begin at module boundaries and stable helper functions. Add annotations to frequently called public functions, run a checker, and repair clear mismatches before enabling the strictest settings. Leave third-party libraries or dynamic legacy sections for later rather than adding Any everywhere to silence diagnostics.
Type checkers are third-party development tools; annotations still run without them.
Annotations guide static tools; by default they do not validate external input or change the return value at runtime.
Step-by-Step Example
Start with the complete example below. Read the inputs and predict what the final print statement will show before you run it.
def normalize_name(name: str) -> str:
return " ".join(name.strip().split()).title()
def display_names(names: list[str]) -> list[str]:
return [normalize_name(name) for name in names]
print(display_names([" ada lovelace ", "grace hopper"]))How the Code Works
- The definition of normalize_name, display_names creates reusable behavior; its body runs only when called or instantiated as appropriate.
- The print calls display the results. Compare these results with the method’s documented return type and the input used.
Expected output:
['Ada Lovelace', 'Grace Hopper']For the demonstrated inputs, Python displays "['Ada Lovelace', 'Grace Hopper']". This result follows from the operation described above; change one input at a time to understand which rule matters.
What to Notice
Pay attention to the accepted input types, the returned value and the boundary behavior. Predict what changes if you replace the example input with an empty, zero, negative or missing value, where that value is meaningful for this operation.
If the task uses a library function, inspect its documented exceptions and return type before reusing it inside a larger function.
Where You Would Use This
Use the technique when it makes a real task easier to understand or safer to maintain. Check input and output behavior with small tests before combining it with larger application code.
Practice Exercise
Annotate three functions in a small module and run Mypy or Pyright with one file at a time.
Before running your edited example, write down the result you expect. Then test at least one valid boundary or deliberately invalid value, using appropriate exception handling where necessary.
Reference: official Python documentation for the complete API contract and version notes.
Common Beginner Mistakes
- Replacing every difficult annotation with Any instead of addressing the boundary that introduced uncertainty.
- Checking only the easiest input and missing a relevant error or boundary case.
Key Takeaways
- Introduce static typing into an existing project without rewriting it all at once.
- Begin at module boundaries and stable helper functions.
- Annotate three functions in a small module and run Mypy or Pyright with one file at a time.
- Annotations guide static tools; by default they do not validate external input or change the return value at runtime.