pty — Утилиты псевдотерминалов

Исходный код: Lib/pty.py

Модуль pty определяет операции для работы с концепцией псевдотерминала: запуск другого процесса и возможность программно писать в него и читать из него данные.

Поскольку обработка псевдотерминалов сильно зависит от платформы, код для этого существует только для Linux. (Код для Linux должен работать и на других платформах, но еще не тестировался.)

Модуль pty определяет следующие функции:

pty.fork()

Fork. Подключает управляющий терминал дочернего процесса к псевдотерминалу. Возвращаемое значение — (pid, fd). Обратите внимание, что дочерний процесс получает pid 0, а fd — недействителен. Возвращаемое значение родительского процесса — pid дочернего процесса, а fd — дескриптор файла, подключенный к управляющему терминалу дочернего процесса (а также к стандартному вводу и выводу дочернего процесса).

pty.openpty()

Открывает новую пару псевдотерминалов, используя os.openpty(), если это возможно, или код эмуляции для универсальных Unix-систем. Возвращает пару дескрипторов файлов (master, slave), для ведущего и ведомого концов, соответственно.

pty.spawn(argv[, master_read[, stdin_read]])

Запускает процесс и подключает его управляющий терминал к стандартному вводу/выводу текущего процесса. Это часто используется для обработки программ, которые настаивают на чтении из управляющего терминала. Ожидается, что процесс, запущенный через pty, в конечном итоге завершится, и при этом spawn вернет результат.

Функциям master_read и stdin_read передается дескриптор файла, из которого они должны читать, и они должны всегда возвращать строку байтов. Чтобы принудительно вернуть spawn до завершения дочернего процесса, необходимо сгенерировать OSError.

По умолчанию обе функции будут читать и возвращать до 1024 байтов каждый раз при вызове функции. Функция обратного вызова master_read получает дескриптор файла ведущего псевдотерминала для чтения выходных данных от дочернего процесса, а stdin_read получает дескриптор файла 0 для чтения из стандартного ввода родительского процесса.

Возврат пустой строки байтов из любого обратного вызова интерпретируется как условие конца файла (EOF), и этот обратный вызов больше не будет вызываться после этого. Если stdin_read сигнализирует об EOF, управляющий терминал больше не может общаться с родительским процессом ИЛИ дочерним процессом. Если дочерний процесс не завершится без ввода, spawn будет зацикливаться вечно. Если master_read сигнализирует об EOF, наблюдается аналогичное поведение (по крайней мере, в Linux).

Если оба обратных вызова сигнализируют об EOF, spawn, вероятно, никогда не вернется, если только select не выдаст ошибку на вашей платформе при передаче трех пустых списков. Это ошибка, документированная в issue 26228.

Изменено в версии 3.4: spawn() теперь возвращает значение состояния из os.waitpid() дочернего процесса.

Пример

Следующая программа имитирует Unix-команду script(1), используя псевдотерминал для записи всех ввода-вывода сеанса терминала в «typescript».

import argparse
import os
import pty
import sys
import time

parser = argparse.ArgumentParser()
parser.add_argument('-a', dest='append', action='store_true')
parser.add_argument('-p', dest='use_python', action='store_true')
parser.add_argument('filename', nargs='?', default='typescript')
options = parser.parse_args()

shell = sys.executable if options.use_python else os.environ.get('SHELL', 'sh')
filename = options.filename
mode = 'ab' if options.append else 'wb'

with open(filename, mode) as script:
    def read(fd):
        data = os.read(fd, 1024)
        script.write(data)
        return data

    print('Script started, file is', filename)
    script.write(('Script started on %s\n' % time.asctime()).encode())

    pty.spawn(shell, read)

    script.write(('Script done on %s\n' % time.asctime()).encode())
    print('Script done, file is', filename)