Потоки

StreamReader

class asyncio.StreamReader

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

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

feed_eof()

Подтвердить EOF.

coroutine read(n=- 1)

Прочитать до n байтов из потока.

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

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

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

coroutine readline()

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

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

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

coroutine readexactly(n)

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

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

coroutine readuntil(separator=b'\n')

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

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

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

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

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

at_eof()

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

StreamWriter

class asyncio.StreamWriter

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

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

write(data)

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

Метод следует использовать совместно с методом 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() для получения подробностей.

coroutine drain()

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

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

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

coroutine start_tls(sslcontext, \*, server_hostname=None, ssl_handshake_timeout=None)

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

Параметры:

• sslcontext: настроенный экземпляр SSLContext.
• server_hostname: устанавливает или переопределяет имя хоста, по которому будет проверяться сертификат целевого сервера.
• ssl_handshake_timeout — время в секундах ожидания завершения рукопожатия TLS перед прерыванием соединения. 60.0 секунд, если None (по умолчанию).

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

is_closing()

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

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

coroutine wait_closed()

Ожидать закрытия потока.

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

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

Примеры

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

    # Ignore the body, close the socket
    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():
    # 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 = await asyncio.open_connection(sock=rsock)

    # Simulate the reception of data from the network
    loop.call_soon(wsock.send, 'abc'.encode())

    # Wait for data
    data = await reader.read(100)

    # Got data, we are done: close the socket
    print("Received:", data.decode())
    writer.close()
    await writer.wait_closed()

    # Close the second socket
    wsock.close()

asyncio.run(wait_for_data())