Pythonのcontextlib徹底解説：with文によるコンテキスト管理の基本と実践

contextlibモジュールとは

Pythonの標準ライブラリ「contextlib」は、プログラム内のリソースを適切に管理するためのコンテキストマネージャ（ContextManager）関連のユーティリティを提供するモジュールです。Pythonにはコンテキストマネージャと連携して動作するwith文が用意されており、これを活用することでリソースの取得と解放を安全かつ簡潔に記述できます。

代表的な例がファイル操作です。組み込み関数open()が返すファイルオブジェクトはコンテキストマネージャAPIをサポートしているため、ファイルを扱う際にはwith文がよく使われます。

従来の書き方との比較

まず、従来の方法でファイルを開いてデータを書き込むコードを見てみましょう。処理が終わったら必ずclose()メソッドを呼び出してファイルを閉じる必要があります。これを忘れるとファイルディスクリプタがリークし、最悪の場合データ破損などの問題につながります。

f = open("file.txt", "w")
f.write("hello world")
f.close()

一方、with文を使えば同じ処理を次のように書けます。

with open("file.txt", "w") as f:
    f.write("hello world")
print("file is closed")

ファイルオブジェクトはコンテキストマネージャを実装しているため、with文で利用できます。withブロック内には対象オブジェクトへの処理を記述し、ブロックを抜けると同時にファイルは自動的にクローズされます。つまり、close()メソッドを明示的に呼び出す必要はありません。withブロックに入ったオブジェクトはブロック内でのみ有効であり、ブロック終了とともに即座に解放されます。

コンテキストマネージャの仕組み：__enter__()と__exit__()

コンテキストマネージャクラスには、次の2つの重要なメソッドが定義されています。

• __enter__() — withブロックが開始されるときに呼び出されます。このオブジェクトに関連付けられたランタイムコンテキストにプログラムが入ったことを示します。
• __exit__() — withブロックが終了するときに呼び出されます。ランタイムコンテキストからプログラムが抜けることを示します。

ファイルオブジェクトもこの2つのメソッドを持っています。以下のインタプリタセッションで確認できます。

>>> f = open("file.txt", "w")
>>> f.__enter__()
<_io.TextIOWrapper name='file.txt' mode='w' encoding='cp1252'>
>>> f.write("hello world")
11
>>> f.__exit__()
>>> f.write("hello world")
Traceback (most recent call last):
  File "<pyshell#10>", line 1, in <module>
    f.write("hello world")
ValueError: I/O operation on closed file.

__exit__()メソッドが呼び出された時点でファイルは閉じられます。そのため、クローズ後のファイルに書き込もうとするとValueErrorが発生します。

独自のコンテキストマネージャクラスを作る

より一般的な使い方として、__enter__()と__exit__()を持つ独自クラスを定義し、そのオブジェクトをwith文で使う例を紹介します。

import contextlib

class WithExample:
    def __init__(self):
        print("object initialized")
    def __enter__(self):
        print("entered context")
    def __exit__(self, *args):
        print("exited context")

with WithExample() as w:
    print('this is a contextlib example')
    print('used by with statement')
print('end of with block')

実行結果を見ると、withブロックが始まるとすぐに__enter__()メソッドが実行され、続いてブロック内の処理が行われ、ブロックが終わると自動的に__exit__()メソッドが呼び出されていることが分かります。

object initialized
entered context
this is a contextlib example
used by with statement
exited context
end of with block

@contextmanagerデコレータでさらに簡潔に

contextlibモジュールには@contextmanagerデコレータが用意されています。これを使うと、ジェネレータベースのファクトリ関数を定義するだけで、with文をサポートするコンテキストマネージャを作成できます。ファイルオブジェクトのコンテキスト管理をデコレータで実装すると、次のようになります。

from contextlib import contextmanager

@contextmanager
def openfile(name):
    try:
        f = open(name, 'w')
        yield f
    finally:
        f.close()

with openfile('file.txt') as f:
    f.write('hello world')
print('file is closed')

yieldの前までが__enter__()に相当する処理、yield以降（finallyブロック）が__exit__()に相当する処理として実行されるため、クラスを定義するよりも少ないコード量で同等の機能を実現できます。

まとめ

コンテキストマネージャは、ファイルやネットワーク接続、ロックなどのリソースを確実かつ効率的に管理できる、Pythonの非常に有用な機能です。with文とcontextlibモジュールを活用することで、リソースリークを防ぎ、読みやすく堅牢なコードを書くことができます。