Coroutines et tâches

Cette section donne un aperçu des API de haut-niveau du module asyncio pour utiliser les coroutines et les tâches.

Coroutines

Il est recommandé d'utiliser la syntaxe async / await pour développer des programmes asyncio. Par exemple, le morceau de code suivant (nécessitant Python 3.7 ou supérieur) affiche hello, attend une seconde et affiche ensuite world :

>>> import asyncio

>>> async def main():
...     print('hello')
...     await asyncio.sleep(1)
...     print('world')

>>> asyncio.run(main())
hello
world

Appeler une coroutine ne la planifie pas pour exécution :

>>> main()
<coroutine object main at 0x1053bb7c8>

Pour réellement exécuter une coroutine, asyncio fournit trois mécanismes principaux :

  • La fonction asyncio.run() pour exécuter la fonction « main() », le point d'entrée de haut-niveau (voir l'exemple ci-dessus).

  • Attendre une coroutine. Le morceau de code suivant attend une seconde, affiche « hello », attend 2 secondes supplémentaires, puis affiche enfin world :

    import asyncio
    import time
    
    async def say_after(delay, what):
        await asyncio.sleep(delay)
        print(what)
    
    async def main():
        print(f"started at {time.strftime('%X')}")
    
        await say_after(1, 'hello')
        await say_after(2, 'world')
    
        print(f"finished at {time.strftime('%X')}")
    
    asyncio.run(main())
    

    Sortie attendue :

    started at 17:13:52
    hello
    world
    finished at 17:13:55
    
  • La fonction asyncio.create_task() pour exécuter de manière concurrente des coroutines en tant que tâches asyncio.

    Modifions l'exemple ci-dessus et lançons deux coroutines say_after de manière concurrente :

    async def main():
        task1 = asyncio.create_task(
            say_after(1, 'hello'))
    
        task2 = asyncio.create_task(
            say_after(2, 'world'))
    
        print(f"started at {time.strftime('%X')}")
    
        # Wait until both tasks are completed (should take
        # around 2 seconds.)
        await task1
        await task2
    
        print(f"finished at {time.strftime('%X')}")
    

    La sortie attendue montre à présent que ce code s'exécute une seconde plus rapidement que le précédent :

    started at 17:14:32
    hello
    world
    finished at 17:14:34
    

Awaitables

Un objet est dit awaitable (qui peut être attendu) s'il peut être utilisé dans une expression await. Beaucoup d'API d'asyncio sont conçues pour accepter des awaitables.

Il existe trois types principaux d'awaitables : les coroutines, les tâches et les futurs.

Coroutines

Les coroutines sont des awaitables et peuvent donc être attendues par d'autres coroutines :

import asyncio

async def nested():
    return 42

async def main():
    # Nothing happens if we just call "nested()".
    # A coroutine object is created but not awaited,
    # so it *won't run at all*.
    nested()

    # Let's do it differently now and await it:
    print(await nested())  # will print "42".

asyncio.run(main())

Important

Dans cette documentation, le terme « coroutine » est utilisé pour désigner deux concepts voisins :

  • une fonction coroutine : une fonction async def;

  • un objet coroutine : un objet renvoyé par une fonction coroutine.

asyncio implémente également les coroutines basées sur des générateurs ; celles-ci sont obsolètes.

Tâches

Les tâches servent à planifier des coroutines de façon à ce qu'elles s'exécutent de manière concurrente.

Lorsqu'une coroutine est encapsulée dans une tâche à l'aide de fonctions comme asyncio.create_task(), la coroutine est automatiquement planifiée pour s'exécuter prochainement :

import asyncio

async def nested():
    return 42

async def main():
    # Schedule nested() to run soon concurrently
    # with "main()".
    task = asyncio.create_task(nested())

    # "task" can now be used to cancel "nested()", or
    # can simply be awaited to wait until it is complete:
    await task

asyncio.run(main())

Futurs

Un Future est un objet awaitable spécial de bas-niveau, qui représente le résultat final d'une opération asynchrone.

Quand un objet Future est attendu, cela signifie que la coroutine attendra que ce futur soit résolu à un autre endroit.

