Python上下文管理器怎么使用

这篇文章主要介绍了Python上下文管理器怎么使用的相关知识，内容详细易懂，操作简单快捷，具有一定借鉴价值，相信大家阅读完这篇Python上下文管理器怎么使用文章都会有所收获，下面我们一起来看看吧。

什么是上下文管理器？

即使你没有听说过 Python 的上下文管理器，根据介绍，你也已经知道，它是

try/finally

块的替代品。它是使用打开文件时常用的语句

with

来实现的。与

try/finally

相同，引入此模式是为了保证在块末尾执行某些操作，即使发生异常或程序终止。

从表面上看，上下文管理协议只是围绕

with

代码块的语句。实际上，它包含 2 个特殊的 ( dunder ) 方法 -

__enter__

和

__exit__

组成，分别有助于启动和停止。

当代码中遇到

with

语句时，将触发

__enter__

方法并将其返回值放入

as

限定符后面的变量中。

with

块体执行完毕后，调用

__exit__

方法进行停止——完成

finally

块的作用。

# Using try/finally
import time

start = time.perf_counter()  # Setup
try:  # Actual body
    time.sleep(3)
finally:  # Teardown
    end = time.perf_counter()
    elapsed = end - start

print(elapsed)

# Using Context Manager
with Timer() as t:
    time.sleep(3)

print(t.elapsed)

上面的代码显示了使用

try/finally

的版本和使用

with

语句来实现简单的计时器的更优雅的版本。如上所述，实现这样的上下文管理器需要

__enter__

和

__exit__

，但是我们将如何创建它们呢？我们看一下这个

Timer

类的代码：

# Implementation of above context manager
class Timer:
    def __init__(self):
        self._start = None
        self.elapsed = 0.0

    def start(self):
        if self._start is not None:
            raise RuntimeError('Timer already started...')
        self._start = time.perf_counter()

    def stop(self):
        if self._start is None:
            raise RuntimeError('Timer not yet started...')
        end = time.perf_counter()
        self.elapsed += end - self._start
        self._start = None

    def __enter__(self):  # Setup
        self.start()
        return self

    def __exit__(self, *args):  # Teardown
        self.stop()

此代码片段显示了实现

__enter__

和

__exit__

方法的

Timer

类。

__enter__

方法仅启动计时器并返回

self

，

self

将在

with ...

.中作为

some_var

赋值，

with

语句体完成后，将使用 3 个参数调用

__exit__

方法 - 异常类型、异常值和回溯。如果

with

语句正文中一切顺利，则这些都等于

None

。如果引发异常，这些将填充异常数据，我们可以在

__exit__

方法中处理这些数据。在这种情况下，我们省略了异常处理，只是停止计时器并计算经过的时间，并将其存储在上下文管理器的属性中。

我们已经在这里看到了

with

语句的实现和示例用法，但是为了更直观地了解实际发生的情况，让我们看看如何在没有 Python 语法糖的情况下调用这些特殊方法：

manager = Timer()
manager.__enter__()  # Setup
time.sleep(3)  # Body
manager.__exit__(None, None, None)  # Teardown
print(manager.elapsed)

现在我们已经确定了什么是上下文管理器，它是如何工作的以及如何实现它，让我们看看使用它的好处——只是为了有更多的动力从

try/finally

切换到

with

语句。

第一个好处是整个启动和停止都在上下文管理器对象的控制下进行。这可以防止错误并减少样板代码，从而使 API 更安全、更易于使用。使用它的另一个原因是

with

块突出了关键部分并鼓励你减少该部分中的代码量，这通常也是一个好习惯。最后——最后但并非最不重要的一点——它是一个很好的重构工具，它可以将常见的启动和停止代码分解出来，并将其移动到一个位置——即

__enter__

和

__exit__

方法。

话虽如此，我希望我能说服你开始使用上下文管理器，而不是

try/finally

，即使你以前没有使用过它们。那么，现在让我们看看一些很酷且有用的上下文管理器，你应该开始将它们包含在你的代码中！

@contextmanager

在上一节中，我们探讨了如何使用

__enter__

和

__exit__

方法实现上下文管理器。这很简单，但我们可以使用

contextlib

，更具体地说，使用

@contextmanager

，使其更简单。

@contextmanager

是一个装饰器，可用于编写自包含的上下文管理函数。因此，我们不需要创建整个类并实现

__enter__

和

__exit__

方法，我们只需要创建一个生成器：

from contextlib import contextmanager
from time import time, sleep

@contextmanager
def timed(label):
    start = time()  # Setup - __enter__
    print(f"{label}: Start at {start}")
    try:  
        yield  # yield to body of `with` statement
    finally:  # Teardown - __exit__
        end = time()
        print(f"{label}: End at {end} ({end - start} elapsed)")

