API-index på låg nivå

På den här sidan listas alla asyncios API:er på låg nivå.

Få fram händelseslingan

asyncio.get_running_loop()	Den företrädes funktionen för att få den löpande händelseslingan.
asyncio.get_event_loop()	Hämta en instans för händelseslinga (pågående eller aktuell via aktuell policy).
asyncio.set_event_loop()	Ställ in händelseslingan som aktuell via den aktuella policyn.
asyncio.new_event_loop()	Skapa en ny händelseslinga.

Exempel

• Using asyncio.get_running_loop().

Metoder för händelseslingor

Se även huvuddokumentationsavsnittet om Metoder för händelseslingor.

Livscykel

loop.run_until_complete()	Kör en Future/Task/awaitable tills den är klar.
loop.run_forever()	Kör händelseslingan för evigt.
loop.stop()	Stoppa händelseslingan.
loop.close()	Stäng händelseslingan.
loop.is_running()	Returnerar True om händelseslingan är igång.
loop.is_closed()	Returnerar True om händelseslingan är stängd.
await loop.shutdown_asyncgens()	Stäng av asynkrona generatorer.

Felsökning

loop.set_debug()	Aktivera eller inaktivera felsökningsläget.
loop.get_debug()	Hämta aktuellt felsökningsläge.

Schemaläggning av återuppringningar

loop.call_soon()	Anropa en återuppringning snart.
loop.call_soon_threadsafe()	En trådsäker variant av loop.call_soon().
loop.call_later()	Anropar en callback efter den angivna tiden.
loop.call_at()	Anropar ett återuppringningsprogram vid den angivna tidpunkten.

Tråd/Interpreterare/Processpool

await loop.run_in_executor()	Kör en CPU-bunden eller annan blockerande funktion i en concurrent.futures exekverare.
loop.set_default_executor()	Ange standardutförare för loop.run_in_executor().

Uppgifter och framtid

loop.skapa_future()	Skapa ett Future-objekt.
loop.create_task()	Schemalägg coroutine som en Task.
loop.set_task_factory()	Ange en fabrik som används av loop.create_task() för att skapa Tasks.
loop.get_task_factory()	Hämta fabriken som loop.create_task() använder för att skapa Tasks.

DNS

await loop.getaddrinfo()	Asynkron version av socket.getaddrinfo().
await loop.getnameinfo()	Asynkron version av socket.getnameinfo().

Nätverk och IPC

await loop.create_connection()	Öppna en TCP-anslutning.
await loop.create_server()	Skapa en TCP-server.
await loop.create_unix_connection()	Öppna en Unix-socketanslutning.
await loop.create_unix_server()	Skapa en Unix-socket-server.
await loop.connect_accepted_socket()	Packa in en socket till ett (transport, protocol) -par.
await loop.create_datagram_endpoint()	Öppna en UDP-anslutning (datagram).
await loop.sendfile()	Skicka en fil över en transport.
await loop.start_tls()	Uppgradera en befintlig anslutning till TLS.
await loop.connect_read_pipe()	Packa in en läsande ände av en pipe i ett (transport, protocol) -par.
await loop.connect_write_pipe()	Packa in en skrivande ände av en pipe i ett (transport, protocol) -par.

Uttag

await loop.sock_recv()	Ta emot data från socket.
await loop.sock_recv_into()	Ta emot data från socket till en buffert.
await loop.sock_recvfrom()	Ta emot ett datagram från socket.
await loop.sock_recvfrom_into()	Ta emot ett datagram från socket till en buffert.
await loop.sock_sendall()	Skicka data till socket.
await loop.sock_sendto()	Skicka ett datagram via socket till den angivna adressen.
await loop.sock_connect()	Anslut socket.
await loop.sock_accept()	Acceptera en socket-anslutning.
await loop.sock_sendfile()	Skicka en fil över socket.
loop.add_reader()	Börja bevaka en filbeskrivare för lästillgänglighet.
loop.remove_reader()	Sluta bevaka en filbeskrivare för lästillgänglighet.
loop.add_writer()	Börja bevaka en filbeskrivare för skrivtillgänglighet.
loop.remove_writer()	Sluta bevaka en filbeskrivare för skrivtillgänglighet.

Unix-signaler

loop.add_signal_handler()	Lägg till en hanterare för en signal.
loop.remove_signal_handler()	Ta bort en hanterare för en signal.

Delprocesser

loop.subprocess_exec()	Starta en underprocess.
loop.subprocess_shell()	Starta en subprocess från ett shell-kommando.

Felhantering

loop.call_exception_handler()	Anropa undantagshanteraren.
loop.set_exception_handler()	Ställ in en ny undantagshanterare.
loop.get_exception_handler()	Hämta den aktuella undantagshanteraren.
loop.default_exception_handler()	Standardimplementeringen av undantagshanteraren.

