Python上下文管理器实践指南：自定义和内置用法(Python上下文管理器实战教程：自定义与内置用法详解)

原创

ithorizon 6个月前 (10-19) 阅读数 22 #后端开发

Python上下文管理器实践指南：自定义和内置用法

一、引言

在Python编程中，上下文管理器是一个非常强盛的特性，它允许我们在代码块执行前后自动执行一些必要的设置和清理工作。本文将详细介绍Python上下文管理器的用法，包括自定义和内置用法，帮助读者更好地明白和运用这一特性。

二、上下文管理器概念

上下文管理器是一个遵循特定协议的对象，这个协议包括两个方法：`__enter__()` 和 `__exit__()`。当一个上下文管理器被使用在 `with` 语句中时，Python 解释器会自动调用这些方法。

三、内置上下文管理器

Python提供了一些内置的上下文管理器，用于处理常见的任务，如文件操作、网络连接等。

3.1 文件操作

使用 `with open() as` 是最常见的内置上下文管理器的例子。


with open('example.txt', 'w') as file:
    file.write('Hello, world!')

这段代码会自动打开文件，在代码块执行完毕后自动关闭文件，即使在代码块中出现异常也是如此。

3.2 锁

使用 `threading.Lock()` 来确保线程平安。


import threading
lock = threading.Lock()
with lock:
    # 执行一些线程平安的操作
    pass

3.3 其他内置上下文管理器

还有许多其他的内置上下文管理器，如 `contextlib` 模块中的 `contextmanager()` 装饰器，可以轻松地将一个生成器函数转换成一个上下文管理器。

四、自定义上下文管理器

自定义上下文管理器通常涉及创建一个类，该类实现了 `__enter__()` 和 `__exit__()` 方法。

4.1 基本示例

下面是一个易懂的自定义上下文管理器的例子，用于记录函数执行的时间。


import time
class Timer:
    def __enter__(self):
        self.start = time.time()
        return self
    def __exit__(self, exc_type, exc_value, traceback):
        self.end = time.time()
        print(f"Function took {self.end - self.start:.2f} seconds to run.")
with Timer():
    # 执行一些操作
    time.sleep(1)

4.2 处理异常

在 `__exit__()` 方法中，我们可以处理异常，并采取需要决定是否传播它们。


class Timer:
    def __enter__(self):
        self.start = time.time()
        return self
    def __exit__(self, exc_type, exc_value, traceback):
        self.end = time.time()
        if exc_type is not None:
            print(f"An exception occurred: {exc_value}")
            return False  # 传播异常
        else:
            print(f"Function took {self.end - self.start:.2f} seconds to run.")
            return True  # 不传播异常
with Timer():
    # 执行一些或许引发异常的操作
    raise ValueError("An error occurred")

4.3 使用 `contextlib` 创建上下文管理器

`contextlib` 模块提供了一个更易懂的方法来创建上下文管理器，通过 `contextmanager()` 装饰器。


from contextlib import contextmanager
@contextmanager
def timer():
    start = time.time()
    try:
        yield
    finally:
        end = time.time()
        print(f"Function took {end - start:.2f} seconds to run.")
with timer():
    # 执行一些操作
    time.sleep(1)

五、上下文管理器的实际应用

上下文管理器可以应用于许多场景，如数据库连接、网络连接、日志记录等。下面是一个数据库连接的例子。

5.1 数据库连接

假设我们有一个易懂的数据库连接类，我们需要确保连接在操作完成后关闭。


import sqlite3
class DatabaseConnection:
    def __init__(self, db_name):
        self.db_name = db_name
    def __enter__(self):
        self.conn = sqlite3.connect(self.db_name)
        return self.conn
    def __exit__(self, exc_type, exc_value, traceback):
        self.conn.close()
with DatabaseConnection('example.db') as conn:
    cursor = conn.cursor()
    cursor.execute('CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT)')
    cursor.execute('INSERT INTO users (name) VALUES (?)', ('Alice',))
    conn.commit()