Подпроцессы¶

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

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

Важно

Приложение несет ответственность за то, чтобы все пробелы и специальные символы были заключены в соответствующие кавычки, чтобы избежать уязвимостей shell injection. Функция 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, аналогичный API класса subprocess.Popen, но есть некоторые заметные отличия:

• в отличие от Popen, экземпляры процессов не имеют эквивалента методу poll();

• методы communicate() и wait() не имеют параметра timeout: используйте функцию wait_for();

• метод Process.wait() является асинхронным, тогда как метод subprocess.Popen.wait() реализован как блокирующий цикл занятости;

• параметр universal_newlines не поддерживается.

Этот класс имеет значение not thread safe.

Смотрите также раздел Subprocess and Threads.

coroutine wait()¶

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

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

Примечание

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

coroutine communicate(input=None)¶

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

1. отправить данные в stdin (если значение input не равно None);

2. считывайте данные из stdout и stderr, пока не будет достигнут EOF;

3. дождитесь завершения процесса.

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

Возвращает кортеж (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 этот метод отправляет 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}")