Pythonのコンテキストマネージャ

目次

概要

• Pythonにはコンテキストマネージャというものがあります。
• これは一般的にはリソースの開閉(open、close)を伴う処理で、開き忘れや閉じ忘れがないようサポートしてくれる機能になります。
• JavaでいうところのAutoCloseableみたいなものです。
• 定義するにはクラスを定義する際に、__enter__メソッドと__exit__メソッドを実装します。
• コンテキストマネージャが生成されるとき、__enter__が呼ばれ、withブロックで定義されたコンテキストから抜けるときに__exit__メソッドが呼ばれます。
• 裏で例外処理try-except-finallyを利用しており、コンテキストから抜けるときに__exit__メソッドが確実に呼ばれます。

実装方法

• 基本的には、__enter__メソッドと、__exit__メソッドを定義するだけです。
• __exit__メソッドのexc_type, exc_value, tracebackは、コンテキスト内で例外が発生した場合に渡されます。
  • 例外が発生していないときはNoneです。
• __enter__メソッドでreturnしているselfが、withブロックでasとして受け取った変数となります。

class MyContextManager:
    def __enter__(self):
        print('1 ENTER!')
        return self

    def __exit__(self, exc_type, exc_value, traceback):
        print('4 EXIT!')

    def foo(self):
        print('3 FOO!')

# テストプログラム
with MyContextManager() as cm:
    print('2 ** hello **')
    cm.foo()

1 ENTER!
2 ** hello **
3 FOO!
4 EXIT!

参考

参考サイト

• (Python入門) Python のコンテキストマネージャと with ブロック