with 语句使用

with 语句的原理

• 上下文管理协议(Context Management Protocol)：包含有方法__enter__和方法__exit__，支持该协议的对象要实现这两个方法。
• 上下文管理器(Context Manager)：支持上下文刮玻璃协议的对象，这种对象实现了__enter__()和__exit__()方法。上下文管理器定义执行with语句的时候要建立的运行时上下文，负责执行with语句块上下文中的进入与退出的操作。通常使用with语句调用上下文管理器，也可以通过直接调用其中的方法来使用。

with语句的结构如下所示

with experssion as var:
    block sentence

其中expresion可以是任意表达式, as var是可选的，其一般的执行过程如下所示

1. 执行expression,生成上下文管理器context_manager;
2. 获取上下文管理的__exit__()方法,并保存起来用于之后的调用;
3. 调用上下文管理器的__enter__()方法,如果使用了as子句,则将__enter__()方法的返回值赋值给as子句中的var;
4. 执行block sentence中的表达式;
5. 不管是否执行过程中发生了异常,执行上下文管理器的__exit__()方法,__exit__()方法负责执行“清理”工作,例如释放资源等等。如果执行过程中没有发生异常，或者是语句体中执行行了break/continue/return,则以None作为参数调用__exit__();如果执行过程中出现异常事件,则使用sys.exc_info得到的异常信息作为参数调用__exit__(exc_type,exc_value,exc_traceback);
6. 出现异常的时候,如果__exit__(type,value,tracback)返回False,则会重新抛出异常,让with之外的语句逻辑来处理异常,这也是通用的做法;如果返回True,则忽略异常事件,不再对异常进行处理。

自定义上下文管理器

Python的with语句是提供一个有效的机制,让代码更加简练，同时在异常产生时候，清理工作更简单。

class DBManager(object):
    def __init__(self):
      pass
    def __enter__(self):
      print('__enter__ processed !')
      return self
    def __exit__(self):
      print('__exit__ processed!')
      return True
def build_instance():
    # 工厂方法
    return DBManager()
with build_instance() as dbmanager:
    print('with sentence')

注意：with后面必须跟上一个上下文管理器,如果使用了as,则是把上下文管理器的__enter__()方法的返回值赋值给target,target可以是单个变量,或者由”()”括起来的元组(不能是仅仅由”,”分隔的变量列表,必须加上”()”)

实际上就是,当我们使用__enter__()方法被调用,并且将返回值赋值给as后面的变量,并且在退出with的时候自动执行__exit__()方法。

总结

一般自定义上下文管理器来对软件系统的资源进行管理,例如有数据库连接、或者是共享资源的访问控制等等。