contextvars — Variables de contexte

---

Ce module fournit des API pour gérer, stocker et accéder à l'état local de contexte. La classe ContextVar est utilisée pour déclarer et travailler avec les Variables de contexte. La fonction copy_context() et la classe Context doivent être utilisées pour la gestion du contexte actuel dans les cadriciels asynchrones.

Les gestionnaires de contexte, quand ils ont un état et quand ils sont utilisés dans du code s'exécutant de manière concurrente, doivent utiliser les variables de contexte au lieu de threading.local() pour empêcher que leur état ne perturbe un autre fil de manière inattendue.

Voir aussi PEP 567 pour plus de détails.

Nouveau dans la version 3.7.

Variables de contexte

class contextvars.ContextVar(name[, *, default])

Cette classe est utilisée pour déclarer une nouvelle variable de contexte, p. ex. :

var: ContextVar[int] = ContextVar('var', default=42)

Le paramètre requis name est utilisé à des fins d'introspection et de débogage.

Le paramètre nommé default est renvoyé par ContextVar.get() quand aucune valeur n'est trouvée dans le contexte actuel pour la variable.

Important : les variables de contexte doivent être créées au plus haut niveau du module et jamais dans des fermetures (closures). Les objets Context maintiennent des références fortes aux variables de contexte ce qui empêche que les variables de contexte soient correctement nettoyées par le ramasse-miette.

name

Nom de la variable. Cette propriété est en lecture seule.

Nouveau dans la version 3.7.1.

get([default])

Renvoie la valeur de la variable de contexte pour le contexte actuel.

S'il n'y a pas de valeur pour la variable dans le contexte actuel, la méthode :

• renvoie la valeur de l'argument default passé à la méthode, s'il a été fourni ;

• ou renvoie la valeur par défaut de la variable de contexte, si elle a été créée avec une valeur par défaut ;

• ou lève une erreur LookupError.

set(value)

Assigne une nouvelle valeur à la variable de contexte dans le contexte actuel.

L'argument requis value est la nouvelle valeur pour la variable de contexte.

Renvoie un objet Token qui peut être utilisé pour rétablir la variable à sa valeur précédente par la méthode ContextVar.reset().

reset(token)

Réinitialise la variable de contexte à la valeur qu'elle avait avant l'appel de ContextVar.set() qui a créé le token.

Par exemple :

var = ContextVar('var')

token = var.set('new value')
# code that uses 'var'; var.get() returns 'new value'.
var.reset(token)

# After the reset call the var has no value again, so
# var.get() would raise a LookupError.

class contextvars.Token

Les objets Token sont renvoyés par la méthode ContextVar.set(). Ils peuvent être passés à la méthode ContextVar.reset() pour réaffecter la valeur de la variable à ce qu'elle était avant le set correspondant.

Token.var

Propriété en lecture seule. Pointe vers l'objet ContextVar qui a créé le token.

Token.old_value

Propriété en lecture seule. Sa valeur est celle que la variable avait avant l'appel à la méthode ContextVar.set() qui a créé le jeton. Elle pointe à Token.MISSING si la variable n'est pas définie avant l'appel.

Token.MISSING

Objet marqueur utilisé par Token.old_value.

Gestion de contexte manuelle

contextvars.copy_context()

Renvoie une copie de l'objet Context actuel.

Le fragment de code qui suit obtient une copie du contexte actuel et affiche toutes les variables avec leurs valeurs définies dans ce contexte.

ctx: Context = copy_context()
print(list(ctx.items()))

La fonction a une complexité O(1), c.-à-d. qu'elle fonctionne aussi rapidement pour des contextes avec peu de variables de contexte que pour des contextes qui en ont beaucoup.

class contextvars.Context

Tableau associatif entre ContextVars et leurs valeurs.

Context() crée un contexte vide ne contenant aucune valeur. Pour obtenir une copie du contexte actuel, utilisez la fonction copy_context().

Context implémente l'interface collections.abc.Mapping.

run(callable, *args, **kwargs)

Exécute le code callable(*args, **kwargs) dans le contexte défini par l'objet. Renvoie le résultat de l'exécution ou propage une exception s'il y en a une qui s'est produite.

Tout changement apporté aux variables de contexte effectué par callable sera contenu dans l'objet de contexte :

var = ContextVar('var')
var.set('spam')

def main():
    # 'var' was set to 'spam' before
    # calling 'copy_context()' and 'ctx.run(main)', so:
    # var.get() == ctx[var] == 'spam'

    var.set('ham')

    # Now, after setting 'var' to 'ham':
    # var.get() == ctx[var] == 'ham'

ctx = copy_context()

# Any changes that the 'main' function makes to 'var'
# will be contained in 'ctx'.
ctx.run(main)

# The 'main()' function was run in the 'ctx' context,
# so changes to 'var' are contained in it:
# ctx[var] == 'ham'

# However, outside of 'ctx', 'var' is still set to 'spam':
# var.get() == 'spam'

La méthode lève une RuntimeError quand elle est appelée sur le même objet de contexte depuis plus qu'un fil d'exécution ou quand elle est appelée récursivement.

copy()

Renvoie une copie de surface de l'objet de contexte.

var in context

Renvoie True si le context a une valeur pour var ; sinon renvoie False.

context[var]

Renvoie la valeur de la variable ContextVar var. Si la variable n'est pas définie dans l'objet de contexte, une KeyError est levée.

get(var[, default])

Renvoie la valeur de var si var possède une valeur dans l'objet de contexte. Renvoie default sinon (ou None si default n'est pas donné).

iter(context)

Renvoie un itérateur sur les variables stockées dans l'objet de contexte.

len(proxy)

Renvoie le nombre de variables définies dans l'objet de contexte.

keys()

Renvoie une liste de toutes les variables dans l'objet de contexte.

values()

Renvoie une liste de toutes les valeurs des variables dans l'objet de contexte.

items()

Renvoie une liste de paires contenant toutes les variables et leurs valeurs dans l'objet de contexte.

Gestion avec asyncio

asyncio gère nativement les variables de contexte et elles sont prêtes à être utilisées sans configuration supplémentaire. Par exemple, voici un serveur echo simple qui utilise une variable de contexte pour que l’adresse d'un client distant soit disponible dans le Task qui gère ce client :

import asyncio
import contextvars

client_addr_var = contextvars.ContextVar('client_addr')

def render_goodbye():
    # The address of the currently handled client can be accessed
    # without passing it explicitly to this function.

    client_addr = client_addr_var.get()
    return f'Good bye, client @ {client_addr}\n'.encode()

async def handle_request(reader, writer):
    addr = writer.transport.get_extra_info('socket').getpeername()
    client_addr_var.set(addr)

    # In any code that we call is now possible to get
    # client's address by calling 'client_addr_var.get()'.

    while True:
        line = await reader.readline()
        print(line)
        if not line.strip():
            break
        writer.write(line)

    writer.write(render_goodbye())
    writer.close()

async def main():
    srv = await asyncio.start_server(
        handle_request, '127.0.0.1', 8081)

    async with srv:
        await srv.serve_forever()

asyncio.run(main())

# To test it you can use telnet:
#     telnet 127.0.0.1 8081