Les objets Future d'asyncio sont nécessaires pour permettre l'exécution de code basé sur les fonctions de rappel avec la syntaxe async / await.

Il est normalement inutile de créer des objets Future dans la couche applicative du code.

Les objets Future, parfois exposés par des bibliothèques et quelques API d'asyncio, peuvent être attendus :

async def main():
    await function_that_returns_a_future_object()

    # this is also valid:
    await asyncio.gather(
        function_that_returns_a_future_object(),
        some_python_coroutine()
    )

loop.run_in_executor() est l'exemple typique d'une fonction bas-niveau renvoyant un objet Future.

Exécution d'un programme asyncio

asyncio.run(coro, *, debug=False)

Cette fonction exécute la coroutine passée en argument. Elle gère la boucle d'événements asyncio et finalise les générateurs asynchrones.

Cette fonction ne peut pas être appelée si une autre boucle d'événement s'exécute dans le même fil d'exécution.

Si debug vaut True, la boucle d'événement s'exécute en mode de débogage.

Cette fonction crée toujours une nouvelle boucle d'événement et la clôt à la fin. Elle doit être utilisée comme point d'entrée principal des programmes asyncio et ne doit être idéalement appelée qu'une seule fois.

Nouveau dans la version 3.7: Important : cette fonction a été ajoutée à asyncio dans Python 3.7 de manière provisoire.

Création de tâches

asyncio.create_task(coro)

Encapsule la coroutine coro dans une tâche et la planifie pour exécution. Renvoie l'objet Task.

La tâche est exécutée dans la boucle renvoyée par get_running_loop() ; RuntimeError est levée s'il n'y a pas de boucle en cours d'exécution dans le fil actuel.

Cette fonction a été ajoutée dans Python 3.7. Pour les versions antérieures à la 3.7, la fonction de bas-niveau asyncio.ensure_future() peut-être utilisée :

async def coro():
    ...

# In Python 3.7+
task = asyncio.create_task(coro())
...

# This works in all Python versions but is less readable
task = asyncio.ensure_future(coro())
...

Nouveau dans la version 3.7.

Attente

coroutine asyncio.sleep(delay, result=None, *, loop=None)

Attend pendant delay secondes.

Si result est spécifié, il est renvoyé à l'appelant quand la coroutine se termine.

sleep() suspend systématiquement la tâche courante, ce qui permet aux autres tâches de s'exécuter.

L'argument loop est obsolète et sera supprimé en Python 3.10.

Exemple d'une coroutine affichant la date toutes les secondes pendant 5 secondes :

import asyncio
import datetime

async def display_date():
    loop = asyncio.get_running_loop()
    end_time = loop.time() + 5.0
    while True:
        print(datetime.datetime.now())
        if (loop.time() + 1.0) >= end_time:
            break
        await asyncio.sleep(1)

asyncio.run(display_date())

Exécution de tâches de manière concurrente

awaitable asyncio.gather(*aws, loop=None, return_exceptions=False)

Exécute les objets awaitable de la séquence aws, de manière concurrente.

Si un awaitable de aws est une coroutine, celui-ci est automatiquement planifié comme une tâche.

Si tous les awaitables s'achèvent avec succès, le résultat est la liste des valeurs renvoyées. L'ordre de cette liste correspond à l'ordre des awaitables dans aws.

Si return_exceptions vaut False (valeur par défaut), la première exception levée est immédiatement propagée vers la tâche en attente dans le gather(). Les autres awaitables dans la séquence aws ne sont pas annulés et poursuivent leur exécution.

Si return_exceptions vaut True, les exceptions sont traitées de la même manière que les exécutions normales, et incluses dans la liste des résultats.

Si gather() est annulé, tous les awaitables en cours (ceux qui n'ont pas encore fini de s'exécuter) sont également annulés.

Si n'importe quel Task ou Future de la séquence aws est annulé, il est traité comme s'il avait levé CancelledError — l'appel à gather() n'est alors pas annulé. Ceci permet d'empêcher que l'annulation d'une tâche ou d'un futur entraîne l'annulation des autres tâches ou futurs.

