Потоки данных¶Streams

StreamReader¶

class asyncio.StreamReader¶

Представляет объект чтения, предоставляющий API для чтения данных из потока ввода-вывода. Как асинхронный итерируемый объект, этот объект поддерживает инструкцию async for.

Не рекомендуется создавать объекты StreamReader напрямую; вместо этого используйте open_connection() и start_server().

feed_eof()¶

Подтверждает конец файла (EOF).

async read(n=-1)¶

Читает до n байт из потока.

Если n не указан или равен -1, читает до EOF, затем возвращает все прочитанные bytes. Если получен EOF и внутренний буфер пуст, возвращает пустой объект bytes.

Если n равен 0, немедленно возвращает пустой объект bytes.

Если n положительный, возвращает не более n доступных bytes, как только во внутреннем буфере появляется хотя бы 1 байт. Если EOF получен до чтения хотя бы одного байта, возвращается пустой объект bytes.

async readline()¶

Читает одну строку, где «строка» – это последовательность байтов, заканчивающаяся \n.

Если получен EOF и \n не найден, метод возвращает частично прочитанные данные.

Если получен EOF и внутренний буфер пуст, возвращается пустой объект bytes.

async readexactly(n)¶

Прочитать ровно n байт.

Возбуждается IncompleteReadError, если EOF достигнут до того, как прочитано n байт. Используйте атрибут IncompleteReadError.partial, чтобы получить частично прочитанные данные.

async readuntil(separator=b'\n')¶

Читает данные из потока до тех пор, пока не будет найден separator.

В случае успеха данные и разделитель удаляются из внутреннего буфера (потребляются). Возвращаемые данные включают разделитель в конце.

Если объем прочитанных данных превышает настроенный лимит потока, возбуждается исключение LimitOverrunError, а данные остаются во внутреннем буфере и могут быть прочитаны снова.

Если EOF достигнут до того, как найден полный разделитель, возбуждается исключение IncompleteReadError, и внутренний буфер сбрасывается. Атрибут IncompleteReadError.partial может содержать часть разделителя.

separator также может быть кортежем разделителей. В этом случае возвращаемое значение будет кратчайшей возможной строкой, у которой любой из разделителей является суффиксом. Для целей LimitOverrunError кратчайшим возможным разделителем считается тот, который совпал.

Добавлено в версии 3.5.2.

Изменено в версии 3.13: Параметр separator теперь может быть tuple разделителей.

at_eof()¶

Возвращает True, если буфер пуст и был вызван feed_eof().

StreamWriter¶

class asyncio.StreamWriter¶

Представляет объект-писатель, предоставляющий API для записи данных в поток ввода-вывода.

Не рекомендуется создавать объекты StreamWriter напрямую; вместо этого используйте open_connection() и start_server().

write(data)¶

Метод пытается немедленно записать data в нижележащий сокет. Если это не удаётся, данные помещаются во внутренний буфер записи до тех пор, пока их нельзя будет отправить.

Буфер data должен быть объектом bytes, bytearray или C-непрерывным одномерным memoryview.

Метод следует использовать вместе с методом drain():

stream.write(data)
await stream.drain()

writelines(data)¶

Метод немедленно записывает список (или любой итерируемый объект) байт в нижележащий сокет. Если это не удаётся, данные помещаются во внутренний буфер записи до тех пор, пока их нельзя будет отправить.

Метод следует использовать вместе с методом drain():

stream.writelines(lines)
await stream.drain()

close()¶

Метод закрывает поток и нижележащий сокет.

Метод следует использовать, хотя это и не обязательно, вместе с методом wait_closed():

stream.close()
await stream.wait_closed()

can_write_eof()¶

Возвращает True, если нижележащий транспорт поддерживает метод write_eof(), и False в противном случае.

write_eof()¶

Закрывает конец потока для записи после сброса буферизованных данных записи.

transport¶

Возвращает базовый транспорт asyncio.

get_extra_info(name, default=None)¶

Предоставляет доступ к дополнительной информации о транспорте; подробнее см. BaseTransport.get_extra_info().

async drain()¶

Ожидает, когда можно будет возобновить запись в поток данных. Пример:

writer.write(data)
await writer.drain()

Это метод управления потоком, который взаимодействует с базовым буфером записи ввода-вывода. Когда размер буфера достигает верхней границы, drain() блокируется, пока размер буфера не уменьшится до нижней границы, после чего запись можно возобновить. Если ждать нечего, drain() возвращает управление немедленно.

async start_tls(sslcontext, *, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)¶

Обновляет существующее потоковое соединение до TLS.

Параметры:

• sslcontext: настроенный экземпляр SSLContext.

• server_hostname: задаёт или переопределяет имя узла, с которым будет сверяться сертификат целевого сервера.

• ssl_handshake_timeout – время в секундах ожидания завершения рукопожатия TLS перед разрывом соединения. 60.0 секунд, если None (по умолчанию).

• ssl_shutdown_timeout – время в секундах ожидания завершения закрытия SSL перед разрывом соединения. 30.0 секунд, если None (по умолчанию).

Добавлено в версии 3.12.

Изменено в версии 3.12: Добавлен параметр ssl_shutdown_timeout.

is_closing()¶

Возвращает True, если поток данных закрыт или находится в процессе закрытия.

Добавлено в версии 3.7.

async wait_closed()¶

Ожидает закрытия потока данных.

Должен вызываться после close(), чтобы дождаться закрытия базового соединения и гарантировать, что все данные будут сброшены перед, например, выходом из программы.

Добавлено в версии 3.7.

Примеры¶Examples

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())
    await writer.drain()

    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!'))

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()
    await writer.wait_closed()

async def main():
    server = await asyncio.start_server(
        handle_echo, '127.0.0.1', 8888)

    addrs = ', '.join(str(sock.getsockname()) for sock in server.sockets)
    print(f'Serving on {addrs}')

    async with server:
        await server.serve_forever()

asyncio.run(main())

import asyncio
import urllib.parse
import sys

async def print_http_headers(url):
    url = urllib.parse.urlsplit(url)
    if url.scheme == 'https':
        reader, writer = await asyncio.open_connection(
            url.hostname, 443, ssl=True)
    else:
        reader, writer = await asyncio.open_connection(
            url.hostname, 80)

    query = (
        f"HEAD {url.path or '/'} HTTP/1.0\r\n"
        f"Host: {url.hostname}\r\n"
        f"\r\n"
    )

    writer.write(query.encode('latin-1'))
    while True:
        line = await reader.readline()
        if not line:
            break

        line = line.decode('latin1').rstrip()
        if line:
            print(f'HTTP header> {line}')

    # Игнорировать тело, закрыть сокет
    writer.close()
    await writer.wait_closed()

url = sys.argv[1]
asyncio.run(print_http_headers(url))

python example.py http://example.com/path/page.html

python example.py https://example.com/path/page.html

import asyncio
import socket

async def wait_for_data():
    # Получить ссылку на текущий цикл событий, так как
    # мы хотим получить доступ к низкоуровневым API.
    loop = asyncio.get_running_loop()

    # Создать пару соединённых сокетов.
    rsock, wsock = socket.socketpair()

    # Зарегистрировать открытый сокет для ожидания данных.
    reader, writer = await asyncio.open_connection(sock=rsock)

    # Симулировать приём данных из сети
    loop.call_soon(wsock.send, 'abc'.encode())

    # Ожидать данные
    data = await reader.read(100)

    # Данные получены, всё готово: закрыть сокет
    print("Received:", data.decode())
    writer.close()
    await writer.wait_closed()

    # Закрыть второй сокет
    wsock.close()

asyncio.run(wait_for_data())