Python 模块 contextvars

lyjin 2024-01-24

**contextvars** 是 Python 中的一个模块，用于管理上下文局部状态。上下文局部状态类似于线程局部状态，但它是针对当前上下文而不是针对线程。这个特性在异步编程中特别有用，因为单个线程可能处理多个上下文（例如，处理不同的Web请求）。

**contextvars** 模块的关键组成部分如下：

1. **上下文变量（Context Variables）：**这些变量的值对于每个上下文是不同的。可以使用 contextvars.ContextVar 创建上下文变量。

2. **上下文（Context）：**表示上下文变量所存在的上下文。可以创建新的上下文，并可以复制和修改当前上下文。

3. **令牌（Token）：**用于将上下文变量重置为其先前的值。

这里有一个简单的例子，说明如何使用 contextvars：

```python
import contextvars

# 创建一个上下文变量
var = contextvars.ContextVar('var', default=42)

# 修改上下文变量的函数
def modify_var(new_value):
    return var.set(new_value)

# 主函数
def main():
    print("原始值:", var.get())  # 将打印默认值 42

# 修改上下文变量
    token = modify_var(99)
    print("修改后:", var.get())  # 将打印 99

# 使用令牌重置变量为其原始状态
    var.reset(token)
    print("重置后:", var.get())  # 将打印 42

if __name__ == "__main__":
    main()

```

在这个例子中，**var** 是一个默认值为 42 的上下文变量。**modify_var** 函数为 **var** 设置了一个新值。**main** 函数演示了 **var** 在当前上下文中的值是如何改变的，以及如何使用令牌将其重置为之前的值。

在异步应用程序中，上下文变量特别有用，因为全局变量可能由于异步任务的并发性质而导致不正确的行为。每个任务可以拥有自己独立的上下文，确保一个任务中的更改不会影响其他任务。

请登陆后评论