ストリーム¶

ソースコード:Lib/asyncio/streams.py

ストリームはネットワークコネクションと合わせて動作する高水準の async/await 可能な基本要素です。ストリームはコールバックや低水準のプロトコルやトランスポートを使うことなくデータを送受信することを可能にします。

以下は asyncio ストリームを使って書いた TCP エコークライアントの例です:

importasyncioasyncdeftcp_echo_client(message):reader,writer=awaitasyncio.open_connection('127.0.0.1',8888)print(f'Send:{message!r}')writer.write(message.encode())awaitwriter.drain()data=awaitreader.read(100)print(f'Received:{data.decode()!r}')print('Close the connection')writer.close()awaitwriter.wait_closed()asyncio.run(tcp_echo_client('Hello World!'))

下記の使用例 節も参照してください。

ストリーム関数

以下の asyncio のトップレベル関数はストリームの作成や操作を行うことができます:

coroutineasyncio.open_connection(host=None,port=None,*,limit=None,ssl=None,family=0,proto=0,flags=0,sock=None,local_addr=None,server_hostname=None,ssl_handshake_timeout=None,ssl_shutdown_timeout=None,happy_eyeballs_delay=None,interleave=None)¶

ネットワークコネクションを確立し、(reader,writer) のオブジェクトのペアを返します。

戻り値のreader とwriter はそれぞれStreamReader とStreamWriter クラスのインスタンスです。

limit は戻り値のStreamReader インスタンスが利用するバッファのサイズの上限値を設定します。デフォルトではlimit は 64 KiB に設定されます。

残りの引数は直接loop.create_connection() に渡されます。

注釈

Thesock argument transfers ownership of the socket to theStreamWriter created. To close the socket, call itsclose() method.

バージョン 3.7 で変更:Added thessl_handshake_timeout parameter.

バージョン 3.8 で変更:happy_eyeballs_delay とinterleave が追加されました。

バージョン 3.10 で変更:loop パラメータが削除されました。

バージョン 3.11 で変更:ssl_shutdown_timeout パラメータが追加されました。

coroutineasyncio.start_server(client_connected_cb,host=None,port=None,*,limit=None,family=socket.AF_UNSPEC,flags=socket.AI_PASSIVE,sock=None,backlog=100,ssl=None,reuse_address=None,reuse_port=None,ssl_handshake_timeout=None,ssl_shutdown_timeout=None,start_serving=True)¶

ソケットサーバーを起動します。

client_connected_cb コールバックは新しいクライアントコネクションが確立されるたびに呼び出されます。このコールバックはStreamReader とStreamWriter クラスのインスタンスのペア(reader,writer) を2つの引数として受け取ります。

client_connected_cb には単純な呼び出し可能オブジェクトか、またはコルーチン関数 を指定します; コルーチン関数が指定された場合、コールバックの呼び出しは自動的にTask としてスケジュールされます。

limit は戻り値のStreamReader インスタンスが利用するバッファのサイズの上限値を設定します。デフォルトではlimit は 64 KiB に設定されます。

残りの引数は直接loop.create_server() に渡されます。

注釈

Thesock argument transfers ownership of the socket to theserver created. To close the socket, call the server'sclose() method.

バージョン 3.7 で変更:ssl_handshake_timeout とstart_serving パラメータが追加されました。

バージョン 3.10 で変更:loop パラメータが削除されました。

バージョン 3.11 で変更:ssl_shutdown_timeout パラメータが追加されました。

Unix ソケット

coroutineasyncio.open_unix_connection(path=None,*,limit=None,ssl=None,sock=None,server_hostname=None,ssl_handshake_timeout=None,ssl_shutdown_timeout=None)¶

Unix ソケットコネクションを確立し、(reader,writer) のオブジェクトのペアを返します。

この関数はopen_connection() と似ていますが Unix ソケットに対して動作します。

loop.create_unix_connection() のドキュメントも参照してください。

注釈

Thesock argument transfers ownership of the socket to theStreamWriter created. To close the socket, call itsclose() method.

Availability: Unix.

バージョン 3.7 で変更:Added thessl_handshake_timeout parameter.Thepath parameter can now be apath-like object

バージョン 3.10 で変更:loop パラメータが削除されました。

バージョン 3.11 で変更:ssl_shutdown_timeout パラメータが追加されました。

coroutineasyncio.start_unix_server(client_connected_cb,path=None,*,limit=None,sock=None,backlog=100,ssl=None,ssl_handshake_timeout=None,ssl_shutdown_timeout=None,start_serving=True)¶

Unix のソケットサーバーを起動します。

start_server() と似ていますが Unix ソケットに対して動作します。

loop.create_unix_server() のドキュメントも参照してください。

注釈

Thesock argument transfers ownership of the socket to theserver created. To close the socket, call the server'sclose() method.

Availability: Unix.

バージョン 3.7 で変更:Added thessl_handshake_timeout andstart_serving parameters.Thepath parameter can now be apath-like object.

バージョン 3.10 で変更:loop パラメータが削除されました。

バージョン 3.11 で変更:ssl_shutdown_timeout パラメータが追加されました。

importasyncioasyncdeftcp_echo_client(message):reader,writer=awaitasyncio.open_connection('127.0.0.1',8888)print(f'Send:{message!r}')writer.write(message.encode())awaitwriter.drain()data=awaitreader.read(100)print(f'Received:{data.decode()!r}')print('Close the connection')writer.close()awaitwriter.wait_closed()asyncio.run(tcp_echo_client('Hello World!'))

importasyncioasyncdefhandle_echo(reader,writer):data=awaitreader.read(100)message=data.decode()addr=writer.get_extra_info('peername')print(f"Received{message!r} from{addr!r}")print(f"Send:{message!r}")writer.write(data)awaitwriter.drain()print("Close the connection")writer.close()awaitwriter.wait_closed()asyncdefmain():server=awaitasyncio.start_server(handle_echo,'127.0.0.1',8888)addrs=', '.join(str(sock.getsockname())forsockinserver.sockets)print(f'Serving on{addrs}')asyncwithserver:awaitserver.serve_forever()asyncio.run(main())

importasyncioimporturllib.parseimportsysasyncdefprint_http_headers(url):url=urllib.parse.urlsplit(url)ifurl.scheme=='https':reader,writer=awaitasyncio.open_connection(url.hostname,443,ssl=True)else:reader,writer=awaitasyncio.open_connection(url.hostname,80)query=(f"HEAD{url.pathor'/'} HTTP/1.0\r\n"f"Host:{url.hostname}\r\n"f"\r\n")writer.write(query.encode('latin-1'))whileTrue:line=awaitreader.readline()ifnotline:breakline=line.decode('latin1').rstrip()ifline:print(f'HTTP header>{line}')# Ignore the body, close the socketwriter.close()awaitwriter.wait_closed()url=sys.argv[1]asyncio.run(print_http_headers(url))

pythonexample.pyhttp://example.com/path/page.html

pythonexample.pyhttps://example.com/path/page.html

importasyncioimportsocketasyncdefwait_for_data():# Get a reference to the current event loop because# we want to access low-level APIs.loop=asyncio.get_running_loop()# Create a pair of connected sockets.rsock,wsock=socket.socketpair()# Register the open socket to wait for data.reader,writer=awaitasyncio.open_connection(sock=rsock)# Simulate the reception of data from the networkloop.call_soon(wsock.send,'abc'.encode())# Wait for datadata=awaitreader.read(100)# Got data, we are done: close the socketprint("Received:",data.decode())writer.close()awaitwriter.wait_closed()# Close the second socketwsock.close()asyncio.run(wait_for_data())