contextlib模块详解

小蓝 • 2024-12-04 10:25 • 编程

一、contextlib介绍

Python的contextlib模块是Python内置库中的一个模块，可以在编写Python代码时提供非常实用的功能。该模块提供了一个用于创建及管理RAII-style上下文(context）以及一些可以方便任务执行的辅助函数。

RAII-style是Resource Acquisition Is Initialization的缩写，用于C++及其他编程语言的资源管理技术，用于确保程序在操作完资源后，能够及时及时地释放它们。


import contextlib

@contextlib.contextmanager
def my_context():
    # setup
    yield
    # teardown

上面的代码中，我们首先导入了contextlib模块，然后定义了一个简单的上下文管理器my_context，谨记的是，在编写上下文管理器时你需要保证强制使用try/finally语句块实现contextmanager装饰器的效果。

二、with语句

with语句是Python在2.5版本之后引入的一个语法结构。它可以为用户定义的代码块创建一个运行的上下文环境，并且当代码块执行完毕以后，能够自动清理资源。

下面是一个简单的使用with语句创建上下文环境的例子：


try:
    with open("file.txt") as f:
        data = f.read()
except:
    print("failed to read the file..")

上面的例子中，我们打开了一个文件，并使用with语句创建了一个上下文环境。当代码块执行完毕后，with语句会自动关闭该文件，无需手动调用close()方法。

三、closing函数

closing()是在Python内置的contextlib模块中提供的一个功能函数。该函数可以把支持上下文管理协议且没有实现__exit__()方法的对象包装成一个上下文管理器对象。


import contextlib
from urllib.request import urlopen

with contextlib.closing(urlopen("http://www.baidu.com")) as page:
    for line in page:
        print(line)

上面的代码中，我们使用closing函数封装了urlopen返回的HTTPResponse对象，这种用法比较有用，因为HTTPResponse对象不会自动释放它的网络连接。

四、redirect_stdout函数

使用redirect_stdout，我们可以重定向输出到一个文件，stdout或别的流对象，然后再变回直接输出到终端。


import contextlib
import io

with open("file.txt", "w") as f:
    with contextlib.redirect_stdout(f):
        print("Hello, world!")

上面的代码中，我们将print输出到了文件“file.txt”中，而没有输出到终端。这种用法用于记录特定的输出日志信息非常有用。

五、Example: Timer类

为了更好地理解contextlib的特性，我们可以看看它提供了很多什么功能。下面，我将展示一个使用contextlib实现的Timer类，以便更好地理解其中的细节：


import contextlib
import time

class Timer:
    def __init__(self, name):
        self.name = name
        self.start_time = None

    def __enter__(self):
        self.start_time = time.perf_counter()
        return self

    def __exit__(self, exc_type, exc_val, exc_tb):
        elapsed_time = time.perf_counter() - self.start_time
        print(f"{self.name} took {elapsed_time:.6f} seconds")

with Timer("test"):
    time.sleep(1)

上面的代码中，我们使用Timer类实现了一个简单计时器。首先，我们使用__enter__函数开始计时，并将self传递回上下文管理器中。当用户代码块完成后，会自动调用__exit__函数停止计时，并打印出花费的时间。这样我们就创建了一个安全、可重用的计时器。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/198498.html