笔记-python的with用法

一、With语句是什么？

在编程中，有些任务需要在执行前进行设置，并在完成后进行清理。针对这种情况，Python的with语句提供了一种非常方便的处理方式。一个典型的例子是文件处理：需要打开一个文件句柄，从中读取数据，然后关闭文件句柄。

如果不使用with语句，代码可能如下：

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

这里存在两个问题：

1. 可能会忘记关闭文件句柄；
2. 如果读取数据时发生异常，没有进行处理。

处理异常的改进版本如下：

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

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, traceback):
        print("type:", type)
        print("value:", value)
        print("trace:", traceback)
    def do_something(self):
        bar = 1/0  # Intentional error for demonstration
        return bar + 10

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

这个例子中，with后面的get_sample()变成了Sample()。这没有关系，只要紧跟with后面的语句所返回的对象有__enter__()和__exit__()方法即可。在此例中，Sample()的__enter__()方法返回新创建的Sample对象，并赋给变量sample。

执行上述代码后：

type: <type 'exceptions.ZeroDivisionError'>
value: integer division or modulo by zero
trace: ... (traceback details omitted for brevity)

实际上，当with后的代码块抛出任何异常时，__exit__()方法都会被执行。正如例子所示，异常抛出时，与之关联的类型、值和堆栈跟踪传给__exit__()方法，因此抛出的ZeroDivisionError异常被打印出来。开发库时，清理资源、关闭文件等操作都可以放在__exit__()方法中。

此外，__exit__()除了用于清理工作外，还可用于监控和处理异常。注意其后面的几个参数。要跳过一个异常，只需让该函数返回True即可。

下面的样例代码跳过了所有的TypeError，而让其他异常正常抛出。

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

总之，with-as表达式极大地简化了每次编写finally的工作，这对保持代码的优雅性非常有帮助。
如果有多个项，我们可以这样写：

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

因此，Python的with语句提供了一个有效的机制，使代码更简洁，同时在产生异常时，清理工作变得更简单。