Exemple :

import asyncio

async def factorial(name, number):
    f = 1
    for i in range(2, number + 1):
        print(f"Task {name}: Compute factorial({i})...")
        await asyncio.sleep(1)
        f *= i
    print(f"Task {name}: factorial({number}) = {f}")

async def main():
    # Schedule three calls *concurrently*:
    await asyncio.gather(
        factorial("A", 2),
        factorial("B", 3),
        factorial("C", 4),
    )

asyncio.run(main())

# Expected output:
#
#     Task A: Compute factorial(2)...
#     Task B: Compute factorial(2)...
#     Task C: Compute factorial(2)...
#     Task A: factorial(2) = 2
#     Task B: Compute factorial(3)...
#     Task C: Compute factorial(3)...
#     Task B: factorial(3) = 6
#     Task C: Compute factorial(4)...
#     Task C: factorial(4) = 24

Modifié dans la version 3.7: Si gather est lui-même annulé, l'annulation est propagée indépendamment de return_exceptions.

Protection contre l'annulation

awaitable asyncio.shield(aw, *, loop=None)

Empêche qu'un objet awaitable puisse être annulé.

Si aw est une coroutine, elle est planifiée automatiquement comme une tâche.

L'instruction :

res = await shield(something())

est équivalente à :

res = await something()

à la différence près que si la coroutine qui la contient est annulée, la tâche s'exécutant dans something() n'est pas annulée. Du point de vue de something(), il n'y a pas eu d'annulation. Cependant, son appelant est bien annulé, donc l'expression await lève bien une CancelledError.

Si something() est annulée d'une autre façon (i.e. depuis elle-même) ceci annule également shield().

Pour ignorer complètement l'annulation (déconseillé), la fonction shield() peut être combinée à une clause try / except, comme dans le code ci-dessous :

try:
    res = await shield(something())
except CancelledError:
    res = None

Délais d'attente

coroutine asyncio.wait_for(aw, timeout, *, loop=None)

Attend la fin de l'awaitable aw avec délai d'attente.

Si aw est une coroutine, elle est planifiée automatiquement comme une tâche.

timeout peut-être soit None, soit le nombre de secondes (entier ou décimal) d'attente. Si timeout vaut None, la fonction s'interrompt jusqu'à ce que le futur s'achève.

Si le délai d'attente maximal est dépassé, la tâche est annulée et l'exception asyncio.TimeoutError est levée.

Pour empêcher l'annulation de la tâche, il est nécessaire de l'encapsuler dans une fonction shield().

Cette fonction attend que le futur soit réellement annulé, donc le temps d'attente total peut être supérieur à timeout.

Si l'attente est annulée, le futur aw est également annulé.

L'argument loop est obsolète et sera supprimé en Python 3.10.

Exemple :

async def eternity():
    # Sleep for one hour
    await asyncio.sleep(3600)
    print('yay!')

async def main():
    # Wait for at most 1 second
    try:
        await asyncio.wait_for(eternity(), timeout=1.0)
    except asyncio.TimeoutError:
        print('timeout!')

asyncio.run(main())

# Expected output:
#
#     timeout!

Modifié dans la version 3.7: Si le dépassement du délai d'attente maximal provoque l'annulation de aw, wait_for attend que aw soit annulée. Auparavant, l'exception asyncio.TimeoutError était immédiatement levée.

Primitives d'attente

coroutine asyncio.wait(aws, *, loop=None, timeout=None, return_when=ALL_COMPLETED)

Exécute les objets awaitables de l'ensemble aws de manière concurrente, et s'interrompt jusqu'à ce que la condition décrite dans return_when soit vraie.

Si un awaitable de aws est une coroutine, celle-ci est automatiquement planifiée comme une tâche. Passer directement des objets coroutines à wait() est obsolète, car ceci conduisait à un comportement portant à confusion.

Renvoie deux ensembles de Tasks / Futures : (done, pending).

Utilisation :

done, pending = await asyncio.wait(aws)

L'argument loop est obsolète et sera supprimé en Python 3.10.