Exempel

• Använder asyncio.new_event_loop() och loop.run_forever().

• Använder loop.call_later().

• Använda loop.create_connection() för att implementera en echo-client.

• Använda loop.create_connection() för att ansluta ett uttag.

• Använder add_reader() för att bevaka en FD för läshändelser.

• Using loop.add_signal_handler().

• Using loop.subprocess_exec().

Transportkvitton

Alla transporter implementerar följande metoder:

transport.close()	Stäng transporten.
transport.is_closing()	Returnerar True om transporten håller på att stängas eller är stängd.
transport.get_extra_info()	Begäran om information om transporten.
transport.set_protocol()	Ställ in ett nytt protokoll.
transport.get_protocol()	Returnerar det aktuella protokollet.

Transporter som kan ta emot data (TCP- och Unix-anslutningar, pipes etc.). Returneras från metoder som loop.create_connection(), loop.create_unix_connection(), loop.connect_read_pipe(), etc:

Läs transporter

transport.is_reading()	Returnerar True om transporten är mottagande.
transport.pause_reading()	Pausa mottagning.
transport.resume_reading()	Resumé mottagande.

Transporter som kan skicka data (TCP- och Unix-anslutningar, pipes etc.). Returneras från metoder som loop.create_connection(), loop.create_unix_connection(), loop.connect_write_pipe(), etc:

Skriva transporter

transport.write()	Skriv data till transportmedlet.
transport.writelines()	Skriv buffertar till transportmedlet.
transport.can_write_eof()	Returnerar True om transporten har stöd för att skicka EOF.
transport.write_eof()	Stäng och skicka EOF efter rensning av buffrad data.
transport.abort()	Stäng transporten omedelbart.
transport.get_write_buffer_size()	Returnerar den aktuella storleken på utmatningsbufferten.
transport.get_write_buffer_limits()	Returnera hög- och lågvattenmärken för kontroll av skrivflöde.
transport.set_write_buffer_limits()	Sätt nya hög- och lågvattenmärken för kontroll av skrivflödet.

Transporter returnerade av loop.create_datagram_endpoint():

Datagramtransporter

transport.sendto()	Skicka data till den fjärranslutna motparten.
transport.abort()	Stäng transporten omedelbart.

Transportabstraktion på låg nivå över subprocesser. Returneras av loop.subprocess_exec() och loop.subprocess_shell():

Underprocess transporter

transport.get_pid()	Returnerar underprocessens process-ID.
transport.get_pipe_transport()	Returnerar transporten för den begärda kommunikationsröret (stdin, stdout eller stderr).
transport.get_returncode()	Returnerar subprocessens returkod.
transport.kill()	Stäng av underprocessen.
transport.send_signal()	Skicka en signal till underprocessen.
transport.terminate()	Stoppa underprocessen.
transport.close()	Avsluta subprocessen och stäng alla rör.

Protokoll

Protokollklasser kan implementera följande callback-metoder:

callback connection_made()	Anropas när en anslutning har gjorts.
callback connection_lost()	Anropas när anslutningen bryts eller stängs.
callback pause_writing()	Anropas när transportens buffert går över högvattengränsen.
callback resume_writing()	Anropas när transportens buffert dräneras under lågvattenlinjen.

Streamingprotokoll (TCP, Unix Sockets, Pipes)

callback data_received()	Anropas när data har tagits emot.
callback eof_received()	Anropas när en EOF tas emot.

Protokoll för buffrad strömning

callback get_buffer()	Anropas för att allokera en ny mottagningsbuffert.
callback buffer_updated() <BufferedProtocol.buffer_updated>`()	Anropas när bufferten har uppdaterats med de mottagna uppgifterna.
callback eof_received() <BufferedProtocol.eof_received>`()	Anropas när en EOF tas emot.

Datagram-protokoll

callback datagram_received()	Anropas när ett datagram tas emot.
callback error_received()	Anropas när en tidigare sändnings- eller mottagningsoperation ger upphov till ett OSError.

Protokoll för delprocesser

callback pipe_data_received()	Anropas när barnprocessen skriver data till sin stdout- eller stderr-pipe.
callback pipe_connection_lost()	Anropas när ett av de rör som kommunicerar med barnprocessen stängs.
callback process_exited()	Anropas när underordnad process har avslutats. Den kan anropas före metoderna pipe_data_received() och pipe_connection_lost().

Policyer för händelseslingor

Policies är en mekanism på låg nivå för att ändra beteendet hos funktioner som asyncio.get_event_loop(). Se även huvudavsnittet policies för mer information.

Tillgång till policyer

asyncio.get_event_loop_policy()	Returnera den aktuella processomfattande policyn.
asyncio.set_event_loop_policy()	Ange en ny policy för hela processen.
AbstractEventLoopPolicy	Basklass för policyobjekt.