Bagaimana untuk melanjutkan pemasa Python menggunakan pengurus konteks?

Pengurus konteks pemasa Python

Python mempunyai binaan unik untuk memanggil fungsi sebelum dan selepas blok kod: Pengurus konteks.

Memahami pengurus konteks dalam Python

Pengurus konteks telah menjadi bahagian penting Python sejak sekian lama. Diperkenalkan oleh PEP 343 pada tahun 2005 dan pertama kali dilaksanakan dalam Python 2.5. Anda boleh menggunakan kata kunci with untuk mengenal pasti pengurus konteks dalam kod anda:

with EXPRESSION as VARIABLE:
    BLOCK

EXPRESSION ialah ungkapan Python yang mengembalikan pengurus konteks. Mula-mula pengurus konteks terikat kepada nama pembolehubah VARIABLE, yang boleh menjadi sebarang blok kod Python biasa. Pengurus konteks memastikan bahawa atur cara memanggil beberapa kod sebelum BLOCK dan beberapa kod lain selepas BLOCK dilaksanakan. Dengan cara ini, walaupun BLOCK melemparkan pengecualian, yang terakhir akan tetap dilaksanakan. BLOCK

Penggunaan pengurus konteks yang paling biasa adalah untuk mengendalikan sumber yang berbeza, seperti fail, kunci dan sambungan pangkalan data. Pengurus konteks digunakan untuk melepaskan dan membersihkan sumber selepas menggunakannya. Contoh berikut menunjukkan struktur asas dengan mencetak hanya garisan yang mengandungi titik bertindih. Selain itu, ia menunjukkan simpulan bahasa biasa untuk membuka fail dalam Python: timer.py

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:

Perhatikan bahawa menggunakan

sebagai pengurus konteks, penuding fail open() tidak ditutup secara eksplisit, anda boleh mengesahkan bahawa fp mempunyai telah Autotutup: fp

fp.closed

Benar

Dalam contoh ini,

ialah ungkapan yang mengembalikan pengurus konteks. Pengurus konteks ini terikat pada nama open("timer.py") . Pengurus konteks adalah sah semasa pelaksanaan fp. Blok satu baris kod ini dilaksanakan dalam konteks print()  . fp

Apakah yang dimaksudkan bahawa ia adalah pengurus konteks? Dari segi teknikal, fp melaksanakan fpProtokol Pengurus Konteks. Terdapat banyak protokol berbeza yang mendasari bahasa Python. Fikirkan protokol sebagai kontrak yang menyatakan kaedah khusus yang mesti dilaksanakan oleh kod kami.

Protokol pengurus konteks terdiri daripada dua kaedah:

• Dipanggil apabila memasuki konteks yang dikaitkan dengan pengurus konteks

  . .__enter__()

• Dipanggil apabila keluar dari konteks yang dikaitkan dengan pengurus konteks

  . .__exit__()

Dengan kata lain, untuk mencipta pengurus konteks anda sendiri, anda perlu menulis kelas yang melaksanakan

dan .__enter__()  . Cuba .__exit__() contoh pengurus konteks: 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}")

ialah pengurus konteks yang melaksanakan protokol pengurus konteks dan digunakan seperti berikut: Studio

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

Hello Yunduo Jun

sibuk...
Jumpa lagi, Encik Yun Duo

Pertama sekali, perhatikan bagaimana

dipanggil sebelum melakukan sesuatu, manakala  .__enter__() dipanggil selepas melakukan sesuatu dipanggil. Dalam contoh ini, tiada rujukan kepada pengurus konteks, jadi tidak perlu menggunakan  .__exit__() untuk menamakan pengurus konteks. as

Seterusnya, ambil perhatian bahawa nilai pulangan

dikekang oleh self.__enter__() . Apabila membuat pengurus konteks, anda biasanya mahu mengembalikan as daripada .__enter__() . Nilai pulangan boleh digunakan seperti berikut: self

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

Hello Encik Yun Duo

Encik Yun Duo sedang sibuk...
Jumpa lagi, Encik Yun Duo

Semasa menulis fungsi

, anda perlu memberi perhatian kepadanya Ia mesti mempunyai tiga parameter ini: __exit__

• : Jenis pengecualian exc_type.

• : Nilai pengecualianexc_val

• : Maklumat susunan ralat pengecualianexc_tb

Tiga parameter ini digunakan untuk pengurus konteks Ralat pengendalian dalam , ia dikembalikan dengan nilai pulangan

. Apabila kod logik utama tidak melaporkan pengecualian, ketiga-tiga parameter ini semuanya akan menjadi Tiada. sys.exc_info()

Jika pengecualian berlaku semasa melaksanakan blok, maka kod akan memanggil

dengan jenis pengecualian, contoh pengecualian dan objek surih balik (iaitu, exc_type, exc_value dan exc_tb) . Biasanya, ini diabaikan dalam pengurus konteks dan .__exit__() dipanggil sebelum menimbulkan pengecualian: .__exit__()

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

Hello Yun Duojun

Jumpa lagi, Yun Duojun
Traceback (panggilan terbaharu terakhir):
Fail "c2f32e7e9231c3bf5bf9f218b5147824", baris 2, dalam 4225fa317875f3e92281a7b1a5733569
AttributeError: Objek 'Greeter' tidak mempunyai atribut 'age'

Seperti yang anda lihat , walaupun terdapat ralat dalam kod,

masih dicetak. "一会儿见, 云朵君"

理解并使用 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 "c2f32e7e9231c3bf5bf9f218b5147824", line 3, in 4225fa317875f3e92281a7b1a5733569
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()

Atas ialah kandungan terperinci Bagaimana untuk melanjutkan pemasa Python menggunakan pengurus konteks?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!