Потоки

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 может содержать часть разделителя.

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 в сокет. Если это не удается, данные помещаются в внутренний буфер записи, пока не смогут быть отправлены.

Метод следует использовать вместе с методом 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, ssl_shutdown_timeout=None)

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

Параметры:

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

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

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

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())