timeout (entier ou décimal), si précisé, peut-être utilisé pour contrôler le nombre maximal de secondes d'attente avant de se terminer.

Cette fonction ne lève pas asyncio.TimeoutError. Les futurs et les tâches qui ne sont pas finis quand le délai d'attente maximal est dépassé sont tout simplement renvoyés dans le second ensemble.

return_when indique quand la fonction doit se terminer. Il peut prendre les valeurs suivantes :

Constante

Description

FIRST_COMPLETED

La fonction se termine lorsque n'importe quel futur se termine ou est annulé.

FIRST_EXCEPTION

La fonction se termine lorsque n'importe quel futur se termine en levant une exception. Si aucun futur ne lève d'exception, équivaut à ALL_COMPLETED.

ALL_COMPLETED

La fonction se termine lorsque les futurs sont tous finis ou annulés.

À la différence de wait_for(), wait() n'annule pas les futurs quand le délai d'attente est dépassé.

Note

wait() planifie automatiquement les coroutines comme des tâches et renvoie les objets Task ainsi créés dans les ensembles (done, pending). Le code suivant ne fonctionne donc pas comme voulu :

async def foo():
    return 42

coro = foo()
done, pending = await asyncio.wait({coro})

if coro in done:
    # This branch will never be run!

Voici comment corriger le morceau de code ci-dessus :

async def foo():
    return 42

task = asyncio.create_task(foo())
done, pending = await asyncio.wait({task})

if task in done:
    # Everything will work as expected now.

Passer directement des objets coroutines à wait() est obsolète.

asyncio.as_completed(aws, *, loop=None, timeout=None)

Exécute les objets awaitables de l'ensemble aws de manière concurrente. Renvoie un itérateur sur des objets Future. Chaque objet futur renvoyé représente le résultat le plus récent de l'ensemble des awaitables restants.

Lève une exception asyncio.TimeoutError si le délai d'attente est dépassé avant que tous les futurs ne soient achevés.

Exemple :

for f in as_completed(aws):
    earliest_result = await f
    # ...

Planification depuis d'autres fils d'exécution

asyncio.run_coroutine_threadsafe(coro, loop)

Enregistre une coroutine dans la boucle d'exécution actuelle. Cette opération est compatible avec les programmes à multiples fils d'exécution (thread-safe).

Renvoie un concurrent.futures.Future pour attendre le résultat d'un autre fil d'exécution du système d'exploitation.

Cette fonction est faite pour être appelée par un fil d'exécution distinct de celui dans laquelle la boucle d'événement s'exécute. Exemple :

# Create a coroutine
coro = asyncio.sleep(1, result=3)

# Submit the coroutine to a given loop
future = asyncio.run_coroutine_threadsafe(coro, loop)

# Wait for the result with an optional timeout argument
assert future.result(timeout) == 3

Si une exception est levée dans une coroutine, le futur renvoyé en sera averti. Elle peut également être utilisée pour annuler la tâche de la boucle d'événement :

try:
    result = future.result(timeout)
except asyncio.TimeoutError:
    print('The coroutine took too long, cancelling the task...')
    future.cancel()
except Exception as exc:
    print(f'The coroutine raised an exception: {exc!r}')
else:
    print(f'The coroutine returned: {result!r}')

Voir la section exécution concurrente et multi-fils d'exécution de la documentation.

À la différence des autres fonction d'asyncio, cette fonction requiert que loop soit passé de manière explicite.

Nouveau dans la version 3.5.1.

Introspection

asyncio.current_task(loop=None)

Renvoie l'instance de la Task en cours d'exécution, ou None s'il n'y a pas de tâche en cours.

Si loop vaut None, get_running_loop() est appelée pour récupérer la boucle en cours d'exécution.

Nouveau dans la version 3.7.

asyncio.all_tasks(loop=None)

Renvoie l'ensemble des Task non terminés en cours d'exécution dans la boucle.

Si loop vaut None, get_running_loop() est appelée pour récupérer la boucle en cours d'exécution.

Nouveau dans la version 3.7.

Objets Task

class asyncio.Task(coro, *, loop=None)

Objet compatible avec Future qui exécute une coroutine Python. Cet objet n'est pas utilisable dans des programmes à fils d'exécution multiples.

