Python中的with语句与上下文管理器学习总结

0、关于上下文管理器
上下文管理器是可以在with语句中使用，拥有enter和exit方法的对象。

    with manager as var:
      do_something(var)

相当于以下情况的简化：

    var = manager.__enter__()
    try:
      do_something(var)
    finally:
      manager.__exit__()

换言之，PEP 343中定义的上下文管理器协议允许将无聊的try...except...finally结构抽象到一个单独的类中，仅仅留下关注的do_something部分。

enter方法首先被调用。它可以返回赋给var的值。as部分是可选的：如果它不出现，enter的返回值简单地被忽略。
with语句下的代码被执行。就像try子句，它们或者成功执行到底，或者break，continue或return，或者可以抛出异常。无论哪种情况，该块结束后，exit方法被调用。如果抛出异常，异常信息被传递给exit，这将在下一章节讨论。通常情况下，异常可被忽略，就像在finally子句中一样，并且将在exit结束后重新抛出。
比如说我们想确认一个文件在完成写操作之后被立即关闭：

    >>> class closing(object):
    ...  def __init__(self, obj):
    ...   self.obj = obj
    ...  def __enter__(self):
    ...   return self.obj
    ...  def __exit__(self, *args):
    ...   self.obj.close()
    >>> with closing(open('/tmp/file', 'w')) as f:
    ...  f.write('the contents\n')

这里我们确保了当with块退出时调用了f.close()。因为关闭文件是非常常见的操作，该支持已经出现在file类之中。它有一个exit方法调用close，并且本身可作为上下文管理器。

    >>> with open('/tmp/file', 'a') as f:
    ...  f.write('more contents\n')

try...finally常见的用法是释放资源。各种不同的情况实现相似：在enter阶段资源被获得，在exit阶段释放，如果抛出异常也被传递。正如文件操作，往往这是对象使用后的自然操作，内置支持使之很方便。每一个版本，Python都在更多的地方提供支持。

1、如何使用上下文管理器：

如何打开一个文件，并写入"hello world"

    filename="my.txt"
    mode="w"
    writer=open(filename,mode)
    writer.write("hello world")
    writer.close()

当发生异常时（如磁盘写满），就没有机会执行第5行。当然，我们可以采用try-finally语句块进行包装：

    writer=open(filename,mode)
    try:
      writer.write("hello world")
    finally:
      writer.close()

当我们进行复杂的操作时，try-finally语句就会变得丑陋，采用with语句重写：

    with open(filename,mode) as writer:
      writer.write("hello world")

as指代了从open()函数返回的内容，并把它赋给了新值。with完成了try-finally的任务。

2、自定义上下文管理器

with语句的作用类似于try-finally，提供一种上下文机制。要应用with语句的类，其内部必须提供两个内置函数enter和exit。前者在主体代码执行前执行，后者在主体代码执行后执行。as后面的变量，是在enter函数中返回的。

    class echo():
      def output(self):
        print "hello world"
      def __enter__(self):
        print "enter"
        return self #可以返回任何希望返回的东西
      def __exit__(self,exception_type,value,trackback):
        print "exit"
        if exception_type==ValueError:
          return True
        else:
          return Flase

    >>>with echo as e:
      e.output()

输出：

    enter
    hello world
    exit

完备的exit函数如下：

    def __exit__(self,exc_type,exc_value,exc_tb)

其中，exc_type:异常类型；exc_value:异常值；exc_tb:异常追踪信息

当exit返回True时，异常不传播

3、contextlib模块

contextlib模块的作用是提供更易用的上下文管理器，它是通过Generator实现的。contextlib中的contextmanager作为装饰器来提供一种针对函数级别的上下文管理机制，常用框架如下：

    from contextlib import contextmanager
    @contextmanager
    def make_context():
      print 'enter'
      try:
        yield "ok"
      except RuntimeError,err:
        print 'error',err
      finally:
        print 'exit'

    >>>with make_context() as value:
      print value

输出为：

      enter
      ok
      exit

其中，yield写入try-finally中是为了保证异常安全（能处理异常）as后的变量的值是由yield返回。yield前面的语句可看作代码块执行前操作，yield之后的操作可以看作在exit函数中的操作。

以线程锁为例：

    @contextlib.contextmanager
    def loudLock():
      print 'Locking'
      lock.acquire()
      yield
      print 'Releasing'
      lock.release()

    with loudLock():
      print 'Lock is locked: %s' % lock.locked()
      print 'Doing something that needs locking'

    #Output:
    #Locking
    #Lock is locked: True
    #Doing something that needs locking
    #Releasing

4、contextlib.nested:减少嵌套

对于：

    with open(filename,mode) as reader:
      with open(filename1,mode1) as writer:
        writer.write(reader.read())

可以通过contextlib.nested进行简化：

    with contextlib.nested(open(filename,mode),open(filename1,mode1)) as (reader,writer):
      writer.write(reader.read())

在python 2.7及以后，被一种新的语法取代：

    with open(filename,mode) as reader,open(filename1,mode1) as writer:
      writer.write(reader.read())

5、contextlib.closing()

file类直接支持上下文管理器API，但有些表示打开句柄的对象并不支持，如urllib.urlopen()返回的对象。还有些遗留类，使用close()方法而不支持上下文管理器API。为了确保关闭句柄，需要使用closing()为它创建一个上下文管理器（调用类的close方法）。

    import contextlib
    class myclass():
      def __init__(self):
        print '__init__'
      def close(self):
        print 'close()'

    with contextlib.closing(myclass()):
      print 'ok'

输出：

    __init__
    ok
    close()