컨텍스트 관리자를 사용하여 Python 타이머를 확장하는 방법

위에서 첫 번째 Python 타이머 클래스를 만든 후 점차적으로 Timer 클래스를 확장했으며 해당 코드도 상대적으로 풍부하고 강력합니다. 우리는 이것에 만족할 수 없으며 타이머를 사용하기 위해 일부 코드를 템플릿화해야 합니다.

• 먼저 클래스를 인스턴스화합니다.
• 둘째, 시간을 측정하려는 코드 블록 앞에 .start()를 호출합니다.
• 마지막으로, 코드 블록 다음에 .stop을 호출하세요. ()

Python 타이머 컨텍스트 관리자

Python에는 코드 블록 전후에 함수를 호출하기 위한 고유한 구조인 컨텍스트 관리자가 있습니다.

Python의 컨텍스트 관리자에 대해 알아보세요

컨텍스트 관리자는 오랫동안 Python의 중요한 부분이었습니다. 2005년 PEP 343에 의해 도입되었으며 Python 2.5에서 처음 구현되었습니다. 코드의 컨텍스트 관리자는 with 키워드를 사용하여 식별할 수 있습니다.

with EXPRESSION as VARIABLE:
BLOCK

EXPRESSION은 컨텍스트 관리자를 반환하는 Python 표현식입니다. 먼저 컨텍스트 관리자는 변수 이름 VARIABLE에 바인딩되며 BLOCK은 일반 Python 코드 블록이 될 수 있습니다. 컨텍스트 관리자는 프로그램이 BLOCK 이전에 일부 코드를 호출하고 BLOCK이 실행된 후에 다른 코드를 호출하도록 보장합니다. 이러한 방식으로 BLOCK이 예외를 발생시키더라도 후자는 계속 실행됩니다.

컨텍스트 관리자의 가장 일반적인 용도는 파일, 잠금, 데이터베이스 연결과 같은 다양한 리소스를 처리하는 것입니다. 컨텍스트 관리자는 리소스가 사용된 후 리소스를 해제하고 정리하는 데 사용됩니다. 다음 예에서는 콜론이 포함된 행만 인쇄하여 타이머.py의 기본 구조를 보여줍니다. 또한 Python에서 파일을 여는 일반적인 관용구를 보여줍니다.

with open("timer.py") as fp:
print("".join(ln for ln in fp if ":" in ln))

class TimerError(Exception):
class Timer:
timers: ClassVar[Dict[str, float]] = {}
name: Optional[str] = None
text: str = "Elapsed time: {:0.4f} seconds"
logger: Optional[Callable[[str], None]] = print
_start_time: Optional[float] = field(default=None, init=False, repr=False)
def __post_init__(self) -> None:
if self.name is not None:
def start(self) -> None:
if self._start_time is not None:
def stop(self) -> float:
if self._start_time is None:
if self.logger:
if self.name:

open()을 컨텍스트 관리자로 사용하면 파일 포인터 fp가 명시적으로 닫히지 않으므로 fp가 자동으로 닫히는 것을 확인할 수 있습니다.

fp.closed

True

여기에서 예에서 open("timer.py")는 컨텍스트 관리자를 반환하는 표현식입니다. 이 컨텍스트 관리자는 fp라는 이름에 바인딩됩니다. 컨텍스트 관리자는 print() 실행 중에 유효합니다. 이 한 줄 코드 블록은 fp 의 컨텍스트에서 실행됩니다.

fp는 컨텍스트 관리자라는 뜻인가요? 기술적으로 말하면, fp는 컨텍스트 관리자 프로토콜을 구현합니다. Python 언어에는 다양한 프로토콜이 있습니다. 프로토콜을 코드가 구현해야 하는 특정 메서드를 명시하는 계약으로 생각하세요.

컨텍스트 관리자 프로토콜은 두 가지 방법으로 구성됩니다.

1. .__enter__()는 컨텍스트 관리자와 연결된 컨텍스트에 들어갈 때 호출됩니다.
2. 컨텍스트 관리자와 연결된 컨텍스트를 종료할 때 .__exit__()를 호출했습니다.

즉, 컨텍스트 관리자를 직접 만들려면 .__enter__() 및 .__exit__() 를 구현하는 클래스를 작성해야 합니다. Hello, World! 컨텍스트 관리자 예제를 시도해 보세요.

# studio.py
class Studio:
def __init__(self, name):
self.name = name

def __enter__(self):
print(f"你好 {self.name}")
return self

def __exit__(self, exc_type, exc_value, exc_tb):
print(f"一会儿见, {self.name}")

