asyncio-stream.md
1> **Источник:** https://python-all.ru/3.12/library/asyncio-stream.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Потоки данных89**Исходный код:** [Lib/asyncio/streams.py](https://python-all.ru/src/3.12/Lib/asyncio/streams.py)1011---1213Потоки данных – это высокоуровневые примитивы, готовые к использованию с async/await, для работы с сетевыми соединениями. Потоки данных позволяют отправлять и получать данные без использования колбэков или низкоуровневых протоколов и транспортов.1415Ниже приведён пример TCP-эхо-клиента, написанного с использованием asyncio потоков данных:1617```python18import asyncio1920async def tcp_echo_client(message):21 reader, writer = await asyncio.open_connection(22 '127.0.0.1', 8888)2324 print(f'Send: {message!r}')25 writer.write(message.encode())26 await writer.drain()2728 data = await reader.read(100)29 print(f'Received: {data.decode()!r}')3031 print('Close the connection')32 writer.close()33 await writer.wait_closed()3435asyncio.run(tcp_echo_client('Hello World!'))36```3738Смотрите также раздел [Примеры](https://python-all.ru/3.12/library/asyncio-stream.html#examples) ниже.3940Функции потоков данных4142Следующие функции asyncio верхнего уровня можно использовать для создания и работы с потоками данных:4344#### `async asyncio.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)`4546Устанавливает сетевое соединение и возвращает пару объектов `(reader, writer)`.4748Возвращаемые объекты *reader* и *writer* являются экземплярами классов [`StreamReader`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamReader) и [`StreamWriter`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamWriter).4950Параметр *limit* определяет ограничение размера буфера, используемого возвращаемым экземпляром [`StreamReader`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamReader). По умолчанию *limit* установлен в 64 КиБ.5152Остальные аргументы передаются напрямую в [`loop.create_connection()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.loop.create_connection).5354> **Примечание**55>56> Аргумент *sock* передаёт владение сокетом созданному [`StreamWriter`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamWriter). Чтобы закрыть сокет, вызовите его метод [`close()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamWriter.close).5758Изменено в версии 3.7: Добавлен параметр *ssl\_handshake\_timeout*.5960Изменено в версии 3.8: Добавлены параметры *happy\_eyeballs\_delay* и *interleave*.6162Изменено в версии 3.10: Удалён параметр *loop*.6364Изменено в версии 3.11: Добавлен параметр *ssl\_shutdown\_timeout*.6566#### `async asyncio.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)`6768Запускает сокет-сервер.6970Колбэк *client\_connected\_cb* вызывается при каждом установлении нового подключения клиента. Он получает пару `(reader, writer)` в качестве двух аргументов – экземпляры классов [`StreamReader`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamReader) и [`StreamWriter`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamWriter).7172*client\_connected\_cb* может быть обычным вызываемым объектом или [корутинной функцией](https://python-all.ru/3.12/library/asyncio-task.html#coroutine); если это корутинная функция, она будет автоматически запланирована как [`Task`](https://python-all.ru/3.12/library/asyncio-task.html#asyncio.Task).7374Параметр *limit* определяет ограничение размера буфера, используемого возвращаемым экземпляром [`StreamReader`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamReader). По умолчанию *limit* установлен в 64 КиБ.7576Остальные аргументы передаются напрямую в [`loop.create_server()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.loop.create_server).7778> **Примечание**79>80> Аргумент *sock* передаёт владение сокетом созданному серверу. Чтобы закрыть сокет, вызовите метод сервера [`close()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.Server.close).8182Изменено в версии 3.7: Добавлены параметры *ssl\_handshake\_timeout* и *start\_serving*.8384Изменено в версии 3.10: Удалён параметр *loop*.8586Изменено в версии 3.11: Добавлен параметр *ssl\_shutdown\_timeout*.8788Unix-сокеты8990#### `asyncio.open_unix_connection(path=None, *, limit=None, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)`9192#### `:async:`9394> Устанавливает соединение через Unix-сокет и возвращает пару `(reader, writer)`.95>96> Аналогично [`open_connection()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.open_connection), но работает с Unix-сокетами.97>98> См. также документацию [`loop.create_unix_connection()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.loop.create_unix_connection).99>100> > **Примечание**101> >102> > Аргумент *sock* передаёт владение сокетом созданному [`StreamWriter`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamWriter). Чтобы закрыть сокет, вызовите его метод [`close()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamWriter.close).103>104> [Доступность](https://python-all.ru/3.12/library/intro.html#availability): Unix.105>106> Изменено в версии 3.7: Добавлен параметр *ssl\_handshake\_timeout*. Параметр *path* теперь может быть [объектом, подобным пути](https://python-all.ru/3.12/glossary.html#term-path-like-object).107>108> Изменено в версии 3.10: Удалён параметр *loop*.109110Изменено в версии 3.11: Добавлен параметр *ssl\_shutdown\_timeout*.111112#### `async asyncio.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)`113114Запуск сервера Unix-сокетов.115116Аналогично [`start_server()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.start_server), но работает с Unix-сокетами.117118См. также документацию [`loop.create_unix_server()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.loop.create_unix_server).119120> **Примечание**121>122> Аргумент *sock* передаёт владение сокетом созданному серверу. Чтобы закрыть сокет, вызовите метод сервера [`close()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.Server.close).123124[Доступность](https://python-all.ru/3.12/library/intro.html#availability): Unix.125126Изменено в версии 3.7: Добавлены параметры *ssl\_handshake\_timeout* и *start\_serving*. Параметр *path* теперь может быть [объектом, подобным пути](https://python-all.ru/3.12/glossary.html#term-path-like-object).127128Изменено в версии 3.10: Удалён параметр *loop*.129130Изменено в версии 3.11: Добавлен параметр *ssl\_shutdown\_timeout*.131132## StreamReader133134#### `class asyncio.StreamReader`135136Представляет объект чтения, предоставляющий API для чтения данных из потока ввода-вывода. Как [асинхронный итерируемый объект](https://python-all.ru/3.12/glossary.html#term-asynchronous-iterable), этот объект поддерживает инструкцию [`async for`](https://python-all.ru/3.12/reference/compound_stmts.html#async-for).137138Не рекомендуется создавать объекты *StreamReader* напрямую; вместо этого используйте [`open_connection()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.open_connection) и [`start_server()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.start_server).139140#### `feed_eof()`141142Подтверждает конец файла (EOF).143144#### `async read(n=-1)`145146Читает до *n* байт из потока.147148Если *n* не указан или равен `-1`, читает до EOF, затем возвращает все прочитанные [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes). Если получен EOF и внутренний буфер пуст, возвращает пустой объект `bytes`.149150Если *n* равен `0`, немедленно возвращает пустой объект `bytes`.151152Если *n* положительный, возвращает не более *n* доступных `bytes`, как только во внутреннем буфере появляется хотя бы 1 байт. Если EOF получен до чтения хотя бы одного байта, возвращается пустой объект `bytes`.153154#### `async readline()`155156Читает одну строку, где «строка» – это последовательность байтов, заканчивающаяся `\n`.157158Если получен EOF и `\n` не найден, метод возвращает частично прочитанные данные.159160Если получен EOF и внутренний буфер пуст, возвращается пустой объект `bytes`.161162#### `async readexactly(n)`163164Прочитать ровно *n* байт.165166Возбуждается [`IncompleteReadError`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.IncompleteReadError), если EOF достигнут до того, как прочитано *n* байт. Используйте атрибут [`IncompleteReadError.partial`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.IncompleteReadError.partial), чтобы получить частично прочитанные данные.167168#### `async readuntil(separator=b'\n')`169170Читает данные из потока до тех пор, пока не будет найден *separator*.171172В случае успеха данные и разделитель удаляются из внутреннего буфера (потребляются). Возвращаемые данные включают разделитель в конце.173174Если объем прочитанных данных превышает настроенный лимит потока, возбуждается исключение [`LimitOverrunError`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.LimitOverrunError), а данные остаются во внутреннем буфере и могут быть прочитаны снова.175176Если EOF достигнут до того, как найден полный разделитель, возбуждается исключение [`IncompleteReadError`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.IncompleteReadError), и внутренний буфер сбрасывается. Атрибут [`IncompleteReadError.partial`](https://python-all.ru/3.12/library/asyncio-exceptions.html#asyncio.IncompleteReadError.partial) может содержать часть разделителя.177178Добавлено в версии 3.5.2.179180#### `at_eof()`181182Возвращает `True`, если буфер пуст и был вызван [`feed_eof()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamReader.feed_eof).183184## StreamWriter185186#### `class asyncio.StreamWriter`187188Представляет объект-писатель, предоставляющий API для записи данных в поток ввода-вывода.189190Не рекомендуется создавать объекты *StreamWriter* напрямую; вместо этого используйте [`open_connection()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.open_connection) и [`start_server()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.start_server).191192#### `write(data)`193194Метод пытается немедленно записать *data* в нижележащий сокет. Если это не удаётся, данные помещаются во внутренний буфер записи до тех пор, пока их нельзя будет отправить.195196Метод следует использовать вместе с методом `drain()`:197198```python199stream.write(data)200await stream.drain()201```202203#### `writelines(data)`204205Метод немедленно записывает список (или любой итерируемый объект) байт в нижележащий сокет. Если это не удаётся, данные помещаются во внутренний буфер записи до тех пор, пока их нельзя будет отправить.206207Метод следует использовать вместе с методом `drain()`:208209```python210stream.writelines(lines)211await stream.drain()212```213214#### `close()`215216Метод закрывает поток и нижележащий сокет.217218Метод следует использовать, хотя это и не обязательно, вместе с методом `wait_closed()`:219220```python221stream.close()222await stream.wait_closed()223```224225#### `can_write_eof()`226227Возвращает `True`, если нижележащий транспорт поддерживает метод [`write_eof()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamWriter.write_eof), и `False` в противном случае.228229#### `write_eof()`230231Закрывает конец потока для записи после сброса буферизованных данных записи.232233#### `transport`234235Возвращает базовый транспорт asyncio.236237#### `get_extra_info(name, default=None)`238239Предоставляет доступ к дополнительной информации о транспорте; подробнее см. [`BaseTransport.get_extra_info()`](https://python-all.ru/3.12/library/asyncio-protocol.html#asyncio.BaseTransport.get_extra_info).240241#### `async drain()`242243Ожидает, когда можно будет возобновить запись в поток данных. Пример:244245```python246writer.write(data)247await writer.drain()248```249250Это метод управления потоком, который взаимодействует с базовым буфером записи ввода-вывода. Когда размер буфера достигает верхней границы, *drain()* блокируется, пока размер буфера не уменьшится до нижней границы, после чего запись можно возобновить. Если ждать нечего, [`drain()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamWriter.drain) возвращает управление немедленно.251252#### `async start_tls(sslcontext, *, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)`253254Обновляет существующее потоковое соединение до TLS.255256Параметры:257258- *sslcontext*: настроенный экземпляр [`SSLContext`](https://python-all.ru/3.12/library/ssl.html#ssl.SSLContext).259- *server\_hostname*: задаёт или переопределяет имя узла, с которым будет сверяться сертификат целевого сервера.260- *ssl\_handshake\_timeout* – время в секундах ожидания завершения рукопожатия TLS перед разрывом соединения. `60.0` секунд, если `None` (по умолчанию).261- *ssl\_shutdown\_timeout* – время в секундах ожидания завершения закрытия SSL перед разрывом соединения. `30.0` секунд, если `None` (по умолчанию).262263Добавлено в версии 3.12.264265Изменено в версии 3.12: Добавлен параметр *ssl\_shutdown\_timeout*.266267#### `is_closing()`268269Возвращает `True`, если поток данных закрыт или находится в процессе закрытия.270271Добавлено в версии 3.7.272273#### `async wait_closed()`274275Ожидает закрытия потока данных.276277Должен вызываться после [`close()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.StreamWriter.close), чтобы дождаться закрытия базового соединения и гарантировать, что все данные будут сброшены перед, например, выходом из программы.278279Добавлено в версии 3.7.280281## Примеры282283### TCP-эхо-клиент с использованием потоков данных284285TCP-эхо-клиент с использованием функции [`asyncio.open_connection()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.open_connection):286287```python288import asyncio289290async def tcp_echo_client(message):291 reader, writer = await asyncio.open_connection(292 '127.0.0.1', 8888)293294 print(f'Send: {message!r}')295 writer.write(message.encode())296 await writer.drain()297298 data = await reader.read(100)299 print(f'Received: {data.decode()!r}')300301 print('Close the connection')302 writer.close()303 await writer.wait_closed()304305asyncio.run(tcp_echo_client('Hello World!'))306```307308> **См. также**309>310> Пример [протокол TCP-эхо-клиента](https://python-all.ru/3.12/library/asyncio-protocol.html#asyncio-example-tcp-echo-client-protocol) использует низкоуровневый метод [`loop.create_connection()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.loop.create_connection).311312### TCP-эхо-сервер с использованием потоков данных313314TCP-эхо-сервер с использованием функции [`asyncio.start_server()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.start_server):315316```python317import asyncio318319async def handle_echo(reader, writer):320 data = await reader.read(100)321 message = data.decode()322 addr = writer.get_extra_info('peername')323324 print(f"Received {message!r} from {addr!r}")325326 print(f"Send: {message!r}")327 writer.write(data)328 await writer.drain()329330 print("Close the connection")331 writer.close()332 await writer.wait_closed()333334async def main():335 server = await asyncio.start_server(336 handle_echo, '127.0.0.1', 8888)337338 addrs = ', '.join(str(sock.getsockname()) for sock in server.sockets)339 print(f'Serving on {addrs}')340341 async with server:342 await server.serve_forever()343344asyncio.run(main())345```346347> **См. также**348>349> Пример [протокол TCP-эхо-сервера](https://python-all.ru/3.12/library/asyncio-protocol.html#asyncio-example-tcp-echo-server-protocol) использует метод [`loop.create_server()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.loop.create_server).350351### Получение HTTP-заголовков352353Простой пример получения HTTP-заголовков URL, переданного в командной строке:354355```python356import asyncio357import urllib.parse358import sys359360async def print_http_headers(url):361 url = urllib.parse.urlsplit(url)362 if url.scheme == 'https':363 reader, writer = await asyncio.open_connection(364 url.hostname, 443, ssl=True)365 else:366 reader, writer = await asyncio.open_connection(367 url.hostname, 80)368369 query = (370 f"HEAD {url.path or '/'} HTTP/1.0\r\n"371 f"Host: {url.hostname}\r\n"372 f"\r\n"373 )374375 writer.write(query.encode('latin-1'))376 while True:377 line = await reader.readline()378 if not line:379 break380381 line = line.decode('latin1').rstrip()382 if line:383 print(f'HTTP header> {line}')384385 # Игнорировать тело, закрыть сокет386 writer.close()387 await writer.wait_closed()388389url = sys.argv[1]390asyncio.run(print_http_headers(url))391```392393Использование:394395```python396python example.py http://example.com/path/page.html397```398399или с HTTPS:400401```python402python example.py https://example.com/path/page.html403```404405### Регистрация открытого сокета для ожидания данных с использованием потоков данных406407Корутина, ожидающая получения данных сокетом с помощью функции [`open_connection()`](https://python-all.ru/3.12/library/asyncio-stream.html#asyncio.open_connection):408409```python410import asyncio411import socket412413async def wait_for_data():414 # Получить ссылку на текущий цикл событий, так как415 # мы хотим получить доступ к низкоуровневым API.416 loop = asyncio.get_running_loop()417418 # Создать пару соединённых сокетов.419 rsock, wsock = socket.socketpair()420421 # Зарегистрировать открытый сокет для ожидания данных.422 reader, writer = await asyncio.open_connection(sock=rsock)423424 # Симулировать приём данных из сети425 loop.call_soon(wsock.send, 'abc'.encode())426427 # Ожидать данные428 data = await reader.read(100)429430 # Данные получены, всё готово: закрыть сокет431 print("Received:", data.decode())432 writer.close()433 await writer.wait_closed()434435 # Закрыть второй сокет436 wsock.close()437438asyncio.run(wait_for_data())439```440441> **См. также**442>443> Пример [регистрация открытого сокета для ожидания данных с использованием протокола](https://python-all.ru/3.12/library/asyncio-protocol.html#asyncio-example-create-connection) использует низкоуровневый протокол и метод [`loop.create_connection()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.loop.create_connection).444>445> Пример [наблюдения за файловым дескриптором на предмет событий чтения](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio-example-watch-fd) использует низкоуровневый метод [`loop.add_reader()`](https://python-all.ru/3.12/library/asyncio-eventloop.html#asyncio.loop.add_reader) для наблюдения за файловым дескриптором.446