python 研究-with as 用法

5月 15, 2016

With語句是什麼?

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

如果不用with語句，程式碼如下：

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

這裡有兩個問題:

    一是可能忘記關閉文件句柄；
    二是文件讀取資料發生異常，沒有進行任何處理。

下面是處理異常的加強版本：

    try:
        f = open('xxx')
    except:
        print 'fail to open'
        exit(-1)
    try:
        do something
    except:
        do something
    finally:
         f.close()

雖然這段程式碼執行良好，但是太冗長了。

這時候就是with一展身手的時候了。除了有更優雅的語法，with還可以很好的處理上下文環境產生的異常。

下面是with版本的程式碼：

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

with如何工作?

    緊跟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__()

正如你看到的: 1. __enter__()方法被執行 2. __enter__()方法返回的值 - 這個例子中是」Foo」，賦值給變數』sample' 3. 執行程式碼塊，列印變數」sample」的值為「Foo」 4. __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_something()
      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__ 方法當中。

另外，__exit__ 除了用於tear things down，還可以進行異常的監控和處理，注意後幾個參數。要跳過一個異常，只需要返回該函數True即可。

下面的樣例程式碼跳過了所有的TypeError，而讓其他異常正常拋出。

    def __exit__(self, type, value, traceback):
        return isinstance(value, TypeError)

上文說了 __exit__ 函數可以進行部分異常的處理，如果我們不在這個函數中處理異常，他會正常拋出，這時候我們可以這樣寫（python 2.7及以上版本，之前的版本參考使用contextlib.nested這個庫函數）：

    try:
        with open( "a.txt" ) as f :
            do something
    except xxxError:
        do something about exception

總之，with-as表達式極大的簡化了每次寫finally的工作，這對保持程式碼的優雅性是有極大幫助的。

如果有多個項，我們可以這麼寫：

    with open("x.txt") as f1, open('xxx.txt') as f2:
        do something with f1,f2

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