Studio는 컨텍스트 관리자 프로토콜을 구현하고 다음과 같이 사용되는 컨텍스트 관리자입니다.

from studio import Studio
with Studio("云朵君"):
print("正在忙 ...")

你好 云朵君
正在忙 ...
一会儿见, 云朵君

먼저, 작업을 수행하기 전에 .__enter__()가 어떻게 호출되는지 확인하고 .__exit__ ()는 작업을 수행한 후에 호출됩니다. 이 예에서는 컨텍스트 관리자가 참조되지 않으므로 컨텍스트 관리자의 이름을 지정하기 위해 as를 사용할 필요가 없습니다.

다음으로, self.__enter__()의 반환 값에는 제약 조건이 적용된다는 점에 유의하세요. 컨텍스트 관리자를 생성할 때 일반적으로 .__enter__() 에서 self 를 반환하려고 합니다. 반환 값은 다음과 같이 사용할 수 있습니다.

from greeter import Greeter
with Greeter("云朵君") as grt:
print(f"{grt.name} 正在忙 ...")

你好 云朵君
云朵君 正在忙 ...
一会儿见, 云朵君

__exit__ 함수를 작성할 때 주의해야 할 점은 다음 세 가지 매개 변수가 있어야 합니다.

• exc_type: 예외 유형
• exc_val: 예외 값
• exc_tb: 예외 오류 스택 정보

이 세 가지 매개 변수는 컨텍스트 관리자에서 오류 처리에 사용되며 sys.exc_info()의 반환 값과 함께 반환됩니다. 기본 논리 코드가 예외를 보고하지 않으면 이 세 가지 매개변수는 모두 None이 됩니다.

블록을 실행하는 동안 예외가 발생하면 코드는 예외 유형, 예외 인스턴스 및 역추적 객체(예: ex_type, ex_value 및 exc_tb)를 사용하여 .__exit__()를 호출합니다. 일반적으로 이는 컨텍스트 관리자에서 무시되며 예외가 발생하기 전에 .__exit__()가 호출됩니다.

from greeter import Greeter
with Greeter("云朵君") as grt:
print(f"{grt.age} does not exist")

你好 云朵君
一会儿见, 云朵君
Traceback (most recent call last):
File "<stdin>", line 2, in <module>
AttributeError: 'Greeter' object has no attribute 'age'

보시다시피 코드에 오류가 있어도 "곧 만나요, 윤 듀오 씨" 여전히 인쇄되어 있습니다.

contextlib 이해 및 사용

이제 우리는 컨텍스트 관리자가 무엇인지, 그리고 컨텍스트 관리자를 만드는 방법에 대해 미리 이해했습니다. 위의 예에서는 컨텍스트 관리자를 구축하기 위해 클래스를 작성했습니다. 단지 간단한 함수를 구현하고 싶다면 클래스를 작성하는 것이 너무 복잡합니다. 이때 우리는 하나의 함수만 작성하여 컨텍스트 관리자를 구현할 수 있으면 좋겠다고 생각했습니다.

Python은 이미 이것을 생각했습니다. 이는 데코레이터를 제공합니다. 코드 프로토콜에 따라 함수 내용을 구현하는 한 이 함수 객체를 컨텍스트 관리자로 바꿀 수 있습니다.

我们按照 contextlib 的协议来自己实现一个上下文管理器，为了更加直观我们换个用例，创建一个我们常用且熟悉的打开文件（with open）的上下文管理器。

import contextlib

@contextlib.contextmanager
def open_func(file_name):
# __enter__方法
print('open file:', file_name, 'in __enter__')
file_handler = open(file_name, 'r')
 
# 【重点】：yield
yield file_handler

# __exit__方法
print('close file:', file_name, 'in __exit__')
file_handler.close()
return

with open_func('test.txt') as file_in:
for line in file_in:
print(line)

在被装饰函数里，必须是一个生成器（带有yield），而 yield 之前的代码，就相当于__enter__里的内容。yield 之后的代码，就相当于__exit__ 里的内容。

上面这段代码只能实现上下文管理器的第一个目的（管理资源），并不能实现第二个目的（处理异常）。

如果要处理异常，可以改成下面这个样子。

import contextlib

@contextlib.contextmanager
def open_func(file_name):
# __enter__方法
print('open file:', file_name, 'in __enter__')
file_handler = open(file_name, 'r')

try:
yield file_handler
except Exception as exc:
# deal with exception
print('the exception was thrown')
finally:
print('close file:', file_name, 'in __exit__')
file_handler.close()
return

with open_func('test.txt') as file_in:
for line in file_in:
1/0
print(line)

