Потоки

StreamReader

class asyncio.StreamReader

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

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

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

New in version 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()

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

is_closing()

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

New in version 3.7.

coroutine wait_closed()

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

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

New in version 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())

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