python的with語句，超級強大

marsggbo發表於2017-03-26
Python

With語句是什麼？


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

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

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


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

1
2
3
4
5
file = open("/tmp/foo.txt")
try:
    data = file.read()
finally:
    file.close()


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

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

with如何工作？

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

緊跟with後面的語句被求值後，返回物件的__enter__()方法被呼叫，這個方法的返回值將被賦值給as後面的變數。當with後面的程式碼塊全部被執行完之後，將呼叫前面返回物件的__exit__()方法。

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
#!/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

執行程式碼，輸出如下

1
2
3
4
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。 這些引數在異常處理中相當有用。我們來改一下程式碼，看看具體如何工作的。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
#!/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。

程式碼執行後：

1
2
3
4
5
6
7
8
9
10
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語句是提供一個有效的機制，讓程式碼更簡練，同時在異常產生時，清理工作更簡單。

示例程式碼可以在Github上面找到。

（轉）


相關文章