pty --- 偽終端工具?

源代碼: Lib/pty.py


pty 模塊定義了一些處理“偽終端”概念的操作:?jiǎn)?dòng)另一個(gè)進(jìn)程并能以程序方式在其控制終端中進(jìn)行讀寫(xiě)。

偽終端處理高度依賴(lài)于具體平臺。 此代碼主要針對 Linux, FreeBSD 和 macOS 進(jìn)行了測試(它應當也能在其他 POSIX 平臺上工作,但是未經(jīng)充分測試)。

pty 模塊定義了下列函數:

pty.fork()?

分叉。 將子進(jìn)程的控制終端連接到一個(gè)偽終端。 返回值為 (pid, fd)。 請注意子進(jìn)程獲得 pid 0 而 fdinvalid。 父進(jìn)程返回值為子進(jìn)程的 pidfd 為一個(gè)連接到子進(jìn)程的控制終端(并同時(shí)連接到子進(jìn)程的標準輸入和輸出)的文件描述符。

pty.openpty()?

打開(kāi)一個(gè)新的偽終端對,如果可能將使用 os.openpty(),或是針對通用 Unix 系統的模擬代碼。 返回一個(gè)文件描述符對 (master, slave),分別表示主從兩端。

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

生成一個(gè)進(jìn)程,并將其控制終端連接到當前進(jìn)程的標準 io。 這常被用來(lái)應對堅持要從控制終端讀取數據的程序。 在 pty 背后生成的進(jìn)程預期最后將被終止,而且當它被終止時(shí) spawn 將會(huì )返回。

將當前進(jìn)程的 STDIN 拷貝到子進(jìn)程并將從子進(jìn)程接收的數據拷貝到當前進(jìn)程的 STDOUT 的循環(huán)。 如果當前進(jìn)程的 STDIN 關(guān)閉則它不會(huì )向子進(jìn)程發(fā)信號。

master_readstdin_read 函數會(huì )被傳入一個(gè)文件描述符供它們讀取內容,并且它們總是應當返回一個(gè)字節串。 為了強制 spawn 在子進(jìn)程退出之前返回,應當返回一個(gè)空字節數組來(lái)提示文件的結束。

兩個(gè)函數的默認實(shí)現在每次函數被調用時(shí)將讀取并返回至多 1024 個(gè)字節。 會(huì )向 master_read 回調傳入偽終端的主文件描述符以從子進(jìn)程讀取輸出,而向 stdin_read 傳入文件描述符 0 以從父進(jìn)程的標準輸入讀取數據。

從兩個(gè)回調返回空字節串會(huì )被解讀為文件結束 (EOF) 條件,在此之后回調將不再被調用。 如果 stdin_read 發(fā)出 EOF 信號則控制終端就不能再與父進(jìn)程或子進(jìn)程進(jìn)行通信。 除非子進(jìn)程將不帶任何輸入就退出,否則隨后 spawn 將一直循環(huán)下去。 如果 master_read 發(fā)出 EOF 信號則會(huì )有相同的行為結果(至少是在 Linux 上)。

從子進(jìn)程中的 os.waitpid() 返回退出狀態(tài)值。

可以使用 waitstatus_to_exitcode() 來(lái)將退出狀態(tài)轉換為退出碼。

引發(fā)一個(gè) 審計事件 pty.spawn,附帶參數 argv。

在 3.4 版更改: spawn() 現在會(huì )從子進(jìn)程的 os.waitpid() 返回狀態(tài)值。

示例?

以下程序的作用類(lèi)似于 Unix 命令 script(1),它使用一個(gè)偽終端來(lái)記錄一個(gè) "typescript" 里終端進(jìn)程的所有輸入和輸出:

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)