sys

Accès à l’interpréteur : arguments de la ligne de commande, fin du programme, version de Python et flux.

Sur cette page

Exemple

#
Python
import sys

if len(sys.argv) < 2:
    print("Usage : python bonjour.py PRENOM")
    sys.exit(1)

name = sys.argv[1]
print(f"Bonjour, {name} !")
print(sys.argv)
Résultat
Bonjour, Léa !
['bonjour.py', 'Léa']

Résultat pour la commande python bonjour.py Léa. Lancé sans argument, le programme affiche le mode d’emploi et se termine avec le code 1.

Définition et utilisation

#

Le module sys donne accès aux informations et aux réglages de l’interpréteur Python lui-même. On en utilise le plus souvent la liste sys.argv des arguments de la ligne de commande et la fonction sys.exit(), qui termine le programme avec un code de sortie donné.

sys.argv[0] est le nom du script lancé, et les éléments suivants sont les arguments saisis après lui, toujours sous forme de chaînes. Un code de sortie 0 signifie le succès, et tout autre nombre une erreur. Il est lu par les scripts shell et les outils qui lancent votre programme.

Le module fournit aussi les flux standard sys.stdin, sys.stdout et sys.stderr, la version de l’interpréteur dans sys.version_info, le nom du système dans sys.platform et la liste des dossiers parcourus lors d’un import dans sys.path.

Syntaxe

#
Syntaxe
import sys

sys.argv
sys.exit(code)
sys.version_info
sys.stderr

Plus d’exemples

#
La version de Python et la limite de récursion
Python
import sys

if sys.version_info >= (3, 10):
    print("La version de Python est suffisante")
else:
    print("Ce programme nécessite Python 3.10 ou plus récent")

print(sys.version_info.major)
print(sys.getrecursionlimit())
Résultatrésultat enregistré, vous pouvez le vérifier
La version de Python est suffisante
3
1000

getrecursionlimit() renvoie la profondeur maximale des appels récursifs, 1000 par défaut.

Erreurs sur stderr et code de sortie
Python
import sys

def fail(message):
    print(f"Erreur : {message}", file=sys.stderr)
    sys.exit(1)

print("Chargement des données...")
fail("fichier cours.json manquant")
print("Cette ligne ne s’exécutera pas")
Résultatrésultat enregistré, vous pouvez le vérifier
Chargement des données...
Erreur : fichier cours.json manquant

La deuxième ligne va dans le flux d’erreurs (stderr), donc une redirection python app.py > log.txt n’écrira que la première dans le fichier. Le programme se termine avec le code 1.

Bonnes pratiques

#
  • Pour des arguments de ligne de commande élaborés, avec des options et une aide automatique, utilisez le module argparse plutôt que de lire sys.argv à la main.
  • Les arguments de sys.argv sont des chaînes. Convertissez les nombres avec int() et gérez une valeur invalide.
  • Affichez les messages d’erreur sur sys.stderr, afin qu’ils ne se mélangent pas au véritable résultat du programme.

Entrées associées

#

Pratiquer dans les leçons

#

Vous voyez une erreur ou il manque un exemple ? Écrivez-nous.