python中with用法及原理

资源的管理在程序的设计上是一个很常见的问题,例如管理档案,开启的网络socket与各种锁定(locks)等.最主要的问题在于我们必须确保这些开启的资源在使用之后能够关闭(或释放),若忘记关闭这些资源,就会造成程序执行上的效能问题,严重的还会导致错误.除了关闭之外,一些特殊的资源上的管理要求在使用完毕后,还需要进行后续的清理工作,这些也是在资源管理上注意的.

python语言则提供了这么一种机制的语法操作,就是with.利用with,python的程序可以自动进行资源的建立,清理和回收动作,让程序设计者可以更加方便的使用各种资源.

若不使用with语句,代码如下:

file = open("filename")
data = file.read()
file.close

但是以上代码存在两个问题:

• 一是可能忘记关闭文件的句柄
• 二是文件读取数据时若发生异常,造成程式提早离开,打开的资源就无法关闭

所以较好的程序写法是下面的加强版本,try...,finally...

try:
    # 打开文件
    f = open("filename")
except:
    print('fail to open')
    exit(-1)
try:
    do something
except:
    do something
finally:
    f.close() 

这种方法虽然代码运行良好,但是缺点就是过于冗长,切try与finally之间需要手动写入代码,不是很方便,也容易忘记.

这种情况下,我们就可以使用with的这种写法:

# 以with打开文档,并写入Hello, python!
with open("filename", 'w') as f:
    f.write('Hello, python!')

with如何工作?

• 紧跟with后面的语句被求值后,返回对象的'__enter__()'方法被调用,这个方法的返回值将被赋值给as后面的变量.
• 当with后面的代码块全部执行完之后,将被调用前面返回对象的__exit__()方法.

代码示例1:

#/usr/bin/python
# -*- coding: utf-8 -*-
# 自定义 Context Manager
class File(object):
  def __init__(self, filename, mode):
    # 设定文本名与打开方式
    self.filename = filename
    self.mode = mode

  # 资源配置
  def __enter__(self):
    print("打开文本：" + self.filename)
    self.open_file = open(self.filename, self.mode)
    return self.open_file

  # 资源回收（关闭文本）
  def __exit__(self, type, value, trace):
    print("关闭文本：" + self.filename)
    self.open_file.close()

使用方式:

with file open("filename", 'w') as f:
    print("写入文本...")
    f.write("Hello, world!")

打开文本：filename
写入文本...
关闭文本：filename

代码示例2:

#!/usr/bin/env python3
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。

代码执行后:

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语句是提供一个有效的机制，让代码更简练，同时在异常产生时，清理工作更简单。