揭秘 Python 中的 with 关键字

开发 后端
你有没有想过 with 语句是什么以及我们为什么使用它呢?请阅读这篇文章!

我们中的许多人在 Python 代码中一遍又一遍地看到这个代码片段:

with open('Hi.text', 'w') as f:
f.write("Hello, there")

但是,我们中的一些人不知道 with 有什么用,以及为什么我们需要在这里使用它。在此阅读中,您将找到关于 with 可解决的几乎所有问题。让我们开始吧!

首先,让我们考虑一下如果不使用 with 关键字我们需要做什么。在这种情况下,我们需要先打开文件并尝试执行 write。不管成功与否,我们最好在最后关闭它,所以我们的代码将如下所示:

f = open('Hi.text', 'w')
try:
f.write('Hello, there')
finally:
f.close()

那么,with 关键字有什么用呢?它只是有助于将我们的 try..finally 代码缩短为 with... 的单个语句!这就是 with 语句用法。

那么,它到底是什么?事实上,with 语句本身在 Python 中并没有什么特别之处,它只是 Python 中上下文管理器的一个特性。上下文管理器,引用自 Python 官方文档,是一种让您在需要时准确分配和释放资源的方法,或者简单来说:当您在某些资源上做某事时缩短您的代码片段,这意味着您可以自己定义 with 语句的用法!

我们如何做到这一点?嗯,很简单,你只需要实现两个魔术函数:一个叫做 __enter__,另一个叫做 __exit__。第一种方法是编写一个实现这两个函数的类,如下所示:

class My_file:
def __init__(self, fname):
self.fname = fname
def __enter__(self):
self.file = open(self.fname, 'w')
return self.file
def __exit__(self, exc_type, exc_val, exc_trace_back):
if self.file:
self.file.close()

在这里,我们创建了一个普通的 Python 类,实现了两个魔术函数。注意这两个函数的签名:__enter__ 只接受 self ,而 __exit__ 将接受更多参数,示例中的这三个是标准形式。这样,我们就可以直接使用:

with My_file('hello.txt') as f:
f.write('hello, world!')

这里的 with 语句会先调用 __init__ 构造一个新对象,然后再调用 __enter__ 方法;最后,它会在代码块完成之前触发 __exit__ 方法。所以,上面代码的大致等价如下:

myfile = My_file('hello.txt')
f = myfile.__enter__()
f.write('hello, world!')
myfile.__exit(...)

实现上下文管理器的第二种方法是通过装饰器,如下:

  1. 你import contextmanager from contextlib
  2. 你写一个函数来实现你想要的with语句。
  3. 在函数上方添加一个装饰器@contextmanager。
  4. 使用你的with your_function!

根据上面的介绍,让我们写一个装饰器上下文管理器!

from contextlib import contextmanager
@contextmanager
def my_file_open(fname):
try:
f = open(fname, 'w')
yield f
finally:
print('Closing file')
f.close()
with file_open('hi.txt') as f:
f.write('hello world')

以上几乎涵盖了 with 语句和上下文管理器的所有基础知识,但是如果您想了解更多信息,请继续...!

contextlib 中有一些方便的工具供您使用。第一个是 closing 。closing 基本上会用你在退出之前实现的另一个函数来包装你的代码块。

@contextmanager
def closing(f):
try:
f.write("Finish writing")
finally:
f.close()
with closing(open("hi.text")):
f.write("hello world")

例如,在上面的代码中,我们可以直接调用 close(your_way_of_getting_resource) ,在你下面写的代码块即将完成之前(f.write("hello world")),它会执行 try..finally 我们在上面定义的块。

另一个是使用 suppress 工具。我们知道,在很多情况下,如果我们尝试获取一些资源,很可能在打开文件时会出现 FileNotFoundException 等错误。在某些情况下,我们希望捕获错误或抑制错误,以便程序继续正常运行。suppress 是我们可以抑制警告的一种方式。你需要做的就是弄清楚你想要抑制哪个异常,并编写with suppress(your_choice_of_exception),Python 将从这里开始处理它。

在其他情况下,您可能只想在输入 with 代码块时执行某些操作。在这种情况下,nullcontext 对你来说会很方便。nullcontext 只会返回你在 __enter__ 函数中定义的东西,而不会做任何其他事情。如果您在 Python 中处理 async 操作以访问资源,则 aclosure 是处理这种情况的实用工具。

总结

本文介绍了 with 语句的一些基本概念和用法及其底层工作原理。还有很多有趣的东西,请查看 Python 的 contextlib 文档。最后,祝您能像往常一样快乐学习和快乐编码!

责任编辑:庞桂玉 来源: 马哥Linux运维
相关推荐

2024-01-07 20:15:49

Python编程语言

2023-12-11 13:59:00

YieldPython生成器函数

2018-04-20 15:56:09

Pythonglobal关键字

2013-01-30 10:12:14

Pythonyield

2012-06-02 00:53:39

Javafinally

2020-08-10 08:00:13

JavaFinal关键字

2023-11-19 22:52:42

2023-11-28 21:50:39

finalstaticvolatile

2011-06-14 13:26:27

volatile

2024-02-23 18:04:37

C++const关键字

2017-10-20 11:12:12

数据类型关键字对象

2011-07-14 23:14:42

C++static

2019-12-17 08:16:04

JavaScriptthis编程

2010-01-26 14:35:11

C++关键字

2013-03-28 15:19:31

assign、copy

2020-08-23 11:03:24

Python开发void

2023-12-25 07:28:24

PythonSelf对象编程

2021-02-01 13:10:07

Staticc语言UNIX系统

2022-02-17 08:31:38

C语言staic关键字

2024-03-15 15:12:27

关键字底层代码
点赞
收藏

51CTO技术栈公众号