上下文管理器与with关键字需要配合起来使用,他们的使用场景是为业务执行前后增加额外功能。
比如执行业务前添加辅助功能,执行业务后添加额外功能。下面通过实际的例子展示它在业务中的用法。
with是一个神奇的关键字,他可以在代码中开辟一段由他管理的上下文,并控制程序在进入和退出时的行为。并非所有的对象都能和with配合使用,只有满足上下文管理器协议的对象才行。
上下文管理器:是一种定义了“进入”和“退出”动作的特殊对象,要创建一个上下文管理器,只要实现__enter__ 和 __exit__两个魔法方法即可。
class DummyContext:def __init__(self, name):self.name = namedef __enter__(self):# __enter__会在进入管理器时自动被调用,同时返回结果return f'{self.name} - {random.random()}'def __exit__(self, exc_type, exc_val, exc_tb):# __exit__会在退出管理器时被调用print('Exiting DummyContext')return Falsewith DummyContext('foo') as name:print(f'name: {name}')
下面操作文件就是普通的写法,每次都需要在finally里关闭资源。
conn = create_conn(host, port, timeout=None)
try:conn.send_text('Hello, world')
except Exception as e:print(f'Unable to use connection:{e}')
finally:conn.close()
使用上下文管理器后,就需要要每次都写一个关闭资源的句子,而是交给上下文来处理。
# 创建上下文管理器
class create_conn_obj:def __init__(self, host, port, timeout=None):self.conn = create_conn(host, port, timeout=timeout)def __enter__(self):return self.conndef __exit__(self, exc_type, exc_val, exc_tb):self.conn.close()return False# 使用上下文管理器
with create_conn_obj(host, port, timeout=None) as conn:try:conn.send_text('Hellod world')except Exception as e:print(f'Unable to use connection:{e}')
上面的上下文管理器是我们手动创建的,python还提供了内建的模块contextlib,在该模块中通过contextmanager装饰器可以快速创建一个上下文管理器,下面来介绍下他的使用方法。
假如我们在调试程序,项目设置的日志输出级别是error,需要在执行特定的函数时设置日志级别为waring,出现错误时抛出详细的日志方便调试。
通常的做法是在这个函数里添加代码设置日志级别为waring,等调试完毕后在删除该代码。如果调试的函数很多就需要做重复的动作,那么我们用上下文管理器来解决这个问题就变得非常的简单。只需要在调试的函数上使用with即可。
# 导入contextmanager 上下文管理器
from contextlib import contextmanager@contextmanager
def debug_logging(level):logger = logging.getLogger()old_level = logger.getEffectiveLevel()logger.setLevel(level)# try里面的代码是执行业务前运行的代码,等效于__enter__try:yield# finally里面的代码是执行业务后运行的代码,等效于__exit__finally:logger.setLevel(old_level)# 通过with运行上下文管理器,首先运行上下文管理器里try中的代码,
#然后运行with语句快里面的代码也就是prit和my_function(),
#最后运行上下文管理器里finally代码。
with debug_logging(logging.DEBUG):print('* Inside:')my_function()print('* After:')
my_function()
有些业务需要使用上下文管理器里创建的对象,在with语句块中做一些操作。例如操作文件业务,在上下文里面创建操作文件对象,然后在with语句块中使用这个对象操作文件。下面来介绍这种写法with … as object。
# 创建上下文,将需要返回的对象放在yield右边。
@contextmanager
def log_level(level, name):logger = logging.getLogger(name)old_level = logger.getEffectiveLevel()logger.setLevel(level)try:# 将logger对象返回yield loggerfinally:logger.setLevel(old_level)# with打开上下文管理器,然后使用as接收上下文返回的对象logger
with log_level(logging.DEBUG, 'my-log') as logger:# 通过上下文返回的对象在with语句块中操作业务logger.debug(f'This is a message for {logger.name}!')logging.debug('This will not print')