Self means the type of the current instance, including subclasses.
What It Does and Why It Matters
Self means the type of the current instance, including subclasses. It is particularly useful for fluent methods returning self without introducing a manually bound TypeVar.
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.
from typing import Self
class MessageBuilder:
def __init__(self) -> None:
self.parts: list[str] = []
def add(self, part: str) -> Self:
self.parts.append(part)
return self
print(MessageBuilder().add('hello').add('world').parts)How the Code Works
- The imports make these standard-library tools available: typing.
- The definition of MessageBuilder 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.
- The annotations describe intended types for editors and checkers. They are not a replacement for validating input values when the function runs.
Expected output:
['hello', 'world']For the demonstrated inputs, Python displays "['hello', 'world']". 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
This helps maintain larger projects where functions and data shapes cross module boundaries. Check the code with a static analyzer, and still validate data received from files, users or remote APIs. Annotation constructs do not normally enforce types automatically at runtime.
Practice Exercise
Annotate a fluent configuration method that returns the same instance.
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
- Annotating a method as returning Self when it actually creates an unrelated object.
- Assuming a type checker has checked values received dynamically from an untrusted source.
Key Takeaways
- Self means the type of the current instance, including subclasses.
- Annotate a fluent configuration method that returns the same instance.
- Annotations guide static tools; by default they do not validate external input or change the return value at runtime.