Python3中contextvars模塊是什么

不懂Python3中contextvars模塊是什么？其實(shí)想解決這個(gè)問(wèn)題也不難，下面讓小編帶著大家一起學(xué)習(xí)怎么去解決，希望大家閱讀完這篇文章后大所收獲。

什么是上下文(Context)？

Context Variables，也就是「上下文變量」。

Context是一個(gè)包含了相關(guān)環(huán)境內(nèi)容的對(duì)象。這不是什么很高深的設(shè)計(jì)，其實(shí)和我們的日常生活也是息息相關(guān)的。

舉個(gè)比較實(shí)時(shí)的例子，權(quán)力的游戲第八季剛開(kāi)播，如果你沒(méi)看過(guò)前七季，不了解過(guò)去的劇情、人物關(guān)系、過(guò)去的種種主線副線發(fā)展，去看第八季第一集是完全看不懂的，因?yàn)槟闳笔Я诉@個(gè)美劇的上下文。

上下文就帶著這些信息，如果有一人非常了解過(guò)去的那些劇情甚至看過(guò)原著，Ta可以把那些第八季能關(guān)聯(lián)到的故事、劇情搞一個(gè)視頻剪輯（上下文對(duì)象），那么你不需要把過(guò)去完整的七季完整看一遍，可能花一個(gè)小時(shí)看看這個(gè)視頻（獲得上下文對(duì)象），就能繼續(xù)看第八季（完成之后的操作）。

Flask的設(shè)計(jì)中就包含了Context(下面不再說(shuō)上下文，而統(tǒng)一用Context)。這個(gè)設(shè)計(jì)有什么用呢？簡(jiǎn)單地說(shuō)：可以在一些場(chǎng)景下隱式地傳遞變量

我們看一下Django和Sanic怎么傳遞請(qǐng)求對(duì)象Request:

# Django
from django.http import HttpResponse
def index(request):
    text = request.GET.get('text')
    return HttpResponse(f'Text is {text}')
# Sanic
from sanic import response
app = Sanic()
@app.route('/')
async def index(request):
    text = request.args.get('text')
    return response.text(f'Text is {text}')

這2個(gè)框架都有一個(gè)問(wèn)題：視圖函數(shù)上要顯式的傳遞request（請(qǐng)求對(duì)象）。我們?cè)倏纯碏lask的效果:

from flask import Flask, request
app = Flask(__name__)
@app.route('/')
def index():
    text = request.args.get('text')
    return f'Text is {text}'

在Flask中，request是import進(jìn)來(lái)使用的（不需要就不用import），和視圖解耦了。這種設(shè)計(jì)下，不需要像Django/Sanic那樣把參數(shù)傳來(lái)傳去。

ThreadLocal

Flask怎么實(shí)現(xiàn)的呢？這就引出了ThreadLocal（本地線程）對(duì)象，看名字可以知道它是線程安全的，是單個(gè)線程自己的局部變量。Flask的實(shí)現(xiàn)中并沒(méi)有直接用Python的ThreadLocal，而是自己實(shí)現(xiàn)了一個(gè)Local類(lèi)，除了支持線程還支持了Greenlet的協(xié)程。

Q: 那為什么不用全局變量呢？ A: 由于存在GIL，全局變量的修改必須加鎖，會(huì)影響效率

先看一下線程庫(kù)中ThreadLocal的例子：

? cat threadlocal_example.py
import random
import threading
local_data = threading.local()
def show():
    name = threading.current_thread().getName()
    try:
        val = local_data.value
    except AttributeError:
        print(f'Thread {name}: No value yet')
    else:
        print(f'Thread {name}: {val}')
def worker():
    show()
    local_data.value = random.randint(1, 100)
    show()
for i in range(2):
    t = threading.Thread(target=worker)
    t.start()
? python threadlocal_example.py
Thread Thread-1: No value yet
Thread Thread-1: 78
Thread Thread-2: No value yet
Thread Thread-2: 64

可以感受到2個(gè)線程的狀態(tài)互不影響。回到Flask，請(qǐng)求Context在內(nèi)部作為一個(gè)棧來(lái)維護(hù)（應(yīng)用Context在另外一個(gè)棧）。每個(gè)訪問(wèn)Flask的請(qǐng)求，會(huì)綁定到當(dāng)前的Context，等請(qǐng)求結(jié)束后再銷(xiāo)毀。維護(hù)的過(guò)程由框架實(shí)現(xiàn)，開(kāi)發(fā)者不需要關(guān)心，你只需要用flask.request就可以了，這樣就提高了接口的可讀性和擴(kuò)展性。

contextvars例子

threading.local的隔離效果很好，但是他是針對(duì)線程的，隔離線程之間的數(shù)據(jù)狀態(tài)。但是現(xiàn)在有了asyncio，怎么辦？

biu~ 我們回到contextvars，這個(gè)模塊提供了一組接口，可用于管理、儲(chǔ)存、訪問(wèn)局部Context的狀態(tài)。我們看個(gè)例子：

