详解python with 上下文管理器
作为一个 java 为母语的程序员来讲,学习起其他新的语言就难免任何事都与 java 进行横向对比。java 7 引入了能省去许多重复代码的 try-with-resources
特性,不用每回 try/finally 来释放资源(不便之处有局部变量必须声明在 try 之前,finally 里还要嵌套 try/catch 来处理异常)。比如下面的 java 代码
try(inputstream inputstream = new fileinputstream("abc.txt")) { system.out.println(inputstream.read()); } catch (exception ex) { }
它相应的不使用 try-with-resources 语法的代码就是
inputstream inputstream = null; try { inputstream = new fileinputstream("abc.txt"); } catch (exception ex) { } finally { if(inputstream != null) { try { inputstream.close(); } catch (exception ex) { } } }
类似的 python 也有自己的 try-with-resources 写法,就是 with 关键字,它的概念叫做上下文管理器(context manager)。
with 关键字的使用
with open('some_file', 'w') as opened_file: opened_file.write('hola!')
以上的代码相当于
opened_file = open('some_file', 'w') try: opened_file.write('hola!') finally: opened_file.close()
也就是 with 关键字打开的资源会在 with 语句块结束后自动调用相应的方法自动释放(无论 with 中操作是否有异常)。
with 用起来是很方便的,但是什么样的资源可以用 with 关键字?python 是怎么知道要调用哪个方法来关闭资源的?进而如何实现自己的支持上下文管理器的 python 类。
再次回顾 java 的 try-with-resources
语法,try(...)
括号支持的类必须是实现了 autocloseable
接口,它的接口方法是
public void close() throws ioexception
也就是 java 的 try-with-resources
语法会自动调用以上方法来释放资源,要实现可被自动释放的 java 就只须遵照这一规则就行。
而在 python 中,能被 with 的类有两种实现方式
实现基本方法以支持上下文管理器的类
一个 python 类要能被用于 with
上下文,必须实现至少 __enter__
和 __exit__
方法。这两个方法的意思好理解,一个是创建资源后,后者是退出 with
语句块后。请看下面的例子
class file(object): def __init__(self, file_name, method): self.file_obj = open(file_name, method) def __enter__(self): print("---enter") return self.file_obj def __exit__(self, type, value, traceback): print("---exit") self.file_obj.close() with file('data.txt', 'r') as data_file: print(data_file.read())
假设 data.txt 文件中的内容是
hello
world
那么以上程序执行后的输出就是
--enter
hello
world
---exit
- __enter__ 返回的值作为 with ... as data_file 中的 data_file 变量的值,如果 __enter__ 没有返回,data_file 得到的就是 nonetype object 了。
- __exit__ 可利用来释放资源
- 没有 __enter__ 方法试图用 with 的写法执行时会得到 attributeerro: __enter__ 异常
- 同样,没有 __exit__ 方法试图用 with 的写法执行时会得到 attributeerro: __exit__ 异常
- __exit__ 有其他额外的三个参数,可获得资源的值,以及能处理 with 块中执行出现异常的情况
- __exit__ 的返回值也有用途,如果它返回 true 则出现的异常不再向外传播,其他值的话直接向外抛
利用生成器(generator) 和装饰器创建支持上下文管理器的方法
此种方式比较简单,不过逻辑控制上没有这么强。
from contextlib import contextmanager @contextmanager def open_file(name, method): f = open(name, method) yield f f.close()
使用 f 的执行代码将被放置在 yield f
所处的位置,with
使用以上方法。yield
后的 f 变量将是 with...as
后的变量值
with open_file('some_file', 'w') as file_object: file_object.write('hola!')
这里也要注意异常处理的情况,比如把上面代码打开文件的模式换作 r, 仍然试图去写文件,这样在 open_file
方法的 yield f
位置将产生异常,会造成 f.close()
得不到执行,不能正确释放该资源。
欲更具防御性,前面的 yield f
可以扩展也如下的形式
try: yield f except exception as ex: pass #处理异常,或继续向外抛 finally: f.close()
@contextmanager
装饰器内部也是封装为一个实现了 __enter__
和 __exit__
方法的对象。
参考链接:context managers
以上就是详解python with 上下文管理器的详细内容,更多关于python with 上下文管理器的资料请关注其它相关文章!