Python3中with用法

Posted 2021-09-07 fengbingchun

      Python中的with语句用于用上下文管理器(context manager)定义的方法包装块的执行，它允许将常见的try…except…finally使用模式封装起来以方便重用。

      在Python中，在处理非托管资源(unmanaged resources)(如文件流)时使用with关键字。它允许确保你在使用资源的代码完成运行时”清理”资源，即使抛出异常也是如此。它为try/finally块提供”语法糖”(syntactic sugar)。

      with语句适用于对资源进行访问的场合，确保不管使用过程中是否发生异常都会执行必要的”清理”操作，释放资源，比如文件使用后自动关闭、线程中锁的自动获取和释放等。

      要在用户定义的对象中使用with语句，你只需在对象方法中添加__enter__()和__exit__()方法。

      with语法：

with EXPRESSION [as TARGET]:
    SUITE

      with语句执行过程如下：

      (1).评估上下文表达式以获得上下文管理器；

      (2).上下文管理器的__enter__()被加载以备后用；

      (3).上下文管理器的__exit__()被加载以备后用；

      (4).上下文管理器的__enter__()方法被调用；

      (5).如果TARGET包含在with语句中，则将__enter__()的返回值赋值给它。with语句保证如果__enter__()方法没有错误返回，那么__exit__()将始终被调用。因此，如果在赋值给TARGET列表的过程中发生错误，它将被视为SUITE中发生的错误。__enter__()方法是可以带返回值的，默认返回None。

      (6).SUITE被执行；

      (7).上下文管理器的__exit__()方法被调用。如果异常导致SUITE退出，则其类型、值和回溯(traceback)将作为参数传递给__exit__()；否则，传递3个None。__exit__()方法也是可以带返回值的，这个返回值应该是一个布尔类型True或False，默认为None(即False)。如果为False，异常会被抛出，用户需要进行异常处理。如果为True，则表示忽略该异常。

      如果SUITE因异常退出，并且__exit__()方法返回的值为False，则触发异常。如果返回值为True，则异常被抑制，并继续执行with语句之后的语句。

      如果SUITE因异常以外的任何原因退出，则__exit__()的返回值将被忽略，并在所采取的退出类型的正常位置继续执行。

      以上内容主要翻译于：https://docs.python.org/3/reference/compound_stmts.html#the-with-statement

      以下为测试代码：

class FileWriter(object):
    def __init__(self, file_name):
        print("run __init__")
        self.file_name = file_name

    def __enter__(self):
        print("run __enter__")
        self.file = open(self.file_name, 'w')
        return self.file

    def __exit__(self, type, value, traceback):
        print("run __exit__")
        print("type:", type); print("value:", value); print("traceback:", traceback)
        self.file.close()

print("test FileWriter:")
with FileWriter('tmp.txt') as f:
    print("start write")
    f.write('hello world')
    print("end write")

class ExceptionTest(object):
    def __enter__(self):
        print("run __enter__")
        return self

    def __exit__(self, type, value, traceback):
        print("run __exit__")
        print("type:", type); print("value:", value); print("traceback:", traceback)
        return False # return True # 注意返回True和False的区别:返回True则跳过异常,继续执行with语句之后的语句

    def divide_by_0(self):
        v = 10/0

print("\\ntest ExceptionTest")
with ExceptionTest() as ex:
    ex.divide_by_0()

print("test finish")

      执行结果如下：

 

      GitHub：https://github.com/fengbingchun/Python_Test