[TOC]

python3 中的上下文管理器¶

上下文管理器是什么

只要实现了 __exit__ , __enter__ 的类它就是上下文管理器. 它可以用来管理上下文

实现了 __exit__ , __enter__ 魔术方法的对象可以使用 with 语句

上下文表达式返回一个上下文管理器

上下文管理的作用和目的¶

上下文管理对象是为了存在的目的是管理 with 语句, 而 with 语句目的是为了简化 tyr/ finally 这种模式

这种模式保证运行一段代码后, ,即便代码里面发生错误, return 语句或者调用终止 sys.exit() , 也会执行特定的代码段, 来做一些最后的处理 , 比如释放连接, 还原一些状态,释放资源等 .

介绍上下文管理器协议¶

首先要实现一个上下文管理需要实现两个魔术方法 __exit, __enter , 即需要在一个类中

不管以哪种方式退出 with 语句, 都会进行 __enter__ 方法里面的代码段 , 而不是 __enter__ 返回对象的对象上调用

下面简单实现一个上下文管理器

Resource 类中实现了两个魔术方法 , 同时实现了一个query 方法

# -*- coding: utf-8 -*-

class Resource:

    def __enter__(self):
        print("connect to resource")
        return self


    def __exit__(self, exc_type, exc_val, exc_tb):
        print("close resource  connection")

    def query(self):
        print("query  data ...")


with Resource() as r:
    r.query()

首先 Resource 实现了这两个魔术方法 , 它就是一个上下文管理器 , 就可以使用with 这种语法 ,with 表达式后面一定要是一个上下文管理器,才能够这样写.

结果如下 :

img1¶

整个代码的执行流程

可以看出首先执行的 __enter__ 里面的代码段 , 后来返回 self , 然后执行 query 方法 , 最后执行 __exit__ 魔术方法 .

这个就是最简单的上下文管理器了.

enter 方法介绍¶

你可能会疑惑为啥 __enter__ 方法要返回 self ?

这个例子中返回 self , 即返回 Resource 对象的实例 , 然后通过 r.query 来调用实例方法 query , 所以这里是需要返回self . 这里 __enter__ 方法的返回值 ,

with Resource() as r:pass

就是这段代码as 后对应变量的值 , 这里命名为 r 它的值就是 self

下面在 __enter__ 返回 frank ,之后打印r 来看一下这个值是什么 ?

# -*- coding: utf-8 -*-

class Resource:

    def __enter__(self):
        print("connect to resource")
        return "frank"

    def __exit__(self, exc_type, exc_val, exc_tb):
        print("close resource  connection")

    def query(self):
        print("query  data ...")


with Resource() as r:
    print(f"r:{r}")

结果如下:

img2¶

现在应该理解为啥要返回 self了吧 . 一般情况下 __enter__ 方法会返回 self , 当然也可以不返回 .

如果实在不需要返回 , 也可以不返回 .

只要明白只要执行 with 这种里面的代码段首先是先执行 __enter__ 方法里面的代码即可.

exit 方法介绍¶

__exit__ 方法实在with 里面代码段执行完后 , 执行的方法 ,一般就是资源清理的代码,会写在这里, 还有一些异常处理的代码,也可以写在这里.

注意到上面方法有三个参数 , 这三个参数只有 with 语句报错后, 这几个参数才会有值, 如果with 代码段里面没有报错那么这个三个值均为 None

exc_type 异常类

exc_value 异常值

exc_tb traceback 对象

# -*- coding: utf-8 -*-

class Resource:

    def __enter__(self):
        print("connect to resource")
        return "frank"
        pass

    def __exit__(self, exc_type, exc_val, exc_tb):
        """

        :param exc_type: 异常类
        :param exc_val: 异常值
        :param exc_tb:  traceback 对象
        :return:
        """
        print(exc_type,exc_val,exc_tb)
        print("close resource  connection")

    def query(self):
        print("query  data ...")


with Resource() as r:

    1/0
    print(f"r:{r}")

在with 语句故意抛出一个异常可以看出这三个值 .

img3¶

img4¶

可以看出程序就报错了, 并且异常被抛出来了.

刚刚在 __exit__ 方法里面其实是可以处理这种异常的, 保证程序可以正常执行.

可以通过 exc_tb 是否为空来处理这个异常, 然后注意这个时候要返回一个True , 这里的意思是程序异常已经处理, 不继续抛出到主程序了.

# -*- coding: utf-8 -*-

class Resource:

    def __enter__(self):
        print("connect to resource")
        return "frank"
        pass

    def __exit__(self, exc_type, exc_val, exc_tb):
        """

        :param exc_type: 异常类
        :param exc_val: 异常值
        :param exc_tb:  traceback 对象
        :return: True or False
        """
        if exc_tb:
            print("catch exception .  deal exception")
            return True
        print("close resource  connection")

    def query(self):
        print("query  data ...")


with Resource() as r:

    1/0
    print(f"r:{r}")

执行结果如下:

img5¶

这里 __enter__ 方法返回值, 决定是否要将异常抛出来

__exit__ 这个方法用来上下文管理器退出执行的方法, 如果有异常, 可以在这里处理,并且返回True, 则异常就不会被抛出来, 如果返回false 异常就会被抛出来. 有主程序处理该异常.

上下文管理用法¶

1 常用的示例

比如数据连接以及关闭的操作

一般连接数据库需要以下步骤

数据库连接, 管理

连接数据库

exectue  sql

释放连接 con.close()

try:
  pass
except:
  pass
finally:
  pass

比如可以像下面的的例子

来实现一个上下文管理器

# -*- coding: utf-8 -*-

import pymysql


class ConnText:

    def __enter__(self):
        print("begin db connection")
        self.conn = self.get_connection()
        return self.conn

    def __exit__(self, exc_type, exc_val, exc_tb):
        self.close()

    def get_connection(self):
        conn = pymysql.connect()
        return conn

    def close(self):
        self.conn.close()
        print("close db connection")

    def query(self):
        print("query data")


with ConnText() as r:
    r.query()

文件读写也可以用上下文管理器

一般打开文件后最后都需要关闭文件句柄, 这个时候就可以使用上下文管理了.

with open('/tmp/1.sql') as f
  pass

框架里面使用¶

其实在很多源码中也可以看到上下文管理器的用法 ,

比如celery 核心对象 Celery 也实现了上下文管理器

代码位于:

python3.x/site-packages/celery/app/base.py

img7¶

在flask 框架里面用了很多上下文管理,比如这个模块

/python3.x/site-packages/flask/ctx.py

RequestContext , AppContext 这两个类都实现了上下文的管理器的协议

img7¶

总结¶

本文简单总结了上下文管理器的语法,使用python 这种语法可以写代码看起来更优雅一些, 更加的 pythonic. 有时候要学会看源代码来学习.