with timed("Counter"):
    sleep(3)

# Counter: Start at 1599153092.4826472
# Counter: End at 1599153095.4854734 (3.00282621383667 elapsed)

此代码段实现了与上一节中的

Timer

类非常相似的上下文管理器。然而，这一次，我们需要的代码要少得多。这段代码分为两个部分，一部分是在

yield

之前，另一部分是

yield

之后。

yield

之前的代码承担了

__enter__

方法的工作，而

yield

本身是

__enter__

方法的

return

语句。

yield

之后的都是

__exit__

方法的一部分。

正如你在上面看到的，像这样使用单个函数创建上下文管理器需要使用使用

try/finally

语句，因为如果在语句

withy

体中发生异常，它将在

yield

行被引发，我们需要在对应于

__exit__

方法的

finally

块中处理它。

正如我已经提到的，这可以用于自包含的上下文管理器。但是，它不适合需要成为对象一部分的上下文管理器，例如连接或锁。

尽管使用单个函数构建上下文管理器会迫使你使用

try/finally

，并且只能用于更简单的用例，但在我看来，它仍然是构建更精简的上下文管理器的优雅而实用的选择。

现实生活中的例子

现在让我们从理论转向实用且有用的上下文管理器，你可以自己构建它。

记录上下文管理器

当需要尝试查找代码中的一些bug时，你可能会首先查看日志以找到问题的根本原因。但是，这些日志可能默认设置为错误或警告级别，这可能不足以用于调试。更改整个程序的日志级别应该很容易，但更改特定代码部分的日志级别可能会更复杂 - 不过，这可以通过以下上下文管理器轻松解决：

import logging
from contextlib import contextmanager

@contextmanager
def log(level):
    logger = logging.getLogger()
    current_level = logger.getEffectiveLevel()
    logger.setLevel(level)
    try:
        yield
    finally:
        logger.setLevel(current_level)

def some_function():
    logging.debug("Some debug level information...")
    logging.error('Serious error...')
    logging.warning('Some warning message...')

with log(logging.DEBUG):
    some_function()

# DEBUG:root:Some debug level information...
# ERROR:root:Serious error...
# WARNING:root:Some warning message...

超时上下文管理器

在本文的开头，我们正在使用计时代码块。我们在这里尝试的是将超时设置为

with

语句包围的块：

import signal
from time import sleep

class timeout:
    def __init__(self, seconds, *, timeout_message=""):
        self.seconds = int(seconds)
        self.timeout_message = timeout_message

    def _timeout_handler(self, signum, frame):
        raise TimeoutError(self.timeout_message)

    def __enter__(self):
        signal.signal(signal.SIGALRM, self._timeout_handler)  # Set handler for SIGALRM
        signal.alarm(self.seconds)  # start countdown for SIGALRM to be raised

    def __exit__(self, exc_type, exc_val, exc_tb):
        signal.alarm(0)  # Cancel SIGALRM if it's scheduled
        return exc_type is TimeoutError  # Suppress TimeoutError

with timeout(3):
    # Some long running task...
    sleep(10)

上面的代码为这个上下文管理器声明了一个名为

timeout

的类，因为这个任务不能在单个函数中完成。为了能够实现这种超时，我们还需要使用信号-更具体地说是

SIGALRM

。我们首先使用

signal.signal(...)

将处理程序设置为

SIGALRM

，这意味着当内核引发

SIGALRM

时，将调用处理程序函数。对于这个处理程序函数（

_timeout_handler

），它所做的只是引发

TimeoutError

，如果没有及时完成，它将停止

with

语句体中的执行。处理程序就位后，我们还需要以指定的秒数开始倒计时，这由

signal.alarm(self.seconds)

完成。

对于

__exit__

方法，如果上下文管理器的主体设法在时间到期之前完成，

SIGALRM

则将被取消，而

signal.alarm(0)

和程序可以继续。另一方面 - 如果由于超时而引发信号，那么

_timeout_handler

将引发

TimeoutError

，这将

__exit__

被捕获和抑制，

with

语句主体将被中断，其余代码可以继续执行。

使用已有的

除了上面的上下文管理器，标准库或其他常用库（如request或sqlite3）中已经有很多有用的上下文管理程序。那么，让我们看看我们可以在那里找到什么。

临时更改小数精度

如果你正在执行大量数学运算并需要特定的精度，那么你可能会遇到需要临时更改十进制数精度的情况：

from decimal import getcontext, Decimal, setcontext, localcontext, Context

# Bad
old_context = getcontext().copy()
getcontext().prec = 40
print(Decimal(22) / Decimal(7))
setcontext(old_context)

# Good
with localcontext(Context(prec=50)):
    print(Decimal(22) / Decimal(7))  # 3.1428571428571428571428571428571428571428571428571

