High-Level-API-Index

Diese Seite listet alle High-Level-APIs mit async/await-Unterstützung für asyncio auf.

Tasks

Dienstprogramme zum Ausführen von asyncio-Programmen, Erstellen von Tasks und Warten auf mehrere Dinge mit Timeouts.

run()	Event-Loop erstellen, Koroutine ausführen, Loop schließen.
Runner	Ein Kontextmanager, der mehrere asynchrone Funktionsaufrufe vereinfacht.
Task	Task-Objekt.
TaskGroup	Ein Kontextmanager, der eine Gruppe von Tasks enthält. Bietet eine bequeme und zuverlässige Möglichkeit, auf den Abschluss aller Tasks in der Gruppe zu warten.
create_task()	Einen asyncio Task starten und dann zurückgeben.
current_task()	Den aktuellen Task zurückgeben.
all_tasks()	Alle noch nicht abgeschlossenen Tasks für eine Event-Loop zurückgeben.
await sleep()	Für eine bestimmte Anzahl von Sekunden schlafen.
await gather()	Dinge parallel planen und darauf warten.
await wait_for()	Mit einem Timeout ausführen.
await shield()	Vor Abbruch schützen.
await wait()	Auf Abschluss überwachen.
timeout()	Mit einem Timeout ausführen. Nützlich in Fällen, in denen wait_for nicht geeignet ist.
to_thread()	Eine Funktion asynchron in einem separaten Betriebssystem-Thread ausführen.
run_coroutine_threadsafe()	Eine Koroutine aus einem anderen Betriebssystem-Thread planen.
for in as_completed()	Auf Abschluss mit einer for-Schleife warten.

Beispiele

• Verwendung von asyncio.gather() zum parallelen Ausführen von Dingen.

• Verwendung von asyncio.wait_for() zum Erzwingen eines Timeouts.

• Abbruch.

• Verwendung von asyncio.sleep().

• Siehe auch die Hauptseite der Dokumentation zu Tasks.

Queues

Queues sollten verwendet werden, um Arbeit auf mehrere asyncio Tasks zu verteilen, Verbindungspools zu implementieren und Pub/Sub-Muster zu realisieren.

Queue	Eine FIFO-Warteschlange.
PriorityQueue	Eine Prioritätswarteschlange.
LifoQueue	Eine LIFO-Warteschlange.

Beispiele

• Verwendung von asyncio.Queue zur Verteilung der Arbeitslast zwischen mehreren Tasks.

• Siehe auch die Dokumentation zu Queues.

Subprozesse

Dienstprogramme zum Erzeugen von Subprozessen und Ausführen von Shell-Befehlen.

await create_subprocess_exec()	Einen Subprozess erstellen.
await create_subprocess_shell()	Einen Shell-Befehl ausführen.

Beispiele

• Ausführen eines Shell-Befehls.

• Siehe auch die Dokumentation der Subprozess-APIs.

Streams

High-Level-APIs für die Arbeit mit Netzwerk-IO.

await open_connection()	Eine TCP-Verbindung herstellen.
await open_unix_connection()	Eine Unix-Socket-Verbindung herstellen.
await start_server()	Einen TCP-Server starten.
await start_unix_server()	Einen Unix-Socket-Server starten.
StreamReader	High-Level-Objekt mit async/await zum Empfangen von Netzwerkdaten.
StreamWriter	High-Level-Objekt mit async/await zum Senden von Netzwerkdaten.

Beispiele

• Beispiel für einen TCP-Client.

• Siehe auch die Dokumentation der Stream-APIs.

Synchronisation

Thread-ähnliche Synchronisationsprimitive, die in Tasks verwendet werden können.

Lock	Ein Mutex-Lock.
Event	Ein Event-Objekt.
Condition	Ein Bedingungsobjekt.
Semaphore	Ein Semaphor.
BoundedSemaphore	Ein begrenzter Semaphor.
Barrier	Ein Barrier-Objekt.

Beispiele

• Verwendung von asyncio.Event.

• Verwendung von asyncio.Barrier.

• Siehe auch die Dokumentation der asyncio Synchronisationsprimitive.

Ausnahmen

asyncio.CancelledError	Ausgelöst, wenn ein Task abgebrochen wird. Siehe auch Task.cancel().
asyncio.BrokenBarrierError	Ausgelöst, wenn eine Barrier gebrochen wird. Siehe auch Barrier.wait().

Beispiele

• Behandlung von CancelledError zum Ausführen von Code bei Abbruchanforderung.

• Siehe auch die vollständige Liste der asyncio-spezifischen Ausnahmen.