Pythonのwith構文で使われる__enter__と__exit__について現役エンジニアが解説【初心者向け】

初心者向けにPythonのwith構文で使われる__enter__と__exit__について現役エンジニアが解説しています。with構文とはファイルを開いてcloseしなくても自動で閉じてくれる構文です。__enter__と__exit__は、リソースを確保したり、解放するような処理を独自に定義することが出来ます。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Pythonのwith構文で使われる__enter__と__exit__について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Pythonのwith構文で使われる__enter__と__exit__について詳しく説明していくね!

大石ゆかり

お願いします!

 

with構文とは

with構文とは、ファイルの読み込みが必要な際に使われます。この構文を使うことでファイルの読み込みに必要なclose処理を省略することができます。

例えばファイルを読み取る操作は以下のようになります。closeを忘れると、ファイルが開かれたままになり、コンピュータ資源の無駄遣いになります。

f = open('sample.txt')
try:
  f.read()
finally:
  f.close()

with構文を用いると、同様の操作を以下のように記述できます。closeし忘れがなくなり、コードも読みやすくなります。

with open('sample.txt') as f:
  f.read()

 

__enter__と__exit__について

上のopenは、Pythonの組み込みメソッドの例でした。クラス中で__enter__メソッド、__exit__メソッドを定義すると、with構文に対応する独自クラスを作成できます。

一般には__enter__メソッドでリソースを確保するような処理、__exit__メソッドでリソースを解放するような処理を実装します。

[PR] Pythonで挫折しない学習方法を動画で公開中

実際に書いてみよう

ソースコード

class MyWithClass:
    def __enter__(self):
        print('withブロックに入ります')

    def __exit__(self, exc_type, exc_value, traceback):
        print(exc_type, exc_value, traceback)
        print('withブロックを抜けます')

with MyWithClass() as c:
    print('withブロックを実行中です')

with MyWithClass() as c:
    raise Exception('例外が発生しました')

 

実行結果

withブロックに入ります
withブロックを実行中です
None None None
withブロックを抜けます

withブロックに入ります
 例外が発生しました 
withブロックを抜けます
Traceback (most recent call last):
  File "sample.py", line 13, in 
    raise Exception('例外が発生しました')
Exception: 例外が発生しました

 

解説

  1. MyWithClassクラスを定義し、__enter__と__exit__メソッドを定義しました
  2. 1つ目のwithブロックでは例外は発生しないので、exc_type, exc_value, tracebackは全てNoneになりました
  3. 2つ目のwithブロックでは例外が発生したので、例外クラス、例外メッセージ、トレースバック情報などが設定されました

 

まとめ

この記事ではwith構文の使い方を紹介しました。またwith構文に対応する独自クラスを定義する方法を紹介しました。

監修してくれたメンター

橋本紘希(はしもとひろき)

システムインテグレータ企業勤務のシステムエンジニア。

開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間で、Pythonを使った人工知能(AI)や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。