? cat contextvar_example.py
import asyncio
import contextvars
# 申明Context變量
request_id = contextvars.ContextVar('Id of request')
async def get():
    # Get Value
    print(f'Request ID (Inner): {request_id.get()}')
async def new_coro(req_id):
    # Set Value
    request_id.set(req_id)
    await get()
    print(f'Request ID (Outer): {request_id.get()}')
async def main():
    tasks = []
    for req_id in range(1, 5):
        tasks.append(asyncio.create_task(new_coro(req_id)))
    await asyncio.gather(*tasks)
asyncio.run(main())
? python contextvar_example.py
Request ID (Inner): 1
Request ID (Outer): 1
Request ID (Inner): 2
Request ID (Outer): 2
Request ID (Inner): 3
Request ID (Outer): 3
Request ID (Inner): 4
Request ID (Outer): 4

可以看到在數(shù)據(jù)狀態(tài)協(xié)程之間互不影響。注意上面contextvars.ContextVar的傳入的第一個(gè)參數(shù)(name)值是一個(gè)字符串，它主要是用來(lái)標(biāo)識(shí)和調(diào)試的，并不一定要用一個(gè)單詞或者用下劃線連起來(lái)。

注意，這個(gè)模塊不僅僅給aio加入Context的支持，也用來(lái)替代threading.local()。

在Python 3.6使用contextvars

contextvars實(shí)現(xiàn)了PEP 567, 如果在Python3.6想使用可以用MagicStack/contextvars這個(gè)向后移植庫(kù)，它和標(biāo)準(zhǔn)庫(kù)都是同一個(gè)作者寫(xiě)的，可以放心使用。用之前你需要安裝它:

pip install contextvars
aiotask_context

在Sanic里面request確實(shí)沒(méi)有用Context，那在aio體系里面怎么用呢？原來(lái)我會(huì)使用一個(gè)獨(dú)立的庫(kù)aiotask_context，在我的技術(shù)博客項(xiàng)目中就有用到，我簡(jiǎn)化一下這部分的代碼(延伸閱讀3的commit)：

# ext.py
import aiotask_context as context  # noqa
# app.py
from ext import context
client = None
@app.listener('before_server_start')
async def setup_db(app, loop):
    global client
    client = aiomcache.Client(config.MEMCACHED_HOST, config.MEMCACHED_PORT, loop=loop)
    loop.set_task_factory(context.task_factory)
@app.middleware('request')
async def setup_context(request):
    context.set('memcache', client)
# models/mc.py
_memcache = None
async def get_memcache():
    global _memcache
    if _memcache is not None:
        return _memcache
    memcache = context.get('memcache')
    _memcache = memcache
    return memcache

按執(zhí)行過(guò)程，我解釋一下：

app.py默認(rèn)client是None，在before_server_start中會(huì)設(shè)置初始化一個(gè)aiomcache.Client，用global設(shè)置給client

每次請(qǐng)求，通過(guò)context.set('memcache', client)把client設(shè)置到Context里面

在實(shí)際業(yè)務(wù)中，直接用context.get('memcache')獲取這個(gè)client。整個(gè)邏輯中見(jiàn)不到client傳來(lái)傳去，也不需要給request設(shè)置額外的屬性

有一點(diǎn)要提，在Python 3.6, context接受的參數(shù)必須是ContextVar對(duì)象，要這么寫(xiě)：

if PY36:
    import contextvars
    memcache_var = contextvars.ContextVar('memcache')
else:
    memcache_var = 'memcache'
try:
    memcache = context.get(memcache_var)
except AttributeError:
    # Hack for debug mode
    memcache = None

這里捕獲了AttributeError，主要是在ipython中調(diào)試，由于沒(méi)有啟動(dòng)Sanic所以沒(méi)有設(shè)置上下文，所以需要異常處理一下。

contextvars的真實(shí)例子

接著替換成contextvars(延伸閱讀鏈接4的commit)：

# models/var.py
import contextvars
memcache_var = contextvars.ContextVar('memcache')
# app.py
from models.var import memcache_var
client = None
@app.listener('before_server_start')
async def setup_db(app, loop):
    global client
    client = aiomcache.Client(config.MEMCACHED_HOST, config.MEMCACHED_PORT, loop=loop)
@app.middleware('request')
async def setup_context(request):
    memcache_var.set(client)
# models/mc.py
from models.var import memcache_var
_memcache = None
async def get_memcache():
    global _memcache
    if _memcache is not None:
        return _memcache
    memcache = memcache_var.get()
    _memcache = memcache
    return memcache

在這種模式下，memcache(Redis)等實(shí)例對(duì)象不需要放在request對(duì)象里面，也不需要傳來(lái)傳去，而是放在一個(gè)上下文中，需要時(shí)直接通過(guò)memcache_var.get()就可以拿到，繼而操作緩存了。

感謝你能夠認(rèn)真閱讀完這篇文章，希望小編分享Python3中contextvars模塊是什么內(nèi)容對(duì)大家有幫助，同時(shí)也希望大家多多支持億速云，關(guān)注億速云行業(yè)資訊頻道，遇到問(wèn)題就找億速云，詳細(xì)的解決方法等著你來(lái)學(xué)習(xí)!