asyncio-stream.md
1> **Источник:** https://python-all.ru/3.11/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.11/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.11/library/asyncio-stream.html#examples) ниже.3940Функции потоков данных4142Следующие функции asyncio верхнего уровня можно использовать для создания и работы с потоками данных:4344#### `coroutine 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.11/library/asyncio-stream.html#asyncio.StreamReader) и [`StreamWriter`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.StreamWriter).4950Параметр *limit* определяет ограничение размера буфера, используемого возвращаемым экземпляром [`StreamReader`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.StreamReader). По умолчанию *limit* установлен в 64 КиБ.5152Остальные аргументы передаются напрямую в [`loop.create_connection()`](https://python-all.ru/3.11/library/asyncio-eventloop.html#asyncio.loop.create_connection).5354> **Примечание**55>56> Аргумент *sock* передаёт владение сокетом созданному [`StreamWriter`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.StreamWriter). Чтобы закрыть сокет, вызовите его метод [`close()`](https://python-all.ru/3.11/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#### `coroutine 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.11/library/asyncio-stream.html#asyncio.StreamReader) и [`StreamWriter`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.StreamWriter).7172*client\_connected\_cb* может быть обычным вызываемым объектом или [корутинной функцией](https://python-all.ru/3.11/library/asyncio-task.html#coroutine); если это корутинная функция, она будет автоматически запланирована как [`Task`](https://python-all.ru/3.11/library/asyncio-task.html#asyncio.Task).7374Параметр *limit* определяет ограничение размера буфера, используемого возвращаемым экземпляром [`StreamReader`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.StreamReader). По умолчанию *limit* установлен в 64 КиБ.7576Остальные аргументы передаются напрямую в [`loop.create_server()`](https://python-all.ru/3.11/library/asyncio-eventloop.html#asyncio.loop.create_server).7778> **Примечание**79>80> Аргумент *sock* передаёт владение сокетом созданному серверу. Чтобы закрыть сокет, вызовите метод сервера [`close()`](https://python-all.ru/3.11/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#### `coroutine asyncio.open_unix_connection(path=None, *, limit=None, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)`9192> Устанавливает соединение через Unix-сокет и возвращает пару `(reader, writer)`.93>94> Аналогично [`open_connection()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.open_connection), но работает с Unix-сокетами.95>96> См. также документацию [`loop.create_unix_connection()`](https://python-all.ru/3.11/library/asyncio-eventloop.html#asyncio.loop.create_unix_connection).97>98> > **Примечание**99> >100> > Аргумент *sock* передаёт владение сокетом созданному [`StreamWriter`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.StreamWriter). Чтобы закрыть сокет, вызовите его метод [`close()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.StreamWriter.close).101>102> [Доступность](https://python-all.ru/3.11/library/intro.html#availability): Unix.103>104> Изменено в версии 3.7: Добавлен параметр *ssl\_handshake\_timeout*. Параметр *path* теперь может быть [объектом, подобным пути](https://python-all.ru/3.11/glossary.html#term-path-like-object).105>106> Изменено в версии 3.10: Удалён параметр *loop*.107108Изменено в версии 3.11: Добавлен параметр *ssl\_shutdown\_timeout*.109110#### `coroutine 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)`111112Запуск сервера Unix-сокетов.113114Аналогично [`start_server()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.start_server), но работает с Unix-сокетами.115116См. также документацию [`loop.create_unix_server()`](https://python-all.ru/3.11/library/asyncio-eventloop.html#asyncio.loop.create_unix_server).117118> **Примечание**119>120> Аргумент *sock* передаёт владение сокетом созданному серверу. Чтобы закрыть сокет, вызовите метод сервера [`close()`](https://python-all.ru/3.11/library/asyncio-eventloop.html#asyncio.Server.close).121122[Доступность](https://python-all.ru/3.11/library/intro.html#availability): Unix.123124Изменено в версии 3.7: Добавлены параметры *ssl\_handshake\_timeout* и *start\_serving*. Параметр *path* теперь может быть [объектом, подобным пути](https://python-all.ru/3.11/glossary.html#term-path-like-object).125126Изменено в версии 3.10: Удалён параметр *loop*.127128Изменено в версии 3.11: Добавлен параметр *ssl\_shutdown\_timeout*.129130## StreamReader131132#### `class asyncio.StreamReader`133134Представляет объект чтения, предоставляющий API для чтения данных из потока ввода-вывода. Как [асинхронный итерируемый объект](https://python-all.ru/3.11/glossary.html#term-asynchronous-iterable), этот объект поддерживает инструкцию [`async for`](https://python-all.ru/3.11/reference/compound_stmts.html#async-for).135136Не рекомендуется создавать объекты *StreamReader* напрямую; вместо этого используйте [`open_connection()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.open_connection) и [`start_server()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.start_server).137138#### `feed_eof()`139140Подтверждает конец файла (EOF).141142#### `coroutine read(n=-1)`143144Читает до *n* байт из потока.145146Если *n* не указан или равен `-1`, читает до EOF, затем возвращает все прочитанные [`bytes`](https://python-all.ru/3.11/library/stdtypes.html#bytes). Если получен EOF и внутренний буфер пуст, возвращает пустой объект `bytes`.147148Если *n* равен `0`, немедленно возвращает пустой объект `bytes`.149150Если *n* положительный, возвращает не более *n* доступных `bytes`, как только во внутреннем буфере появляется хотя бы 1 байт. Если EOF получен до чтения хотя бы одного байта, возвращается пустой объект `bytes`.151152#### `coroutine readline()`153154Читает одну строку, где «строка» – это последовательность байтов, заканчивающаяся `\n`.155156Если получен EOF и `\n` не найден, метод возвращает частично прочитанные данные.157158Если получен EOF и внутренний буфер пуст, возвращается пустой объект `bytes`.159160#### `coroutine readexactly(n)`161162Прочитать ровно *n* байт.163164Возбуждается [`IncompleteReadError`](https://python-all.ru/3.11/library/asyncio-exceptions.html#asyncio.IncompleteReadError), если EOF достигнут до того, как прочитано *n* байт. Используйте атрибут [`IncompleteReadError.partial`](https://python-all.ru/3.11/library/asyncio-exceptions.html#asyncio.IncompleteReadError.partial), чтобы получить частично прочитанные данные.165166#### `coroutine readuntil(separator=b'\n')`167168Читает данные из потока до тех пор, пока не будет найден *separator*.169170В случае успеха данные и разделитель удаляются из внутреннего буфера (потребляются). Возвращаемые данные включают разделитель в конце.171172Если объем прочитанных данных превышает настроенный лимит потока, возбуждается исключение [`LimitOverrunError`](https://python-all.ru/3.11/library/asyncio-exceptions.html#asyncio.LimitOverrunError), а данные остаются во внутреннем буфере и могут быть прочитаны снова.173174Если EOF достигнут до того, как найден полный разделитель, возбуждается исключение [`IncompleteReadError`](https://python-all.ru/3.11/library/asyncio-exceptions.html#asyncio.IncompleteReadError), и внутренний буфер сбрасывается. Атрибут [`IncompleteReadError.partial`](https://python-all.ru/3.11/library/asyncio-exceptions.html#asyncio.IncompleteReadError.partial) может содержать часть разделителя.175176Новое в версии 3.5.2.177178#### `at_eof()`179180Возвращает `True`, если буфер пуст и был вызван [`feed_eof()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.StreamReader.feed_eof).181182## StreamWriter183184#### `class asyncio.StreamWriter`185186Представляет объект-писатель, предоставляющий API для записи данных в поток ввода-вывода.187188Не рекомендуется создавать объекты *StreamWriter* напрямую; вместо этого используйте [`open_connection()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.open_connection) и [`start_server()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.start_server).189190#### `write(data)`191192Метод пытается немедленно записать *data* в нижележащий сокет. Если это не удаётся, данные помещаются во внутренний буфер записи до тех пор, пока их нельзя будет отправить.193194Метод следует использовать вместе с методом `drain()`:195196```python197stream.write(data)198await stream.drain()199```200201#### `writelines(data)`202203Метод немедленно записывает список (или любой итерируемый объект) байт в нижележащий сокет. Если это не удаётся, данные помещаются во внутренний буфер записи до тех пор, пока их нельзя будет отправить.204205Метод следует использовать вместе с методом `drain()`:206207```python208stream.writelines(lines)209await stream.drain()210```211212#### `close()`213214Метод закрывает поток и нижележащий сокет.215216Метод следует использовать, хотя это и не обязательно, вместе с методом `wait_closed()`:217218```python219stream.close()220await stream.wait_closed()221```222223#### `can_write_eof()`224225Возвращает `True`, если нижележащий транспорт поддерживает метод [`write_eof()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.StreamWriter.write_eof), и `False` в противном случае.226227#### `write_eof()`228229Закрывает конец потока для записи после сброса буферизованных данных записи.230231#### `transport`232233Возвращает базовый транспорт asyncio.234235#### `get_extra_info(name, default=None)`236237Предоставляет доступ к дополнительной информации о транспорте; подробнее см. [`BaseTransport.get_extra_info()`](https://python-all.ru/3.11/library/asyncio-protocol.html#asyncio.BaseTransport.get_extra_info).238239#### `coroutine drain()`240241Ожидает, когда можно будет возобновить запись в поток данных. Пример:242243```python244writer.write(data)245await writer.drain()246```247248Это метод управления потоком, который взаимодействует с базовым буфером записи ввода-вывода. Когда размер буфера достигает верхней границы, *drain()* блокируется, пока размер буфера не уменьшится до нижней границы, после чего запись можно возобновить. Если ждать нечего, [`drain()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.StreamWriter.drain) возвращает управление немедленно.249250#### `coroutine start_tls(sslcontext, *, server_hostname=None, ssl_handshake_timeout=None)`251252Обновляет существующее потоковое соединение до TLS.253254Параметры:255256- *sslcontext*: настроенный экземпляр [`SSLContext`](https://python-all.ru/3.11/library/ssl.html#ssl.SSLContext).257- *server\_hostname*: задаёт или переопределяет имя узла, с которым будет сверяться сертификат целевого сервера.258- *ssl\_handshake\_timeout* – время в секундах ожидания завершения рукопожатия TLS перед разрывом соединения. `60.0` секунд, если `None` (по умолчанию).259260Новое в версии 3.11.261262#### `is_closing()`263264Возвращает `True`, если поток данных закрыт или находится в процессе закрытия.265266Добавлено в версии 3.7.267268#### `coroutine wait_closed()`269270Ожидает закрытия потока данных.271272Должен вызываться после [`close()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.StreamWriter.close), чтобы дождаться закрытия базового соединения и гарантировать, что все данные будут сброшены перед, например, выходом из программы.273274Добавлено в версии 3.7.275276## Примеры277278### TCP-эхо-клиент с использованием потоков данных279280TCP-эхо-клиент с использованием функции [`asyncio.open_connection()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.open_connection):281282```python283import asyncio284285async def tcp_echo_client(message):286 reader, writer = await asyncio.open_connection(287 '127.0.0.1', 8888)288289 print(f'Send: {message!r}')290 writer.write(message.encode())291 await writer.drain()292293 data = await reader.read(100)294 print(f'Received: {data.decode()!r}')295296 print('Close the connection')297 writer.close()298 await writer.wait_closed()299300asyncio.run(tcp_echo_client('Hello World!'))301```302303> **См. также**304>305> Пример [протокол TCP-эхо-клиента](https://python-all.ru/3.11/library/asyncio-protocol.html#asyncio-example-tcp-echo-client-protocol) использует низкоуровневый метод [`loop.create_connection()`](https://python-all.ru/3.11/library/asyncio-eventloop.html#asyncio.loop.create_connection).306307### TCP-эхо-сервер с использованием потоков данных308309TCP-эхо-сервер с использованием функции [`asyncio.start_server()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.start_server):310311```python312import asyncio313314async def handle_echo(reader, writer):315 data = await reader.read(100)316 message = data.decode()317 addr = writer.get_extra_info('peername')318319 print(f"Received {message!r} from {addr!r}")320321 print(f"Send: {message!r}")322 writer.write(data)323 await writer.drain()324325 print("Close the connection")326 writer.close()327 await writer.wait_closed()328329async def main():330 server = await asyncio.start_server(331 handle_echo, '127.0.0.1', 8888)332333 addrs = ', '.join(str(sock.getsockname()) for sock in server.sockets)334 print(f'Serving on {addrs}')335336 async with server:337 await server.serve_forever()338339asyncio.run(main())340```341342> **См. также**343>344> Пример [протокол TCP-эхо-сервера](https://python-all.ru/3.11/library/asyncio-protocol.html#asyncio-example-tcp-echo-server-protocol) использует метод [`loop.create_server()`](https://python-all.ru/3.11/library/asyncio-eventloop.html#asyncio.loop.create_server).345346### Получение HTTP-заголовков347348Простой пример получения HTTP-заголовков URL, переданного в командной строке:349350```python351import asyncio352import urllib.parse353import sys354355async def print_http_headers(url):356 url = urllib.parse.urlsplit(url)357 if url.scheme == 'https':358 reader, writer = await asyncio.open_connection(359 url.hostname, 443, ssl=True)360 else:361 reader, writer = await asyncio.open_connection(362 url.hostname, 80)363364 query = (365 f"HEAD {url.path or '/'} HTTP/1.0\r\n"366 f"Host: {url.hostname}\r\n"367 f"\r\n"368 )369370 writer.write(query.encode('latin-1'))371 while True:372 line = await reader.readline()373 if not line:374 break375376 line = line.decode('latin1').rstrip()377 if line:378 print(f'HTTP header> {line}')379380 # Игнорировать тело, закрыть сокет381 writer.close()382 await writer.wait_closed()383384url = sys.argv[1]385asyncio.run(print_http_headers(url))386```387388Использование:389390```python391python example.py http://example.com/path/page.html392```393394или с HTTPS:395396```python397python example.py https://example.com/path/page.html398```399400### Регистрация открытого сокета для ожидания данных с использованием потоков данных401402Корутина, ожидающая получения данных сокетом с помощью функции [`open_connection()`](https://python-all.ru/3.11/library/asyncio-stream.html#asyncio.open_connection):403404```python405import asyncio406import socket407408async def wait_for_data():409 # Получить ссылку на текущий цикл событий, так как410 # мы хотим получить доступ к низкоуровневым API.411 loop = asyncio.get_running_loop()412413 # Создать пару соединённых сокетов.414 rsock, wsock = socket.socketpair()415416 # Зарегистрировать открытый сокет для ожидания данных.417 reader, writer = await asyncio.open_connection(sock=rsock)418419 # Симулировать приём данных из сети420 loop.call_soon(wsock.send, 'abc'.encode())421422 # Ожидать данные423 data = await reader.read(100)424425 # Данные получены, всё готово: закрыть сокет426 print("Received:", data.decode())427 writer.close()428 await writer.wait_closed()429430 # Закрыть второй сокет431 wsock.close()432433asyncio.run(wait_for_data())434```435436> **См. также**437>438> Пример [регистрация открытого сокета для ожидания данных с использованием протокола](https://python-all.ru/3.11/library/asyncio-protocol.html#asyncio-example-create-connection) использует низкоуровневый протокол и метод [`loop.create_connection()`](https://python-all.ru/3.11/library/asyncio-eventloop.html#asyncio.loop.create_connection).439>440> Пример [наблюдения за файловым дескриптором на предмет событий чтения](https://python-all.ru/3.11/library/asyncio-eventloop.html#asyncio-example-watch-fd) использует низкоуровневый метод [`loop.add_reader()`](https://python-all.ru/3.11/library/asyncio-eventloop.html#asyncio.loop.add_reader) для наблюдения за файловым дескриптором.441