[161]python __enter__ 與 __exit__的作用，以及與 with 語句的關系

With語句是什麼？

有一些任務，可能事先需要設定，事後做清理工作。對于這種場景，Python的with語句提供了一種非常友善的處理方式。一個很好的例子是檔案處理，你需要擷取一個檔案句柄，從檔案中讀取資料，然後關閉檔案句柄。

如果不用with語句，代碼如下：

file = open("/tmp/foo.txt")
data = file.read()
file.close()
           

這裡有兩個問題。一是可能忘記關閉檔案句柄；二是檔案讀取資料發生異常，沒有進行任何處理。下面是處理異常的加強版本：

file = open("/tmp/foo.txt")
try:
    data = file.read()
finally:
    file.close()
           

雖然這段代碼運作良好，但是太冗長了。這時候就是with一展身手的時候了。除了有更優雅的文法，with還可以很好的處理上下文環境産生的異常。下面是with版本的代碼：

with open("/tmp /foo.txt") as file:
    data = file.read()
           

with如何工作？

這看起來充滿魔法，但不僅僅是魔法，Python對with的處理還很聰明。基本思想是with所求值的對象必須有一個

__enter__()

方法，一個

__exit__()

方法。

緊跟with後面的語句被求值後，傳回對象的

__enter__()

方法被調用，這個方法的傳回值将被指派給as後面的變量。當with後面的代碼塊全部被執行完之後，将調用前面傳回對象的

__exit__()

方法。

下面例子可以具體說明with如何工作：

#!/usr/bin/env python
# with_example01.py

class Sample:
    def __enter__(self):
        print "In __enter__()"
        return "Foo"

    def __exit__(self, type, value, trace):
        print "In __exit__()"


def get_sample():
    return Sample()


with get_sample() as sample:
    print "sample:", sample
           

輸出如下

bash-3.2$ ./with_example01.py
In __enter__()
sample: Foo
In __exit__()
           

正如你看到的，

__enter__()

方法被執行

__enter__()

方法傳回的值 - 這個例子中是"Foo"，指派給變量’sample’

執行代碼塊，列印變量"sample"的值為 “Foo”

__exit__()

方法被調用

with真正強大之處是它可以處理異常。可能你已經注意到Sample類的

__exit__

方法有三個參數val,type 和 trace。 這些參數在異常進行中相當有用。我們來改一下代碼，看看具體如何工作的。

#!/usr/bin/env python
# with_example02.py


class Sample:
    def __enter__(self):
        return self

    def __exit__(self, type, value, trace):
        print "type:", type
        print "value:", value
        print "trace:", trace

    def do_something(self):
        bar = 1/0
        return bar + 10

with Sample() as sample:
    sample.do_something()
           

這個例子中，with後面的get_sample()變成了Sample()。這沒有任何關系，隻要緊跟with後面的語句所傳回的對象有

__enter__()

和

__exit__()

方法即可。此例中，Sample()的

__enter__()

方法傳回新建立的Sample對象，并指派給變量sample。

代碼執行後：

bash-3.2$ ./with_example02.py
type: <type 'exceptions.ZeroDivisionError'>
value: integer division or modulo by zero
trace: <traceback object at 0x1004a8128>
Traceback (most recent call last):
  File "./with_example02.py", line 19, in <module>
    sample.do_somet hing()
  File "./with_example02.py", line 15, in do_something
    bar = 1/0
ZeroDivisionError: integer division or modulo by zero
           

實際上，在with後面的代碼塊抛出任何異常時，

__exit__()

方法被執行。正如例子所示，異常抛出時，與之關聯的type，value和stack trace傳給

__exit__()

方法，是以抛出的ZeroDivisionError異常被列印出來了。開發庫時，清理資源，關閉檔案等等操作，都可以放在

__exit__

方法當中。

是以，Python的with語句是提供一個有效的機制，讓代碼更簡練，同時在異常産生時，清理工作更簡單。