定义
- 上下文管理器是一个包装任意代码块的对象。上下文管理器保证进入上下文管理器时,每次代码执行的一致性;当退出上下文管理器时,相关的资源会被正确回收
- 功能类似于执行try,except和finally关键字;被用到最多的就是:作为确保资源被正确清理的一种方式
与装饰器的对比 :大多数方面上下文管理器与装饰器的作用等价 - 相似:它们都是包装其他代码的工具。
- 不同:装饰器包装用于定义的代码块(函数或类);上下文管理器可以包装任意格式的代码块
语法
1. with语句
- 使用with语句和内置函数open都可以进入上下文管理器
with open('/path/to/filename', 'r') as my_file:
contents = my_file.read()
- 从本质上讲,实际上是with语句对其后的代码进行求值,该表达式会返回一个对象,该对象包含两个特殊方法__enter__和__exit__;__enter__方法返回的结果会被赋给as关键字之后的变量。
- 注意:在with后的表达式结果没有被赋给所谓的变量,只有__enter__的返回值会被赋给该变量
2. enter和exit方法
- with语句的表达式的作用是返回一个遵循特定协议的对象。该对象必须定义一个__enter__和__exit__方法
- 除了传统的self参量,__enter__不接受任何其他参数
- __exit__方法带3个位置参数(不包括self):异常类型、异常实例、一个回溯。无异常时三个值均为None
- 上下文管理器必须定义__exit__方法,该方法可以选择性地处理保证代码块中出现的异常,或者处理其他需要关闭上下文管理器状态的事情
# 并没有做什么工作,仅返回自身和设置其entered变量:进入时True,退出时False
class ContextManager(object):
def __init__(self):
self.entered = False
def __enter__(self):
self.entered = True
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.entered = False
cm = ContextManager()
print cm.entered #False 创建实例
# 使用上下文管理器打开,entered为True,退出时变为False
with cm:
print cm.entered # True
print cm.entered #False
with ContextManager() as cm:
print cm.entered #True
3. 异常处理
- __exit__方法选择性地处理包装代码块中出现的异常,或者处理其他需要关闭上下文管理器状态的事情。
- 如果没有异常,__exit__三个参数值都是None,如果接收一个异常,就有义务处理异常。
何时编写上下文管理器
- 资源清理
示例:打开PostgreSQL数据库连接的上下文管理器(未测试)
import psycopg2
class DBConnection(object):
def __init__(self, dbname=None, user=None, password=None, host='localhost'):
self.host = host
self.dbname = dbname
self.user = user
self.password = password
def __enter__(self):
self.connection = psycopg2.connect(
dbname = self.dbname,
host = self.host,
user = self.user,
password = self.password)
return self.connection.cursor()
def __exit__(self, exc_type, exc_instance, exc_traceback):
self.connection.close()
with DBConnection(user='root', dbname='puwell_db') as db:
db.execute('SELECT 1+1')
db.fetchall() #[(2,)]
db.execute('SELECT 1+1') #出错 InterfaceError:cursor already closed