# `pty` --- Pseudo-terminal utilities

Code source : Lib/pty.py

The `pty` module defines operations for handling the pseudo-terminal concept: starting another process and being able to write to and read from its controlling terminal programmatically.

Disponibilité: Unix.

Pseudo-terminal handling is highly platform dependent. This code is mainly tested on Linux, FreeBSD, and macOS (it is supposed to work on other POSIX platforms but it's not been thoroughly tested).

The `pty` module defines the following functions:

pty.fork()

  Fork. Connecte le terminal contrôlé par le fils à un pseudo-terminal. La valeur renvoyée est `(pid, fd)`. Notez que le fils obtient `0` comme pid et un fd non valide. Le parent obtient le pid du fils, et fd un descripteur de fichier connecté à un terminal contrôlé par le fils (et donc à l'entrée et la sortie standard du fils).

  The returned file descriptor fd is non-inheritable.

  Avertissement

  On macOS the use of this function is unsafe when mixed with using higher-level system APIs, and that includes using `urllib.request`.

  Modifié dans la version 3.15: The returned file descriptor is now made non-inheritable.

pty.openpty()

  Ouvre une nouvelle paire de pseudo-terminaux, en utilisant si possible `os.openpty()`, ou du code émulant la fonctionnalité pour des systèmes Unix génériques. Renvoie une paire de descripteurs de fichier `(master, slave)`, pour le maître et pour l'esclave respectivement.

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

  Crée un nouveau processus et connecte son terminal aux entrées/sorties standard du processus courant. Cette stratégie est typiquement utilisée pour les programmes qui veulent lire depuis leur propre terminal. Le processus créé utilisant le pty est supposé se terminer et, quand il le fera, l'appel de spawn terminera.

  A loop copies STDIN of the current process to the child and data received from the child to STDOUT of the current process. It is not signaled to the child if STDIN of the current process closes down.

  The functions master_read and stdin_read are passed a file descriptor which they should read from, and they should always return a byte string. In order to force spawn to return before the child process exits an empty byte array should be returned to signal end of file.

  L'implémentation par défaut pour les deux fonctions lit et renvoie jusqu'à 1024 octets à chaque appel de la fonction. La fonction de rappel master_read reçoit le descripteur de fichier du pseudo-terminal maître pour lire la sortie du processus enfant, et stdin_read reçoit le descripteur de fichier 0, pour lire l'entrée standard du processus parent.

  Le renvoi d'une chaîne d'octets vide à partir de l'un ou l'autre des rappels est interprété comme une condition de fin de fichier (EOF), et ce rappel ne sera pas appelé après cela. Si stdin_read signale EOF, le terminal de contrôle ne peut plus communiquer avec le processus parent OU le processus enfant. À moins que le processus enfant ne quitte sans aucune entrée, spawn sera lancé dans une boucle infinie. Si master_read indique la fin de fichier, on aura le même comportement (sur Linux au moins).

  Return the exit status value from `os.waitpid()` on the child process.

  `os.waitstatus_to_exitcode()` can be used to convert the exit status into an exit code.

  Raises an auditing event `pty.spawn` with argument `argv`.

  Modifié dans la version 3.4: `spawn()` renvoie maintenant la valeur renvoyée par `os.waitpid()` sur le processus fils.

## Exemple

Le programme suivant se comporte comme la commande Unix script(1), utilisant un pseudo-terminal pour enregistrer toutes les entrées et sorties d'une session dans un fichier 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)