Python には、コード ブロックの前後で関数を呼び出すための独自の構造 Context Manager があります。
コンテキスト マネージャーは、長い間 Python の重要な部分でした。 2005 年に PEP 343 によって導入され、Python 2.5 で最初に実装されました。 with キーワードを使用して、コード内のコンテキスト マネージャーを識別できます。
with EXPRESSION as VARIABLE:
BLOCKEXPRESSION は、コンテキスト マネージャーを返す Python 式です。まず、コンテキスト マネージャーは変数名 VARIABLE にバインドされます。ここで、BLOCK は通常の Python コード ブロックです。コンテキスト マネージャーは、プログラムが BLOCK の前に何らかのコードを呼び出し、BLOCK の実行後に他のコードを呼び出すことを保証します。このようにして、BLOCK が例外をスローした場合でも、後者は引き続き実行されます。
コンテキスト マネージャーの最も一般的な用途は、ファイル、ロック、データベース接続などのさまざまなリソースを処理することです。 コンテキスト マネージャーは、リソースを使用した後に解放し、クリーンアップするために使用されます。次の例は、コロンを含む行のみを出力することにより、timer.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() の実行中に有効です。この 1 行のコード ブロックは、fp のコンテキストで実行されます。
fp コンテキスト マネージャーとは何を意味しますか?技術的に言えば、fp は Context Manager Protocol を実装します。 Python 言語の基礎となるプロトコルは数多くあります。プロトコルは、コードがどのような特定のメソッドを実装する必要があるかを規定する契約であると考えてください。
コンテキスト マネージャー プロトコルは 2 つのメソッドで構成されます:
コンテキスト マネージャーに関連付けられたコンテキストに入るときに呼び出されます .__enter__()。
コンテキスト マネージャー .__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__() の戻り値には as 制約が適用されることに注意してください。コンテキスト マネージャーを作成するときは、通常、.__enter__() から self を返します。戻り値は次のように使用できます。
from greeter import Greeter
with Greeter("云朵君") as grt:
print(f"{grt.name} 正在忙 ...")こんにちは、Yun DuojunYunduo Jun は忙しいです...
また会いましょう、Yunduo Jun
__exit__ 関数を記述するときは、次の 3 つのパラメータが必要であることに注意する必要があります:
exc_type: 例外タイプ
exc_val：例外値
exc_tb：例外エラースタック情報
sys.exc_info() の戻り値として返されます。メイン ロジック コードが例外を報告しない場合、これら 3 つのパラメーターはすべて None になります。
exc_type、exc_value、##) を使用します。 #exc_tb) .__exit__() を呼び出します。通常、これらはコンテキスト マネージャーで無視され、例外が発生する前に .__exit__() が呼び出されます。 <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:py;">from greeter import Greeter
with Greeter("云朵君") as grt:
print(f"{grt.age} does not exist")</pre><div class="contentsignin">ログイン後にコピー</div></div>
また会いましょう、Yun Duojun「また会いましょう、Yun Duo さん」トレースバック (最後の呼び出し):
コードにエラーがあっても、
ファイル ""、2 行目、
AttributeError: 'Greeter' オブジェクトには属性 'age' がありません
が出力されることがわかります。 <h4>理解并使用 contextlib</h4><p>现在我们初步了解了上下文管理器是什么以及如何创建自己的上下文管理器。在上面的例子中，我们只是为了构建一个上下文管理器，却写了一个类。如果只是要实现一个简单的功能，写一个类未免有点过于繁杂。这时候，我们就想，如果只写一个函数就可以实现上下文管理器就好了。</p><p>这个点Python早就想到了。它给我们提供了一个装饰器，你只要按照它的代码协议来实现函数内容，就可以将这个函数对象变成一个上下文管理器。</p><p>我们按照 contextlib 的协议来自己实现一个上下文管理器，为了更加直观我们换个用例，创建一个我们常用且熟悉的打开文件（with open）的上下文管理器。</p><div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:py;">import contextlib
@contextlib.contextmanager
def open_func(file_name):
# __enter__方法
print(&#39;open file:&#39;, file_name, &#39;in __enter__&#39;)
file_handler = open(file_name, &#39;r&#39;)
# 【重点】：yield
yield file_handler
# __exit__方法
print(&#39;close file:&#39;, file_name, &#39;in __exit__&#39;)
file_handler.close()
return
with open_func(&#39;test.txt&#39;) as file_in:
for line in file_in:
print(line)</pre><div class="contentsignin">ログイン後にコピー</div></div><p>在被装饰函数里，必须是一个生成器（带有<code>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 计时器的工作方式。其实，上下文管理器可以自动为计时时显式调用 .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 "", line 3, in
ZeroDivisionError: division by zero
注意 ，即使代码抛出异常，Timer 也会打印出经过的时间。
现在我们将一起学习如何使用 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()以上がコンテキストマネージャーを使用してPythonのタイマーを拡張するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。
![[Web フロントエンド] Node.js クイック スタート](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
