浅淡 python 中 with 的用法,上下文管理器

例子一

首先来看一段代码:

class Foo(object):

    def __init__(self):
        print('实例化一个对象')

    def __enter__(self):
        print('进入')

    def __exit__(self, exc_type, exc_val, exc_tb):
        print('退出')

obj = Foo()

with obj:
    print('正在执行')

上面代码执行结果为:

实例化一个对象
进入
正在执行
退出

结论 1

我们知道,实例化 Foo,得到 obj 对象,会执行 Foo 的 __init__ 方法,也就是打印了第一句;

按照,程序从上至下执行,应该会打印“正在执行”才对,为什么会在它之前先打印了进入,在它之后打印了退出呢?

因为我们在定义 Foo 时,定义了 __enter__ 和 __exit__ 方法,那么我们实例化的对象 obj 就是一个上下文管理器,

含有 __enter__ 和 __exit__ 方法的对象就是上下文管理器。

with 上下文管理器:
     语句体

当 with 遇到上下文管理器,就会在执行语句体之前,先执行上下文管理器的 __enter__ 方法,然后再执行语句体,执行完语句体后,最后执行 __exit__ 方法

这也就是为什么会出现文章开头的情况的原因。

例子二

再看看这段代码:

class Foo(object):

    def __init__(self):
        print('实例化一个对象')

    def __enter__(self):
        print('进入')

    def __exit__(self, exc_type, exc_val, exc_tb):
        print('退出')
     # return True

obj = Foo()

with obj:
    raise ImportError
    print('正在执行')

结果如下:

浅淡 python 中 with 的用法,上下文管理器

把上面代码中我们注释掉的那一行代码取消注释,结果如下

浅淡 python 中 with 的用法,上下文管理器

我们会发现,虽然我们故意在语句体中抛出一个错误,按照正常情况,执行到报错地方就不会执行了,而 __exit__ 是在语句体执行完之后执行的,但还是执行了 __exit__ 方法;当我们在 __exit__ 中给一个返回值为 Ture 时,就会忽略错误。

结论 2

所有我们可以发现

with 语句类似

  try :

  except:

  finally:

的功能:但是 with 语句更简洁。而且更安全。代码量更少。

   出现异常时,如果 exit 返回 False(默认不写返回值时,即为 False),则会重新抛出异常,让 with 之外的语句逻辑来处理异常,这也是通用做法;如果返回 True,则忽略异常,不再对异常进行处理

例子三

class Foo(object):

    def __init__(self):
        print('实例化一个对象')

    def __enter__(self):
        print('进入')
        # return self

    def __exit__(self, exc_type, exc_val, exc_tb):
        print('退出')


with Foo() as obj:
    print(obj,type(obj))
    print('正在执行')

浅淡 python 中 with 的用法,上下文管理器

把上面代码中我们注释掉的那一行代码取消注释,结果如下

浅淡 python 中 with 的用法,上下文管理器

结论

调用上下文管理器的 enter 方法时;如果使用了 as 子句,则将 enter() 方法的返回值赋值给 as 子句中的目标

with 上下文管理器  as  target:
    代码语句体

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

例子四

我们经常会看到这样的代码:

with open("/tmp/foo.txt") as file:
    data = file.read()

结论

这里使用了 with 语句,不管在处理文件过程中是否发生异常,都能保证 with 语句执行完毕后已经关闭了打开的文件句柄。如果使用传统的 try/finally 范式,则要使用类似如下代码:

somefile = open(r'somefileName')
try:
    for line in somefile:
        print line
        # ...more code
finally:
    somefile.close()

比较起来,使用 with 语句可以减少编码量。已经加入对上下文管理协议支持的还有模块 threading、decimal 等。

补充

with 只能配合上下文管理器使用,常见的上下文管理器有

file
decimal.Context
thread.LockType
threading.Lock
threading.RLock
threading.Condition
threading.Semaphore
threading.BoundedSemaphore