Python with as的用法

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如何工作：

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

運行代碼，輸出如下：

In __enter__()
sample: Foo
In __exit__()

正如你看到的：

1. __enter__()方法被執行
2. __enter__()方法返回的值 - 這個例子中是"Foo"，賦值給變量'sample'
3. 執行代碼塊，打印變量'sample'，的值為"Foo"
4. __exit__()方法被調用

with真正的強大之處是它可以處理異常。可能你已經注意到Sample類的__exit__方法有三個參數-val，type 和 trace。這些參數在異常處理中相當有用。我們來改一下代碼，看看具體如何工作。

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__()方法中。

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