Подпроцессы

В этом разделе описываются высокоуровневые API asyncio для создания и управления подпроцессами.

Вот пример того, как asyncio может выполнить командную строку и получить результат:

import asyncio

async def run(cmd):
    proc = await asyncio.create_subprocess_shell(
        cmd,
        stdout=asyncio.subprocess.PIPE,
        stderr=asyncio.subprocess.PIPE)

    stdout, stderr = await proc.communicate()

    print(f'[{cmd!r} exited with {proc.returncode}]')
    if stdout:
        print(f'[stdout]\n{stdout.decode()}')
    if stderr:
        print(f'[stderr]\n{stderr.decode()}')

asyncio.run(run('ls /zzz'))

выведет:

['ls /zzz' exited with 1]
[stderr]
ls: /zzz: No such file or directory

Поскольку все функции asyncio для подпроцессов асинхронны, и asyncio предоставляет множество инструментов для работы с такими функциями, легко выполнять и контролировать несколько подпроцессов параллельно. Действительно, легко изменить приведенный выше пример, чтобы запустить несколько команд одновременно:

async def main():
    await asyncio.gather(
        run('ls /zzz'),
        run('sleep 1; echo "hello"'))

asyncio.run(main())

См. также подраздел Примеры.

Создание подпроцессов

coroutine asyncio.create_subprocess_exec(program, *args, stdin=None, stdout=None, stderr=None, loop=None, limit=None, **kwds)

Создать подпроцесс.

Аргумент limit задает предел буфера для StreamReader обёртки для Process.stdout и Process.stderr (если subprocess.PIPE передано в аргументы stdout и stderr).

Возвращает экземпляр Process.

См. документацию по loop.subprocess_exec() для других параметров.

coroutine asyncio.create_subprocess_shell(cmd, stdin=None, stdout=None, stderr=None, loop=None, limit=None, **kwds)

Выполнить командную строку cmd.

Аргумент limit задаёт предел буфера для StreamReader обёртки для Process.stdout и Process.stderr (если subprocess.PIPE передано в аргументы stdout и stderr).

Возвращает экземпляр Process.

См. документацию по loop.subprocess_shell() для других параметров.

Константы

asyncio.subprocess.PIPE

Может быть передано в параметры stdin, stdout или stderr.

Если PIPE передано в аргумент stdin, атрибут Process.stdin будет указывать на экземпляр StreamWriter.

Если PIPE передано в аргументы stdout или stderr, атрибуты Process.stdout и Process.stderr будут указывать на экземпляры StreamReader.

asyncio.subprocess.STDOUT

Специальное значение, которое может использоваться в качестве аргумента stderr и указывает на то, что стандартная ошибка должна быть перенаправлена в стандартный вывод.

asyncio.subprocess.DEVNULL

Специальное значение, которое может использоваться в качестве аргумента stdin, stdout или stderr для функций создания процессов. Оно указывает, что для соответствующего потока подпроцесса будет использоваться специальный файл os.devnull.

Взаимодействие с подпроцессами

Обе функции create_subprocess_exec() и create_subprocess_shell() возвращают экземпляры класса Process. Process — это высокоуровневая обёртка, которая позволяет взаимодействовать с подпроцессами и отслеживать их завершение.

class asyncio.subprocess.Process

Объект, оборачивающий процессы ОС, созданные функциями create_subprocess_exec() и create_subprocess_shell().

Этот класс разработан для API, аналогичного классу subprocess.Popen, но есть некоторые заметные различия:

• в отличие от Popen, экземпляры Process не имеют эквивалента методу poll();
• методы communicate() и wait() не имеют параметра timeout: используйте функцию wait_for();
• метод Process.wait() является асинхронным, в то время как метод subprocess.Popen.wait() реализован как блокирующий цикл busy loop;
• параметр universal_newlines не поддерживается.

Этот класс не потокобезопасен.

См. также раздел Подпроцессы и потоки.

coroutine wait()

Ожидание завершения дочернего процесса.

