How to Implement __enter__ and __exit__ in Python: Context Managers

To implement __enter__ and __exit__ in Python, define these methods inside a class to manage setup and cleanup actions when using the with statement. __enter__ runs at the start of the block and returns the resource, while __exit__ runs at the end to handle cleanup and exceptions.

Syntax

The __enter__ method is called when the with block starts and should return the resource to use. The __exit__ method is called when the block ends and handles cleanup. It receives exception details if any occurred inside the block.

• __enter__(self): Setup code, returns resource.
• __exit__(self, exc_type, exc_value, traceback): Cleanup code, handles exceptions.

python

class MyContext:
    def __enter__(self):
        # Setup actions
        return self

    def __exit__(self, exc_type, exc_value, traceback):
        # Cleanup actions
        pass

Example

This example shows a simple context manager that prints messages when entering and exiting the with block. It also handles exceptions by printing them.

python

class ManagedFile:
    def __init__(self, filename):
        self.filename = filename

    def __enter__(self):
        print(f"Opening file {self.filename}")
        self.file = open(self.filename, 'r')
        return self.file

    def __exit__(self, exc_type, exc_value, traceback):
        print(f"Closing file {self.filename}")
        self.file.close()
        if exc_type:
            print(f"Exception caught: {exc_value}")
        return True  # Suppress exception if any

with ManagedFile('test.txt') as f:
    content = f.read()
    print(content)

Output

Opening file test.txt
Hello, world!
Closing file test.txt

Common Pitfalls

• Not returning the resource in __enter__ causes as variable to be None.
• Forgetting to close or clean up resources in __exit__ can cause leaks.
• Not handling exceptions properly in __exit__ may cause unexpected crashes.
• Returning False or None from __exit__ re-raises exceptions; returning True suppresses them.

python

class BadContext:
    def __enter__(self):
        # Forgot to return resource
        print("Entering")

    def __exit__(self, exc_type, exc_value, traceback):
        print("Exiting")
        # Forgot to close resource

with BadContext() as resource:
    print(resource)  # Prints None


class GoodContext:
    def __enter__(self):
        print("Entering")
        return "resource"

    def __exit__(self, exc_type, exc_value, traceback):
        print("Exiting")

with GoodContext() as resource:
    print(resource)  # Prints 'resource'

Output

Entering
None
Exiting
Entering
resource
Exiting

Quick Reference

Method	Purpose	Parameters	Return Value
__enter__(self)	Setup resource	None	Resource to use in with block
__exit__(self, exc_type, exc_value, traceback)	Cleanup and handle exceptions	Exception info or None	True to suppress exception, False or None to propagate

Key Takeaways

Implement __enter__ to set up and return the resource for the with block.

Implement __exit__ to clean up resources and optionally handle exceptions.

Return True from __exit__ to suppress exceptions, or False/None to propagate them.

Always return the resource in __enter__ to avoid None in the with statement.

Use context managers to safely manage resources like files or connections.