理解Python的With语句

曾经终败给现在 2022-08-21 04:49 166阅读 0赞

Python’s with statement provides a very convenient way of dealing with the situation where you have to do a setup and teardown to make something happen. A very good example for this is the situation where you want to gain a handler to a file, read data from the file and the close the file handler.  
有一些任务，可能事先需要设置，事后做清理工作。对于这种场景，Python的with语句提供了一种非常方便的处理方式。一个很好的例子是文件处理，你需要获取一个文件句柄，从文件中读取数据，然后关闭文件句柄。

Without the with statement, one would write something along the lines of:  
如果不用with语句，代码如下：

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

There are two annoying things here. First, you end up forgetting to close the file handler. The second is how to handle exceptions that may occur once the file handler has been obtained. One could write something like this to get around this:  
这里有两个问题。一是可能忘记关闭文件句柄；二是文件读取数据发生异常，没有进行任何处理。下面是处理异常的加强版本：

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

While this works well, it is unnecessarily verbose. This is where with is useful. The good thing about with apart from the better syntax is that it is very good handling exceptions. The above code would look like this, when using with:  
虽然这段代码运行良好，但是太冗长了。这时候就是with一展身手的时候了。除了有更优雅的语法，with还可以很好的处理上下文环境产生的异常。下面是with版本的代码：

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

**with如何工作？**

while this might look like magic, the way Python handles with is more clever than magic. The basic idea is that the statement after with has to evaluate an object that responds to an **enter**() as well as an **exit**() function.  
这看起来充满魔法，但不仅仅是魔法，Python对with的处理还很聪明。基本思想是with所求值的对象必须有一个**enter**()方法，一个**exit**()方法。

After the statement that follows with is evaluated, the **enter**() function on the resulting object is called. The value returned by this function is assigned to the variable following as. After every statement in the block is evaluated, the **exit**() function is called.  
紧跟with后面的语句被求值后，返回对象的**enter**()方法被调用，这个方法的返回值将被赋值给as后面的变量。当with后面的代码块全部被执行完之后，将调用前面返回对象的**exit**()方法。

This can be demonstrated with the following example:  
下面例子可以具体说明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:”,mplen executed, this will result in:  
运行代码，输出如下

bash-3.2$  
./with\_example01.py  
In  
**enter**()  
sample:  
Foo  
In  
**exit**()

As you can see,  
The **enter**() function is executed  
The value returned by it - in this case “Foo” is assigned to sample  
The body of the block is executed, thereby printing the value of sample ie. “Foo”  
The **exit**() function is called.  
What makes with really powerful is the fact that it can handle exceptions. You would have noticed that the **exit**() function for Sample takes three arguments - val, type and trace. These are useful in exception handling. Let’s see how this works by modifying the above example.  
正如你看到的，  
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() Notice how in this example, instead of get\_sample(), with takes Sample(). It does not matter, as long as the statement that follows with evaluates to an object that has an **enter**() and **exit**() functions. In this case, Sample()’s **enter**() returns the newly created instance of Sample and that is what gets passed to sample.  
这个例子中，with后面的get\_sample()变成了Sample()。这没有任何关系，只要紧跟with后面的语句所返回的对象有**enter**()和**exit**()方法即可。此例中，Sample()的**enter**()方法返回新创建的Sample对象，并赋值给变量sample。

When executed:  
代码执行后：

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

Essentially, if there are exceptions being thrown from anywhere inside the block, the **exit**() function for the object is called. As you can see, the type, value and the stack trace associated with the exception thrown is passed to this function. In this case, you can see that there was a ZeroDivisionError exception being thrown. People implementing libraries can write code that clean up resources, close files etc. in their **exit**() functions.  
实际上，在with后面的代码块抛出任何异常时，**exit**()方法被执行。正如例子所示，异常抛出时，与之关联的type，value和stack trace传给**exit**()方法，因此抛出的ZeroDivisionError异常被打印出来了。开发库时，清理资源，关闭文件等等操作，都可以放在**exit**方法当中。

Thus, Python’s with is a nifty construct that makes code a little less verbose and makes cleaning up during exceptions a bit easier.  
因此，Python的with语句是提供一个有效的机制，让代码更简练，同时在异常产生时，清理工作更简单。

I have put the code examples given here on Github.  
示例代码可以在Github上面找到。

译注：本文原文见Understanding Python’s “With” Statement