官网连接:https://docs.python.org/zh-cn/3.7/library/asyncio-stream.html
流是用于处理网络连接的高级 async/await-ready 原语。流允许发送和接收数据,而不需要使用回调或低级协议和传输。
下面官网例子,是一个使用 asyncio streams 编写的 TCP echo 客户端示例:
import asyncio
async def tcp_echo_client(message):
reader, writer = await asyncio.open_connection(
'127.0.0.1', 8888)
print(f'Send: {message!r}')
writer.write(message.encode())
data = await reader.read(100)
print(f'Received: {data.decode()!r}')
print('Close the connection')
writer.close()
await writer.wait_closed()
asyncio.run(tcp_echo_client('Hello World!'))
一、Stream 函数
下面的高级 asyncio 函数可以用来创建和处理流:
coroutine asyncio.
open_connection
(host=None, port=None, *, loop=None, limit=None, ssl=None, family=0, proto=0, flags=0, sock=None, local_addr=None, server_hostname=None, ssl_handshake_timeout=None)
建立网络连接并返回一对
(reader, writer)
对象。返回的 reader 和 writer 对象是
StreamReader
和StreamWriter
类的实例。loop 参数是可选的,当从协程中等待该函数时,总是可以自动确定。
limit 确定返回的
StreamReader
实例使用的缓冲区大小限制。默认情况下,limit 设置为 64 KiB 。其余的参数直接传递到
loop.create_connection()
。
coroutine asyncio.
start_server
(client_connected_cb, host=None, port=None, *, loop=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, start_serving=True)
启动套接字服务。
The client_connected_cb callback is called whenever a new client connection is established. It receives a
(reader, writer)
pair as two arguments, instances of theStreamReader
andStreamWriter
classes.client_connected_cb can be a plain callable or a coroutine function; if it is a coroutine function, it will be automatically scheduled as a
Task
.The loop argument is optional and can always be determined automatically when this method is awaited from a coroutine.
limit 确定返回的
StreamReader
实例使用的缓冲区大小限制。默认情况下,limit 设置为 64 KiB 。The rest of the arguments are passed directly to
loop.create_server()
.
二、Unix Sockets
coroutine asyncio.
open_unix_connection
(path=None, *, loop=None, limit=None, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None)
Establish a Unix socket connection and return a pair of
(reader, writer)
.Similar to
open_connection()
but operates on Unix sockets.See also the documentation of
loop.create_unix_connection()
.Availability: Unix.
3.7 新版功能: ssl_handshake_timeout 形参。
在 3.7 版更改: The path parameter can now be a path-like object
coroutine asyncio.
start_unix_server
(client_connected_cb, path=None, *, loop=None, limit=None, sock=None, backlog=100, ssl=None, ssl_handshake_timeout=None, start_serving=True)
启动一个Unix socket服务。
Similar to
start_server()
but works with Unix sockets.See also the documentation of
loop.create_unix_server()
.Availability: Unix.
三、StreamReader
class asyncio.
StreamReader
Represents a reader object that provides APIs to read data from the IO stream.
It is not recommended to instantiate StreamReader objects directly; use
open_connection()
andstart_server()
instead.
coroutine read
(n=-1)
Read up to n bytes. If n is not provided, or set to
-1
, read until EOF and return all read bytes.If EOF was received and the internal buffer is empty, return an empty
bytes
object.
coroutine readline
()
Read one line, where "line" is a sequence of bytes ending with
\n
.If EOF is received and
\n
was not found, the method returns partially read data.If EOF is received and the internal buffer is empty, return an empty
bytes
object.
coroutine readexactly
(n)
Read exactly n bytes.
Raise an
IncompleteReadError
if EOF is reached before n can be read. Use theIncompleteReadError.partial
attribute to get the partially read data.
coroutine readuntil
(separator=b'\n')
Read data from the stream until separator is found.
On success, the data and separator will be removed from the internal buffer (consumed). Returned data will include the separator at the end.
If the amount of data read exceeds the configured stream limit, a
LimitOverrunError
exception is raised, and the data is left in the internal buffer and can be read again.If EOF is reached before the complete separator is found, an
IncompleteReadError
exception is raised, and the internal buffer is reset. TheIncompleteReadError.partial
attribute may contain a portion of the separator.3.5.2 新版功能.
at_eof
()
Return
True
if the buffer is empty andfeed_eof()
was called.
四、StreamWriter
class asyncio.
StreamWriter
Represents a writer object that provides APIs to write data to the IO stream.
It is not recommended to instantiate StreamWriter objects directly; use
open_connection()
andstart_server()
instead.
can_write_eof
()
Return True if the underlying transport supports the
write_eof()
method, False otherwise.
write_eof
()
Close the write end of the stream after the buffered write data is flushed.
transport
Return the underlying asyncio transport.
get_extra_info
(name, default=None)
Access optional transport information; see
BaseTransport.get_extra_info()
for details.
write
(data)
Write data to the stream.
This method is not subject to flow control. Calls to
write()
should be followed bydrain()
.
writelines
(data)
Write a list (or any iterable) of bytes to the stream.
This method is not subject to flow control. Calls to
writelines()
should be followed bydrain()
.
coroutine drain
()
Wait until it is appropriate to resume writing to the stream. Example:
writer.write(data) await writer.drain()
This is a flow control method that interacts with the underlying IO write buffer. When the size of the buffer reaches the high watermark, drain() blocks until the size of the buffer is drained down to the low watermark and writing can be resumed. When there is nothing to wait for, the
drain()
returns immediately.
close
()
Close the stream.
is_closing
()
Return
True
if the stream is closed or in the process of being closed.
3.7 新版功能.
coroutine wait_closed
()
Wait until the stream is closed.
Should be called after
close()
to wait until the underlying connection is closed.3.7 新版功能.
例子
TCP 客户端例子:
import asyncio
async def tcp_echo_client(message):
reader, writer = await asyncio.open_connection(
'127.0.0.1', 8888)
print(f'Send: {message!r}')
writer.write(message.encode())
data = await reader.read(100)
print(f'Received: {data.decode()!r}')
print('Close the connection')
writer.close()
asyncio.run(tcp_echo_client('Hello World!'))
TCP 服务端例子:
import asyncio
async def handle_echo(reader, writer):
data = await reader.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)
await writer.drain()
print("Close the connection")
writer.close()
async def main():
server = await asyncio.start_server(
handle_echo, '127.0.0.1', 8888)
addr = server.sockets[0].getsockname()
print(f'Serving on {addr}')
async with server:
await server.serve_forever()
asyncio.run(main())