Python 标准库中的 contextlib包括定义新上下文管理器的便捷方法，以及可用于关闭对象、抑制错误甚至什么都不做的现成上下文管理器！

创建 Python 计时器上下文管理器

了解了上下文管理器的一般工作方式后，要想知道它们是如何帮助处理时序代码呢？假设如果可以在代码块之前和之后运行某些函数，那么就可以简化 Python 计时器的工作方式。其实，上下文管理器可以自动为计时时显式调用 .start() 和.stop()。

同样，要让 Timer 作为上下文管理器工作，它需要遵守上下文管理器协议，换句话说，它必须实现 .__enter__() 和 .__exit__() 方法来启动和停止 Python 计时器。从目前的代码中可以看出，所有必要的功能其实都已经可用，因此只需将以下方法添加到之前编写的的 Timer 类中即可：

# timer.py
@dataclass
class Timer:
# 其他代码保持不变

def __enter__(self):
"""Start a new timer as a context manager"""
self.start()
return self

def __exit__(self, *exc_info):
"""Stop the context manager timer"""
self.stop()

Timer 现在就是一个上下文管理器。实现的重要部分是在进入上下文时， .__enter__() 调用 .start() 启动 Python 计时器，而在代码离开上下文时， .__exit__() 使用 .stop() 停止 Python 计时器。

from timer import Timer
import time
with Timer():
time.sleep(0.7)

Elapsed time: 0.7012 seconds

此处注意两个更微妙的细节：

• .__enter__()​ 返回self​，Timer 实例，它允许用户使用as​ 将Timer ​实例绑定到变量。例如，使用with Timer() as t:​ 将创建指向Timer ​对象的变量t。
• .__exit__()​ 需要三个参数，其中包含有关上下文执行期间发生的任何异常的信息。代码中，这些参数被打包到一个名为exc_info 的元组中，然后被忽略，此时 Timer 不会尝试任何异常处理。

在这种情况下不会处理任何异常。上下文管理器的一大特点是，无论上下文如何退出，都会确保调用.__exit__()。在以下示例中，创建除零公式模拟异常查看代码功能：

from timer import Timer
with Timer():
for num in range(-3, 3):
print(f"1 / {num} = {1 / num:.3f}")

1 / -3 = -0.333
1 / -2 = -0.500
1 / -1 = -1.000
Elapsed time: 0.0001 seconds
Traceback (most recent call last):
File "<stdin>", line 3, in <module>
ZeroDivisionError: division by zero

注意 ，即使代码抛出异常，Timer 也会打印出经过的时间。

使用 Python 定时器上下文管理器

现在我们将一起学习如何使用 Timer 上下文管理器来计时 "下载数据" 程序。回想一下之前是如何使用 Timer 的：

# download_data.py
import requests
from timer import Timer
def main():
t = Timer()
t.start()
source_url = 'https://cloud.tsinghua.edu.cn/d/e1ccfff39ad541908bae/files/?p=%2Fall_six_datasets.zip&dl=1'
headers = {'User-Agent': 'Mozilla/5.0'}
res = requests.get(source_url, headers=headers) 
t.stop()
with open('dataset/datasets.zip', 'wb') as f:
f.write(res.content)

if __name__ == "__main__":
main()

我们正在对 requests.get() 的调用进行记时监控。使用上下文管理器可以使代码更短、更简单、更易读：

# download_data.py
import requests
from timer import Timer
def main():
source_url = 'https://cloud.tsinghua.edu.cn/d/e1ccfff39ad541908bae/files/?p=%2Fall_six_datasets.zip&dl=1'
headers = {'User-Agent': 'Mozilla/5.0'}
with Timer():
res = requests.get(source_url, headers=headers)

with open('dataset/datasets.zip', 'wb') as f:
f.write(res.content)

if __name__ == "__main__":
main()

此代码实际上与上面的代码相同。主要区别在于没有定义无关变量t，在命名空间上无多余的东西。

写在最后

将上下文管理器功能添加到 Python 计时器类有几个优点：

• 省时省力：只需要一行额外的代码即可为代码块的执行计时。
• 可读性高：调用上下文管理器是可读的，你可以更清楚地可视化你正在计时的代码块。

使用 Timer 作为上下文管理器几乎与直接使用 .start() 和 .stop() 一样灵活，同时它的样板代码更少。在该系列下一篇文章中，云朵君将和大家一起学习如何将 Timer 也用作装饰器，并用于代码中，从而更加容易地监控代码完整运行过程，我们一起期待吧！

위 내용은 컨텍스트 관리자를 사용하여 Python 타이머를 확장하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!