Подпроцессы

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

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

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

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

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

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

Изменено в версии 3.10: Удалён параметр loop.

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

Выполнить команду оболочки cmd.

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

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

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

Важно

Приложению необходимо убедиться, что все пробелы и специальные символы должным образом заключены в кавычки, чтобы избежать уязвимостей внедрения оболочки. Функция shlex.quote() может использоваться для правильного экранирования пробелов и специальных символов оболочки в строках, которые будут использоваться для построения команд оболочки.

Изменено в версии 3.10: Удалён параметр loop.

Константы

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() реализован как блокирующий цикл ожидания;
• параметр universal_newlines не поддерживается.

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

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

coroutine wait()

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

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

Примечание

Этот метод может привести к тупику при использовании stdout=PIPE или stderr=PIPE, если дочерний процесс генерирует большой объем вывода, блокируя ожидание буфера канала ОС для получения дополнительных данных. Используйте метод 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).

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

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