Cleanup inside __exit__ or a generator context manager finally block runs during normal completion and most exceptions.
What It Does and Why It Matters
Cleanup inside __exit__ or a generator context manager finally block runs during normal completion and most exceptions. Returning a truthy __exit__ value or suppressing an exception changes whether it propagates.
Correct cleanup means resources are released when exceptions occur, not only on the success path.
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 contextlib import contextmanager
@contextmanager
def protected_resource():
try:
yield 'ready'
finally:
print('Cleanup executed')
try:
with protected_resource():
raise ValueError('sample failure')
except ValueError as error:
print(error)
How the Code Works
- The imports make these standard-library tools available: contextlib.
- The definition of protected_resource creates reusable behavior; its body runs only when called or instantiated as appropriate.
- The structured block controls error handling or resource lifetime, including what happens when an operation fails.
- The print calls display the results. Compare these results with the method’s documented return type and the input used.
Expected output:
Cleanup executed
sample failure
Each displayed line comes from the corresponding calculation or check. The output helps verify the return values before you adapt the example to your own input.
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 matters when working with files, locks, sockets and connections whose lifetime must be controlled. A reliable implementation defines ownership and releases resources on both successful and exceptional paths. Use a small with block before building a more complex manager.
Practice Exercise
Raise an exception inside a context manager and show that cleanup still runs.
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
- Catching an error during cleanup and hiding the original failure or incorrectly suppressing every exception.
- Releasing the resource only on the successful path rather than when an exception interrupts the block.
Key Takeaways
- Cleanup inside __exit__ or a generator context manager finally block runs during normal completion and most exceptions.
- Raise an exception inside a context manager and show that cleanup still runs.
- Correct cleanup means resources are released when exceptions occur, not only on the success path.