编辑“︁Python 上下文管理器”︁

= Python上下文管理器 =

'''上下文管理器'''（Context Manager）是Python中用于管理资源（如文件、数据库连接、网络连接等）的一种机制，它确保资源在使用后被正确释放，即使在处理过程中发生异常。上下文管理器通过<code>with</code>语句实现，简化了资源管理的代码，并提高了可读性和安全性。

== 基本概念 ==

上下文管理器的主要功能是：
* 在进入代码块前分配资源（如打开文件）。
* 在代码块执行完毕后释放资源（如关闭文件），无论代码块是否抛出异常。

Python中的上下文管理器通过实现<code>__enter__</code>和<code>__exit__</code>方法来定义。此外，Python标准库中的<code>contextlib</code>模块提供了简化上下文管理器创建的工具。

=== 使用<code>with</code>语句 ===

最常见的上下文管理器使用方式是<code>with</code>语句，语法如下：
<syntaxhighlight lang="python">
with context_manager as variable:
    # 使用资源的代码块
</syntaxhighlight>

例如，文件操作通常使用<code>with</code>语句：
<syntaxhighlight lang="python">
with open('example.txt', 'r') as file:
    content = file.read()
    print(content)
</syntaxhighlight>
'''输出：'''
<pre>
文件内容（如果example.txt存在）
</pre>

在这个例子中，<code>open()</code>函数返回的文件对象是一个上下文管理器，它会在代码块执行完毕后自动关闭文件，即使发生异常。

== 实现自定义上下文管理器 ==

可以通过两种方式实现自定义上下文管理器：
1. 使用类实现<code>__enter__</code>和<code>__exit__</code>方法。
2. 使用<code>contextlib.contextmanager</code>装饰器生成器函数。

=== 类实现方式 ===

以下是一个自定义上下文管理器的类实现示例：
<syntaxhighlight lang="python">
class CustomContextManager:
    def __enter__(self):
        print("进入上下文，分配资源")
        return self  # 可以返回一个对象供as语句使用

    def __exit__(self, exc_type, exc_value, traceback):
        print("退出上下文，释放资源")
        if exc_type is not None:
            print(f"发生异常: {exc_value}")
        return True  # 如果返回True，则抑制异常

with CustomContextManager() as manager:
    print("执行代码块")
    # raise ValueError("测试异常")  # 取消注释测试异常处理
</syntaxhighlight>
'''输出：'''
<pre>
进入上下文，分配资源
执行代码块
退出上下文，释放资源
</pre>

=== 生成器实现方式 ===

使用<code>contextlib.contextmanager</code>可以更简洁地实现上下文管理器：
<syntaxhighlight lang="python">
from contextlib import contextmanager

@contextmanager
def custom_context_manager():
    print("进入上下文，分配资源")
    try:
        yield "资源对象"  # yield之前的部分相当于__enter__，之后的部分相当于__exit__
    finally:
        print("退出上下文，释放资源")

with custom_context_manager() as resource:
    print(f"使用 {resource}")
    # raise ValueError("测试异常")  # 取消注释测试异常处理
</syntaxhighlight>
'''输出：'''
<pre>
进入上下文，分配资源
使用 资源对象
退出上下文，释放资源
</pre>

== 实际应用场景 ==

上下文管理器在以下场景中非常有用：

=== 文件操作 ===
确保文件在使用后正确关闭：
<syntaxhighlight lang="python">
with open('data.csv', 'w') as file:
    file.write("name,age\nAlice,30\nBob,25")
</syntaxhighlight>

=== 数据库连接管理 ===
确保数据库连接在使用后关闭：
<syntaxhighlight lang="python">
import sqlite3

with sqlite3.connect('database.db') as conn:
    cursor = conn.cursor()
    cursor.execute("SELECT * FROM users")
    print(cursor.fetchall())
</syntaxhighlight>

=== 临时修改状态 ===
临时修改系统状态并在完成后恢复：
<syntaxhighlight lang="python">
import os
from contextlib import contextmanager

@contextmanager
def temp_env_var(key, value):
    original = os.environ.get(key)
    os.environ[key] = value
    try:
        yield
    finally:
        if original is not None:
            os.environ[key] = original
        else:
            del os.environ[key]

with temp_env_var('DEBUG', '1'):
    print(os.environ['DEBUG'])  # 输出: 1
print(os.environ.get('DEBUG'))  # 输出: None（假设原环境中没有DEBUG变量）
</syntaxhighlight>

=== 计时器 ===
测量代码块的执行时间：
<syntaxhighlight lang="python">
import time
from contextlib import contextmanager

@contextmanager
def timer():
    start = time.time()
    try:
        yield
    finally:
        end = time.time()
        print(f"执行时间: {end - start:.2f}秒")

with timer():
    time.sleep(1)  # 模拟耗时操作
</syntaxhighlight>
'''输出：'''
<pre>
执行时间: 1.00秒
</pre>

== 高级主题 ==

=== 多个上下文管理器 ===

可以同时使用多个上下文管理器：
<syntaxhighlight lang="python">
with open('input.txt', 'r') as infile, open('output.txt', 'w') as outfile:
    outfile.write(infile.read())
</syntaxhighlight>

=== 上下文管理器协议 ===

上下文管理器协议由两个方法组成：
* <code>__enter__(self)</code>：进入上下文时调用，返回值赋给<code>as</code>后的变量
* <code>__exit__(self, exc_type, exc_value, traceback)</code>：退出上下文时调用，处理异常

=== 异常处理 ===

<code>__exit__</code>方法接收三个异常参数：
* <code>exc_type</code>：异常类型
* <code>exc_value</code>：异常值
* <code>traceback</code>：追溯信息

如果<code>__exit__</code>返回<code>True</code>，则异常被抑制；返回<code>False</code>或<code>None</code>，则异常继续传播。

== 性能考虑 ==

上下文管理器通常比<code>try-finally</code>块更高效，因为：
* 减少样板代码
* 资源释放逻辑集中在一处
* 更清晰的代码结构

== 常见问题 ==

'''Q: 什么时候应该使用上下文管理器？'''
A: 当需要确保资源（如文件、锁、连接）在使用后被正确释放时，或者需要临时修改状态并在完成后恢复时。

'''Q: 上下文管理器能替代<code>try-finally</code>吗？'''
A: 对于资源管理场景，是的。但对于更复杂的异常处理，可能仍需要<code>try-except</code>。

'''Q: 如何创建异步上下文管理器？'''
A: 实现<code>__aenter__</code>和<code>__aexit__</code>方法，或使用<code>@contextlib.asynccontextmanager</code>。

== 总结 ==

Python上下文管理器是管理资源的强大工具，通过<code>with</code>语句提供了一种清晰、安全的方式来处理资源的获取和释放。无论是使用内置的上下文管理器（如文件对象），还是创建自定义的上下文管理器，都能显著提高代码的健壮性和可读性。

[[Category:编程语言]]
[[Category:Python]]
[[Category:Python 异常处理]]