print(Decimal(22) / Decimal(7))      # 3.142857142857142857142857143

上面的代码演示了不带和带上下文管理器的选项。第二个选项显然更短，更具可读性。它还考虑了临时上下文，使其不易出错。

contextlib

在使用

@contextmanager

时，我们已经窥探了

contextlib

，但我们可以使用更多的东西——作为第一个示例，让我们看看

redirect_stdout

和redirect

redirect_stderr

：

import sys
from contextlib import redirect_stdout

# Bad
with open("help.txt", "w") as file:
    stdout = sys.stdout
    sys.stdout = file
    try:
        help(int)
    finally:
        sys.stdout = stdout

# Good
with open("help.txt", "w") as file:
    with redirect_stdout(file):
        help(int)

如果你有一个工具或函数，默认情况下将所有数据输出到

stdout

或

stderr

，但你希望它将数据输出到其他地方——例如文件。那么这两个上下文管理器可能非常有用。与前面的示例一样，这大大提高了代码的可读性，并消除了不必要的视觉干扰。

contextlib

的另一个方便的方法是

suppress

上下文管理器，它将抑制任何不需要的异常和错误：

import os
from contextlib import suppress

try:
    os.remove('file.txt')
except FileNotFoundError:
    pass

with suppress(FileNotFoundError):
    os.remove('file.txt')

当然，正确处理异常是更好的，但有时你只需要消除令人讨厌的

DeprecationWarning

警告，这个上下文管理器至少会使它可读。

我将提到的

contextlib

中的最后一个实际上是我最喜欢的，它叫做

closing

：

# Bad
try:
    page = urlopen(url)
    ...
finally:
    page.close()

# Good
from contextlib import closing

with closing(urlopen(url)) as page:
    ...

此上下文管理器将关闭作为参数传递给它的任何资源（在上面的示例中），即

page

对象。至于在后台实际发生的情况，上下文管理器实际上只是强制调用页面对象的

.close()

方法，与使用

try/finally

选项的方式相同。

用于更好测试的上下文管理器

若你们想让人们使用、阅读或维护你们所写的测试，你们必须让他们可读，易于理解和模仿。

mock.patch

上下文管理器可以帮助你：

# Bad
import requests
from unittest import mock
from unittest.mock import Mock

r = Mock()
p = mock.patch('requests.get', return_value=r)
mock_func = p.start()
requests.get(...)
# ... do some asserts
p.stop()

# Good
r = Mock()
with mock.patch('requests.get', return_value=r):
    requests.get(...)
    # ... do some asserts

使用

mock.patch

上下文管理器可以让你摆脱不必要的

.start()

和

.stop()

调用，并帮助你定义此特定模拟的明确范围。这个测试的好处是它可以与

unittest

以及

pytest

一起使用，即使它是标准库的一部分（因此也是

unittest

）。

说到

pytest

，让我们也展示一下这个库中至少一个非常有用的上下文管理器：

import pytest, os

with pytest.raises(FileNotFoundError, message="Expecting FileNotFoundError"):
    os.remove('file.txt')

这个例子展示了

pytest.raises

的非常简单的用法，它断言代码块引发提供的异常。如果没有，则测试失败。这对于测试预期会引发异常或失败的代码路径非常方便。

跨请求持久化会话

从

pytest

转到另一个伟大的库——

requests

。通常，你可能需要在HTTP请求之间保留cookie，需要保持TCP连接活动，或者只想对同一主机执行多个请求。

requests

提供了一个很好的上下文管理器来帮助应对这些挑战，即管理会话：

import requests

with requests.Session() as session:
    session.request(method=method, url=url, **kwargs)

除了解决上述问题之外，这个上下文管理器还可以帮助提高性能，因为它将重用底层连接，因此避免为每个请求/响应对打开新连接。

管理 SQLite 事务

最后但同样重要的是，还有用于管理SQLite事务的上下文管理器。除了使代码更干净之外，此上下文管理器还提供了在异常情况下回滚更改的能力，以及在

with

语句体成功完成时自动提交的能力：

import sqlite3
from contextlib import closing

# Bad
connection = sqlite3.connect(":memory:")
try:
    connection.execute("INSERT INTO employee(firstname, lastname) values (?, ?)", ("John", "Smith",))
except sqlite3.IntegrityError:
    ...

connection.close()

# Good
with closing(sqlite3.connect(":memory:")) as connection:
    with connection:
        connection.execute("INSERT INTO employee(firstname, lastname) values (?, ?)", ("John", "Smith",))

在本例中，你还可以看到

closing

上下文管理器的良好使用，它有助于处理不再使用的连接对象，这进一步简化了代码，并确保我们不会让任何连接挂起。