with tempfile.TemporaryDirectory() as dirpath: のdirpathの役割がわからない

Question

import os
import tempfile
with tempfile.TemporaryDirectory() as dirpath:
  with open(os.path.join(dirpath,'file1'),mode='w',encoding='utf-8') as f1, \
       open(os.path.join(dirpath, 'file2'), mode='w', encoding='utf-8') as f2:
         print(dirpath)
         f1.write("file1")
         f2.write("file2")

という一時ディレクトリを作ってその一時ディレクトリにファイルを作って書き込むコードがあります。

with tempfile.TemporaryDirectory() as dirpath:

でわざわざwith構文を使って一時ディレクトリの変数dirpathを作っている理由がわかりません。

dirpath = tempfile.TemporaryDirectory()
with open(os.path.join(dirpath,'file1'),mode='w',encoding='utf-8') as f1, \

でいいのではないかと思います。なぜwith構文を使っているのでしょうか？このwith構文を抜けた時、一時ディレクトリを消す役割をwith構文は持っているのでしょうか？

Answer 1

適切なインターフェースさえあれば、with構文は自由に使うことが出来ます。

class MyContext:
    def say(self):
        print('spam')

    def __enter__(self):
        print('enter')
        return self

    def __exit__(self, exc_type, exc_value, traceback):
        print('exit')

with MyContext() as m_c:
    m_c.say()

"""実行結果
enter
spam
exit
"""

tempfile.TemporaryDirectoryでは、
enter処理／exit処理にそれぞれディレクトリの生成／破棄が割り当てられているようです。

Comments

[退会済みユーザー]

ありがとうございます。http://www.python-izm.com/contents/application/context_manager.shtml　の一番上の特殊メソッドを実装するのところで、
with ContextManagerTest():
　　print 'with'
と書いてあって、今回のサンプルコードではなぜasを使われたのでしょうか？

[退会済みユーザー]

as xxx とすることで、xxxはそのコンテキストマネージャのメソッドにアクセスできるのでしょうか？

[LouiS0616]

asを使ったのは、ご提示のコードと単に見た目を似せるためです。

asを使うことで、__enter__の戻り値を取得することが出来ます。
私が提示した例の場合、withブロック内でsayを呼び出さないならば、as m_cの部分は不要です。

[退会済みユーザー]

なるほど。def __enter__(self)が呼び出されselfが返され、そのselfがdef say(self):に渡されるところまでは理解できるのですが、def __exit__でもselfの引数を必要としていますが、def sayではselfをreturnしていなくなぜそれでもexitが呼び出されるのでしょうか？

[LouiS0616]

sayがselfを返していないことは、この場合関係ありません。

with文から脱出する際に__exit__が呼び出されます。
明示的に呼び出すのに対して、例外発生時にも確実に呼び出される点が利点です。
実際、__exit__の第二引数以降は、例外などの情報が格納されます。

[退会済みユーザー]

では、なぜdef __enter__だけselfを返しているのでしょうか？def __enter__だけreturnしている意味ってあるのでしょうか？

[LouiS0616]

as を用いる場合は、__enter__が適当な値を戻す必要があります。
例外周りの挙動は異なりますが、次のように書いているのとほぼ同じです。
manager = MyContext()
m_c = manager.__enter__()
m_c.say()
manager.__exit__(None, None, None)

asを用いない場合はこんな感じ。
manager = MyContext()
manager.__enter__()
何らかの処理
manager.__exit__(None, None, None)

註：__exit__にNoneを渡しているのは、単に引数の個数を合わせるためです。

[退会済みユーザー]

なるほど、ありがとうございます！

Answer 2

自分が中途半端な解説を書くよりは

https://docs.python.jp/3/reference/compound_stmts.html#with

をまず読んでいただくのが一番かと思います。大事な点はwith openなどと書くとwithのブロックを抜けたときに自動的にopenが規定する終了処理(close)が呼ばれることだと思います。これによりコードが煩雑にならずにすみますし後始末を確実に行えるという安心感がありますね。

一時ディレクトリを消す

https://docs.python.jp/3/library/tempfile.html#module-tempfile

これもリファレンスを見た方が正確にわかると思います。Linuxでは少なくともwithブロックから抜けてdirpathが有効なスコープから抜けたら一時ファイル・ディレクトリーは自動的に消えるみたいですね。