Les tâches servent à exécuter des coroutines dans des boucles d'événements. Si une coroutine attend un futur, la tâche interrompt son exécution et attend la fin de ce futur. Quand celui-ci est terminé, l'exécution de la coroutine encapsulée reprend.

Les boucles d'événement fonctionnent de manière coopérative : une boucle d'événement exécute une tâche à la fois. Quand une tâche attend la fin d'un futur, la boucle d'événement exécute d'autres tâches, des fonctions de rappel, ou effectue des opérations d'entrées-sorties.

La fonction de haut niveau asyncio.create_task() et les fonctions de bas-niveau loop.create_task() ou ensure_future() permettent de créer des tâches. Il est déconseillé d'instancier manuellement des objets Task.

La méthode cancel() d'une tâche en cours d'exécution permet d'annuler celle-ci. L'appel de cette méthode force la tâche à lever l'exception CancelledError dans la coroutine encapsulée. Si la coroutine attendait un futur au moment de l'annulation, celui-ci est annulé.

La méthode cancelled() permet de vérifier si la tâche a été annulée. Elle renvoie True si la coroutine encapsulée n'a pas ignoré l'exception CancelledError et a bien été annulée.

asyncio.Task hérite de Future, de toute son API, à l'exception de Future.set_result() et de Future.set_exception().

Task implémente le module contextvars. Lors de sa création, une tâche effectue une copie du contexte actuel et exécutera ses coroutines dans cette copie.

Modifié dans la version 3.7: Ajout du support du module contextvars.

cancel()

Demande l'annulation d'une tâche.

Provisionne la levée de l'exception CancelledError dans la coroutine encapsulée. L'exception sera levée au prochain cycle de la boucle d'exécution.

La coroutine peut alors se nettoyer ou même ignorer la requête en supprimant l'exception à l'aide d'un bloc try ... ... except CancelledError ... finally. Par conséquent, contrairement à Future.cancel(), Task.cancel() ne garantit pas que la tâche sera annulée, bien qu'ignorer totalement une annulation ne soit ni une pratique courante, ni encouragé.

L'exemple ci-dessous illustre comment une coroutine peut intercepter une requête d'annulation :

async def cancel_me():
    print('cancel_me(): before sleep')

    try:
        # Wait for 1 hour
        await asyncio.sleep(3600)
    except asyncio.CancelledError:
        print('cancel_me(): cancel sleep')
        raise
    finally:
        print('cancel_me(): after sleep')

async def main():
    # Create a "cancel_me" Task
    task = asyncio.create_task(cancel_me())

    # Wait for 1 second
    await asyncio.sleep(1)

    task.cancel()
    try:
        await task
    except asyncio.CancelledError:
        print("main(): cancel_me is cancelled now")

asyncio.run(main())

# Expected output:
#
#     cancel_me(): before sleep
#     cancel_me(): cancel sleep
#     cancel_me(): after sleep
#     main(): cancel_me is cancelled now
cancelled()

Renvoie True si la tâche est annulée.

La tâche est annulée quand l'annulation a été demandée avec cancel() et la coroutine encapsulée a propagé l'exception CancelledError qui a été levée en son sein.

done()

Renvoie True si la tâche est achevée.

Une tâche est dite achevée quand la coroutine encapsulée a soit renvoyé une valeur, soit levé une exception, ou que la tâche a été annulée.

result()

Renvoie le résultat de la tâche.

Si la tâche est achevée, le résultat de la coroutine encapsulée est renvoyé (sinon, dans le cas où la coroutine a levé une exception, cette exception est de nouveau levée).

Si la tâche a été annulée, cette méthode lève une exception CancelledError.

Si le résultat de la tâche n'est pas encore disponible, cette méthode lève une exception InvalidStateError.

exception()

Renvoie l'exception de la tâche.

Si la coroutine encapsulée lève une exception, cette exception est renvoyée. Si la coroutine s'est exécutée normalement, cette méthode renvoie None.

Si la tâche a été annulée, cette méthode lève une exception CancelledError.