Устанавливает и возвращает атрибут returncode.

Примечание

Этот метод может привести к тупиковой ситуации при использовании stdout=PIPE или stderr=PIPE и дочерний процесс генерирует так много вывода, что он блокируется, ожидая, пока буфер канала OS примет больше данных. Используйте метод communicate() при работе с каналами, чтобы избежать этой ситуации.

coroutine communicate(input=None)

Взаимодействие с процессом:

1. отправка данных в stdin (если input не None);
2. чтение данных из stdout и stderr, пока не будет достигнут EOF;
3. ожидание завершения процесса.

Необязательный аргумент input — данные (объект bytes), которые будут отправлены дочернему процессу.

Возвращает кортеж (stdout_data, stderr_data).

Если при записи input в stdin возникает исключение BrokenPipeError или ConnectionResetError, исключение игнорируется. Это происходит, когда процесс завершается до того, как все данные будут записаны в stdin.

Если требуется отправлять данные в stdin процесса, процесс необходимо создать с stdin=PIPE. Аналогично, чтобы получить что-либо, кроме None в кортеже результата, процесс необходимо создать с stdout=PIPE и/или stderr=PIPE аргументами.

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

send_signal(signal)

Отправка сигнала signal дочернему процессу.

Примечание

В Windows SIGTERM является алиасом для terminate(). CTRL_C_EVENT и CTRL_BREAK_EVENT могут быть отправлены процессам, запущенным с параметром creationflags, включающим CREATE_NEW_PROCESS_GROUP.

terminate()

Остановка дочернего процесса.

В системах POSIX этот метод отправляет signal.SIGTERM дочернему процессу.

В Windows вызывается функция Win32 API TerminateProcess() для остановки дочернего процесса.

kill()

Убить дочерний процесс.

В системах POSIX этот метод отправляет SIGKILL дочернему процессу.

В Windows этот метод является алиасом для terminate().

stdin

Поток стандартного ввода (StreamWriter) или None если процесс был создан с stdin=None.

stdout

Поток стандартного вывода (StreamReader) или None если процесс был создан с stdout=None.

stderr

Поток стандартной ошибки (StreamReader) или None если процесс был создан с stderr=None.

Предупреждение

Используйте метод communicate() вместо process.stdin.write(), await process.stdout.read() или await process.stderr.read. Это предотвращает тупиковые ситуации из-за приостановки чтения или записи потоков, блокирующих дочерний процесс.

pid

Идентификационный номер процесса (PID).

Обратите внимание, что для процессов, созданных функцией create_subprocess_shell(), этот атрибут является PID запущенной оболочки.

returncode

Код возврата процесса при его завершении.

Значение None указывает, что процесс еще не завершился.

Отрицательное значение -N указывает, что дочерний процесс был завершен сигналом N (только POSIX).

Подпроцессы и потоки

Стандартный цикл asyncio поддерживает запуск подпроцессов из разных потоков, но существуют ограничения:

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

Обратите внимание, что альтернативные реализации цикла asyncio могут не иметь указанных выше ограничений; обратитесь к их документации.

Примеры

Пример использования класса Process для управления подпроцессом и класса StreamReader для чтения из его стандартного вывода.

Подпроцесс создается функцией create_subprocess_exec():

import asyncio
import sys

async def get_date():
    code = 'import datetime; print(datetime.datetime.now())'

    # Create the subprocess; redirect the standard output
    # into a pipe.
    proc = await asyncio.create_subprocess_exec(
        sys.executable, '-c', code,
        stdout=asyncio.subprocess.PIPE)

    # Read one line of output.
    data = await proc.stdout.readline()
    line = data.decode('ascii').rstrip()

    # Wait for the subprocess exit.
    await proc.wait()
    return line

if sys.platform == "win32":
    asyncio.set_event_loop_policy(
        asyncio.WindowsProactorEventLoopPolicy())

date = asyncio.run(get_date())
print(f"Current date: {date}")

См. также аналогичный пример, написанный с использованием низкоуровневых API.