低レベルAPIインデックス
このページには、すべての低レベルの非同期APIが一覧表示されます。
イベントループの取得
asyncio.get_running_loop()
|
実行中のイベントループを取得するための preferred 関数。 |
asyncio.get_event_loop()
|
イベントループインスタンスを取得します(現在またはポリシーを介して)。 |
asyncio.set_event_loop()
|
現在のポリシーを使用して、イベントループを現在のものとして設定します。 |
asyncio.new_event_loop()
|
新しいイベントループを作成します。 |
例
- asyncio.get_running_loop()を使用します。
イベントループメソッド
イベントループメソッドに関するメインのドキュメントセクションも参照してください。
ライフサイクル
loop.run_until_complete()
|
完了するまでFuture / Task / awaitableを実行します。 |
loop.run_forever()
|
イベントループを永久に実行します。 |
loop.stop()
|
イベントループを停止します。 |
loop.close()
|
イベントループを閉じます。 |
loop.is_running()
|
イベントループが実行されている場合は、True を返します。
|
loop.is_closed()
|
イベントループが閉じている場合は、True を返します。
|
await loop.shutdown_asyncgens()
|
非同期ジェネレーターを閉じます。 |
デバッグ
loop.set_debug()
|
デバッグモードを有効または無効にします。 |
loop.get_debug()
|
現在のデバッグモードを取得します。 |
コールバックのスケジュール
loop.call_soon()
|
すぐにコールバックを呼び出します。 |
loop.call_soon_threadsafe()
|
loop.call_soon()のスレッドセーフなバリアント。 |
loop.call_later()
|
指定された時間の後にコールバックを呼び出します。 |
loop.call_at()
|
指定された時間に at にコールバックを呼び出します。 |
スレッド/プロセスプール
await loop.run_in_executor()
|
concurrent.futures エグゼキュータでCPUバウンドまたはその他のブロッキング関数を実行します。 |
loop.set_default_executor()
|
loop.run_in_executor() のデフォルトのエグゼキュータを設定します。
|
タスクと先物
loop.create_future()
|
Future オブジェクトを作成します。 |
loop.create_task()
|
コルーチンをタスクとしてスケジュールします。 |
loop.set_task_factory()
|
loop.create_task()がタスクを作成するために使用するファクトリを設定します。 |
loop.get_task_factory()
|
loop.create_task()がタスクの作成に使用するファクトリを取得します。 |
DNS
await loop.getaddrinfo()
|
socket.getaddrinfo()の非同期バージョン。 |
await loop.getnameinfo()
|
socket.getnameinfo()の非同期バージョン。 |
ネットワーキングとIPC
await loop.create_connection()
|
TCP接続を開きます。 |
await loop.create_server()
|
TCPサーバーを作成します。 |
await loop.create_unix_connection()
|
Unixソケット接続を開きます。 |
await loop.create_unix_server()
|
Unixソケットサーバーを作成します。 |
await loop.connect_accepted_socket()
|
ソケットを(transport, protocol) ペアにラップします。
|
await loop.create_datagram_endpoint()
|
データグラム(UDP)接続を開きます。 |
await loop.sendfile()
|
トランスポートを介してファイルを送信します。 |
await loop.start_tls()
|
既存の接続をTLSにアップグレードします。 |
await loop.connect_read_pipe()
|
パイプの読み取り端を(transport, protocol) ペアにラップします。
|
await loop.connect_write_pipe()
|
パイプの書き込み端を(transport, protocol) ペアにラップします。
|
ソケット
await loop.sock_recv()
|
ソケットからデータを受信します。 |
await loop.sock_recv_into()
|
ソケットからバッファにデータを受信します。 |
await loop.sock_sendall()
|
ソケットにデータを送信します。 |
await loop.sock_connect()
|
ソケットを接続します。 |
await loop.sock_accept()
|
ソケット接続を受け入れます。 |
await loop.sock_sendfile()
|
ソケットを介してファイルを送信します。 |
loop.add_reader()
|
読み取りの可用性についてファイル記述子の監視を開始します。 |
loop.remove_reader()
|
読み取りの可用性についてファイル記述子の監視を停止します。 |
loop.add_writer()
|
書き込みの可用性についてファイル記述子の監視を開始します。 |
loop.remove_writer()
|
書き込みの可用性についてファイル記述子の監視を停止します。 |
Unixシグナル
loop.add_signal_handler()
|
信号のハンドラーを追加します。 |
loop.remove_signal_handler()
|
信号のハンドラーを削除します。 |
サブプロセス
loop.subprocess_exec()
|
サブプロセスを生成します。 |
loop.subprocess_shell()
|
シェルコマンドからサブプロセスを生成します。 |
エラー処理
loop.call_exception_handler()
|
例外ハンドラーを呼び出します。 |
loop.set_exception_handler()
|
新しい例外ハンドラーを設定します。 |
loop.get_exception_handler()
|
現在の例外ハンドラーを取得します。 |
loop.default_exception_handler()
|
デフォルトの例外ハンドラーの実装。 |
例
- asyncio.get_event_loop()およびloop.run_forever()を使用します。
- loop.call_later()を使用します。
loop.create_connection()
を使用してエコークライアントを実装します。loop.create_connection()
を使用してソケットを接続します。- add_reader()を使用してFDの読み取りイベントを監視します。
- loop.add_signal_handler()を使用します。
- loop.subprocess_exec()を使用します。
トランスポート
すべてのトランスポートは、次のメソッドを実装しています。
transport.close()
|
トランスポートを閉じます。 |
transport.is_closing()
|
トランスポートが閉じているか閉じている場合は、True を返します。
|
transport.get_extra_info()
|
輸送に関する情報の要求。 |
transport.set_protocol()
|
新しいプロトコルを設定します。 |
transport.get_protocol()
|
現在のプロトコルを返します。 |
データを受信できるトランスポート(TCPおよびUnix接続、パイプなど)。 loop.create_connection()
、loop.create_unix_connection()
、loop.connect_read_pipe()
などのメソッドから返されます。
トランスポートを読む
transport.is_reading()
|
トランスポートが受信している場合は、True を返します。
|
transport.pause_reading()
|
受信を一時停止します。 |
transport.resume_reading()
|
受信を再開します。 |
データを送信できるトランスポート(TCPおよびUnix接続、パイプなど)。 loop.create_connection()
、loop.create_unix_connection()
、loop.connect_write_pipe()
などのメソッドから返されます。
トランスポートの書き込み
transport.write()
|
トランスポートにデータを書き込みます。 |
transport.writelines()
|
トランスポートにバッファを書き込みます。 |
transport.can_write_eof()
|
トランスポートがEOFの送信をサポートしている場合は、 True を返します。 |
transport.write_eof()
|
バッファリングされたデータをフラッシュした後、EOFを閉じて送信します。 |
transport.abort()
|
すぐにトランスポートを閉じます。 |
transport.get_write_buffer_size()
|
書き込みフロー制御のために最高水準点と最低水準点を返します。 |
transport.set_write_buffer_limits()
|
書き込みフロー制御の新しい最高水準点と最低水準点を設定します。 |
loop.create_datagram_endpoint()
によって返されるトランスポート:
データグラムトランスポート
transport.sendto()
|
リモートピアにデータを送信します。 |
transport.abort()
|
すぐにトランスポートを閉じます。 |
サブプロセスでの低レベルのトランスポート抽象化。 loop.subprocess_exec()
およびloop.subprocess_shell()
によって返されます:
サブプロセストランスポート
transport.get_pid()
|
サブプロセスプロセスIDを返します。 |
transport.get_pipe_transport()
|
要求された通信パイプ( stdin 、 stdout 、または stderr )のトランスポートを返します。 |
transport.get_returncode()
|
サブプロセスの戻りコードを返します。 |
transport.kill()
|
サブプロセスを強制終了します。 |
transport.send_signal()
|
サブプロセスにシグナルを送信します。 |
transport.terminate()
|
サブプロセスを停止します。 |
transport.close()
|
サブプロセスを強制終了し、すべてのパイプを閉じます。 |
プロトコル
プロトコルクラスは、次のコールバックメソッドを実装できます。
callback connection_made()
|
接続が確立されたときに呼び出されます。 |
callback connection_lost()
|
接続が失われたとき、または閉じられたときに呼び出されます。 |
callback pause_writing()
|
トランスポートのバッファが最高水準点を超えたときに呼び出されます。 |
callback resume_writing()
|
トランスポートのバッファが最低水位標を下回ったときに呼び出されます。 |
ストリーミングプロトコル(TCP、Unixソケット、パイプ)
callback data_received()
|
一部のデータが受信されたときに呼び出されます。 |
callback eof_received()
|
EOFが受信されたときに呼び出されます。 |
バッファリングされたストリーミングプロトコル
callback get_buffer()
|
新しい受信バッファを割り当てるために呼び出されます。 |
callback buffer_updated()
|
受信したデータでバッファが更新されたときに呼び出されます。 |
callback eof_received()
|
EOFが受信されたときに呼び出されます。 |
データグラムプロトコル
callback datagram_received()
|
データグラムが受信されたときに呼び出されます。 |
callback error_received()
|
前の送信または受信操作で OSError が発生したときに呼び出されます。 |
サブプロセスプロトコル
callback pipe_data_received()
|
子プロセスが stdout または stderr パイプにデータを書き込むときに呼び出されます。 |
callback pipe_connection_lost()
|
子プロセスと通信しているパイプの1つが閉じられたときに呼び出されます。 |
callback process_exited()
|
子プロセスが終了したときに呼び出されます。 |
イベントループポリシー
ポリシーは、 asyncio.get_event_loop()などの関数の動作を変更するための低レベルのメカニズムです。 詳細については、メインのポリシーセクションも参照してください。
ポリシーへのアクセス
asyncio.get_event_loop_policy()
|
現在のプロセス全体のポリシーを返します。 |
asyncio.set_event_loop_policy()
|
新しいプロセス全体のポリシーを設定します。 |
AbstractEventLoopPolicy
|
ポリシーオブジェクトの基本クラス。 |