Si la tâche n'est pas encore achevée, cette méthode lève une exception InvalidStateError.

add_done_callback(callback, *, context=None)

Ajoute une fonction de rappel qui sera exécutée quand la tâche sera achevée.

Cette méthode ne doit être utilisée que dans du code basé sur les fonctions de rappel de bas-niveau.

Se référer à la documentation de Future.add_done_callback() pour plus de détails.

remove_done_callback(callback)

Retire callback de la liste de fonctions de rappel.

Cette méthode ne doit être utilisée que dans du code basé sur les fonctions de rappel de bas-niveau.

Se référer à la documentation de Future.remove_done_callback() pour plus de détails.

get_stack(*, limit=None)

Renvoie une liste représentant la pile d'appels de la tâche.

Si la coroutine encapsulée n'est pas terminée, cette fonction renvoie la pile d'appels à partir de l'endroit où celle-ci est interrompue. Si la coroutine s'est terminée normalement ou a été annulée, cette fonction renvoie une liste vide. Si la coroutine a été terminée par une exception, ceci renvoie la pile d'erreurs.

La pile est toujours affichée de l'appelant à l'appelé.

Une seule ligne est renvoyée si la coroutine est suspendue.

L'argument facultatif limit définit le nombre maximal d'appels à renvoyer ; par défaut, tous sont renvoyés. L'ordre de la liste diffère selon la nature de celle-ci : les appels les plus récents d'une pile d'appels sont renvoyés, si la pile est une pile d'erreurs, ce sont les appels les plus anciens qui le sont (dans un souci de cohérence avec le module traceback).

print_stack(*, limit=None, file=None)

Affiche la pile d'appels ou d'erreurs de la tâche.

Le format de sortie des appels produits par get_stack() est similaire à celui du module traceback.

Le paramètre limit est directement passé à get_stack().

Le paramètre file est un flux d'entrées-sorties sur lequel le résultat est écrit ; par défaut, sys.stderr.

classmethod all_tasks(loop=None)

Renvoie l'ensemble des tâches d'une boucle d'évènements.

Par défaut, toutes les tâches de la boucle d'exécution actuelle sont renvoyées. Si loop vaut None, la fonction get_event_loop() est appelée pour récupérer la boucle d'exécution actuelle.

Cette méthode est obsolète et sera supprimée en Python 3.9. Utilisez la fonction asyncio.all_tasks() à la place.

classmethod current_task(loop=None)

Renvoie la tâche en cours d'exécution ou None.

Si loop vaut None, la fonction get_event_loop() est utilisée pour récupérer la boucle d'exécution actuelle.

Cette méthode est obsolète et sera supprimée en Python 3.9. Utilisez la fonction asyncio.current_task() à la place.

Coroutines basées sur des générateurs

Note

Les coroutines basées sur des générateurs sont obsolètes et il est prévu de les supprimer en Python 3.10.

Les coroutines basées sur des générateurs sont antérieures à la syntaxe async / await. Il existe des générateurs Python qui utilisent les expressions yield from pour attendre des futurs et autres coroutines.

Les coroutines basées sur des générateurs doivent être décorées avec @asyncio.coroutine, même si ce n'est pas vérifié par l'interpréteur.

@asyncio.coroutine

Décorateur pour coroutines basées sur des générateurs.

Ce décorateur rend compatibles les coroutines basées sur des générateurs avec le code async / await :

@asyncio.coroutine
def old_style_coroutine():
    yield from asyncio.sleep(1)

async def main():
    await old_style_coroutine()

Ce décorateur est obsolète et il est prévu de le supprimer en Python 3.10.

Ce décorateur ne doit pas être utilisé avec des coroutines async def.

asyncio.iscoroutine(obj)

Renvoie True si obj est un objet coroutine.

Cette méthode est différente de inspect.iscoroutine() car elle renvoie True pour des coroutines basées sur des générateurs.

asyncio.iscoroutinefunction(func)

Renvoie True si func est une fonction coroutine.

Cette méthode est différente de inspect.iscoroutinefunction() car elle renvoie True pour des coroutines basées sur des générateurs, décorées avec @coroutine.