PyTips 0x0d - Python 上下文管理器

yuxue 发布于2019-07-24 18:33 / 3420人阅读

摘要：项目地址引入了语句与上下文管理器类型，其主要作用包括保存重置各种全局状态，锁住或解锁资源，关闭打开的文件等。了解了语句的执行过程，我们可以编写自己的上下文管理器。生成器的写法更简洁，适合快速生成一个简单的上下文管理器。

项目地址：https://git.io/pytips

Python 2.5 引入了 with 语句（PEP 343）与上下文管理器类型（Context Manager Types），其主要作用包括：

保存、重置各种全局状态，锁住或解锁资源，关闭打开的文件等。With Statement Context Managers

一种最普遍的用法是对文件的操作：

with open("utf8.txt", "r") as f:
    print(f.read())

你好，世界！

上面的例子也可以用 try...finally... 实现，它们的效果是相同（或者说上下文管理器就是封装、简化了错误捕捉的过程）：

try:
    f = open("utf8.txt", "r")
    print(f.read())
finally:
    f.close()

你好，世界！

除了文件对象之外，我们也可以自己创建上下文管理器，与 0x01 中介绍的迭代器类似，只要定义了 __enter__() 和 __exit__() 方法就成为了上下文管理器类型。with 语句的执行过程如下：

执行 with 后的语句获取上下文管理器，例如 open("utf8.txt", "r") 就是返回一个 file object；

加载 __exit__() 方法备用；

执行 __enter__()，该方法的返回值将传递给 as 后的变量（如果有的话）；

执行 with 语法块的子句；

执行 __exit__() 方法，如果 with 语法块子句中出现异常，将会传递 type, value, traceback 给 __exit__()，否则将默认为 None；如果 __exit__() 方法返回 False，将会抛出异常给外层处理；如果返回 True，则忽略异常。

了解了 with 语句的执行过程，我们可以编写自己的上下文管理器。假设我们需要一个引用计数器，而出于某些特殊的原因需要多个计数器共享全局状态并且可以相互影响，而且在计数器使用完毕之后需要恢复初始的全局状态：

_G = {"counter": 99, "user": "admin"}

class Refs():
    def __init__(self, name = None):
        self.name = name
        self._G = _G
        self.init = self._G["counter"]
    def __enter__(self):
        return self
    def __exit__(self, *args):
        self._G["counter"] = self.init
        return False
    def acc(self, n = 1):
        self._G["counter"] += n
    def dec(self, n = 1):
        self._G["counter"] -= n
    def __str__(self):
        return "COUNTER #{name}: {counter}".format(**self._G, name=self.name)
        
with Refs("ref1") as ref1, Refs("ref2") as ref2: # Python 3.1 加入了多个并列上下文管理器
    for _ in range(3):
        ref1.dec()
        print(ref1)
        ref2.acc(2)
        print(ref2)
print(_G)

COUNTER #ref1: 98
COUNTER #ref2: 100
COUNTER #ref1: 99
COUNTER #ref2: 101
COUNTER #ref1: 100
COUNTER #ref2: 102
{"user": "admin", "counter": 99}

上面的例子很别扭但是可以很好地说明 with 语句的执行顺序，只是每次定义两个方法看起来并不是很简洁，一如既往地，Python 提供了 @contextlib.contextmanager + generator 的方式来简化这一过程（正如 0x01 中 yield 简化迭代器一样）：

from contextlib import contextmanager as cm
_G = {"counter": 99, "user": "admin"}

@cm
def ref():
    counter = _G["counter"]
    yield _G
    _G["counter"] = counter

with ref() as r1, ref() as r2:
    for _ in range(3):
        r1["counter"] -= 1
        print("COUNTER #ref1: {}".format(_G["counter"]))
        r2["counter"] += 2
        print("COUNTER #ref2: {}".format(_G["counter"]))
print("*"*20)
print(_G)

COUNTER #ref1: 98
COUNTER #ref2: 100
COUNTER #ref1: 99
COUNTER #ref2: 101
COUNTER #ref1: 100
COUNTER #ref2: 102
********************
{"user": "admin", "counter": 99}

这里对生成器的要求是必须只能返回一个值（只有一次 yield），返回的值相当于 __enter__() 的返回值；而 yield 后的语句相当于 __exit__()。

生成器的写法更简洁，适合快速生成一个简单的上下文管理器。

除了上面两种方式，Python 3.2 中新增了 contextlib.ContextDecorator，可以允许我们自己在 class 层面定义新的”上下文管理修饰器“，有兴趣可以到官方文档查看。至少在我目前看来好像并没有带来更多方便（除了可以省掉一层缩进之外:(）。

上下文管理器的概念与修饰器有很多相似之处，但是要记住的是 with 语句的目的是为了更优雅地收拾残局而不是替代 try...finally...，毕竟在 The Zen of Python 中，

Explicit is better than implicit.

比

Simple is better than complex.

更重要:P。

欢迎关注公众号 PyHub！

云服务器专线服务上下文管理器上下文选择器 PyTips 管理器

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/37820.html

PyTips 0x0f - Python 修饰器与 functools

项目地址：https://git.io/pytips Python 的修饰器是一种语法糖（Syntactic Sugar），也就是说： @decorator @wrap def func(): pass 是下面语法的一种简写： def func(): pass func = decorator(wrap(func)) 关于修饰器的两个主要问题：修饰器用来修饰谁谁可以作为修饰器...

dingding199389 2019-07-24 18:36 评论0 收藏0
PyTips 0x 12 - Python 线程与协程（1）

摘要：中关于线程的标准库是，之前在版本中的在之后更名为，无论是还是都应该尽量避免使用较为底层的而应该使用。而与线程相比，协程尤其是结合事件循环无论在编程模型还是语法上，看起来都是非常友好的单线程同步过程。项目地址：https://git.io/pytips 要说到线程（Thread）与协程（Coroutine）似乎总是需要从并行（Parallelism）与并发（Concurrency）谈起...

el09xccxy 2019-07-24 18:38 评论0 收藏0
PyTips 0x01 - 迭代器与生成器

摘要：项目地址迭代器与生成器迭代器与生成器是中比较常用又很容易混淆的两个概念，今天就把它们梳理一遍，并举一些常用的例子。生成器前面说到创建迭代器有种方法，其中第三种就是生成器。项目地址：https://git.io/pytips 迭代器与生成器迭代器（iterator）与生成器（generator）是 Python 中比较常用又很容易混淆的两个概念，今天就把它们梳理一遍，并举一些常用的例...

chemzqm 2019-07-24 18:31 评论0 收藏0
PyTips 0x16 - Python 迭代器工具

摘要：借鉴了中的某些迭代器的构造方法，并在中实现该模块是通过实现，源代码。项目地址：https://git.io/pytips 0x01 介绍了迭代器的概念，即定义了 __iter__() 和 __next__() 方法的对象，或者通过 yield 简化定义的可迭代对象，而在一些函数式编程语言（见 0x02 Python 中的函数式编程）中，类似的迭代器常被用于产生特定格式的列表（或序列）...

mayaohua 2019-07-31 11:42 评论0 收藏0
PyTips 0x04 - Python 闭包与作用域

摘要：项目地址闭包在计算机科学中，闭包英语，又称词法闭包或函数闭包，是引用了自由变量的函数。这个被引用的自由变量将和这个函数一同存在，即使已经离开了创造它的环境也不例外。项目地址：https://git.io/pytips 闭包（Closure）在计算机科学中，闭包（英语：Closure），又称词法闭包（Lexical Closure）或函数闭包（function closures），是...

leejan97 2019-07-24 18:30 评论0 收藏0