Analyser les options et les arguments avec getopts

Tout script réaliste doit un jour accepter des options comme -v, -o output.txt ou -n 5. Les analyser manuellement avec $1, $2… devient rapidement fragile.

getopts est la commande intégrée standardisée par POSIX qui gère de manière fiable les options courtes (-a, -b), y compris celles qui prennent un argument. Elle est intégrée à tous les shells POSIX, aucune dépendance n'est donc nécessaire.

• Gère les indicateurs regroupés : -vn 5 = -v -n 5
• Signale proprement les options inconnues
• Définit automatiquement les variables standard OPTIND et OPTARG

Dans cette leçon, vous allez créer à partir de zéro une interface CLI complète et professionnelle avec getopts.

La syntaxe de base est une boucle while qui appelle getopts à chaque itération :

while getopts "optstring" varname; do
  case "$varname" in
    ...
  esac
done

• optstring — une chaîne listant chaque lettre d'option acceptée. Deux-points après une lettre signifie que cette option nécessite un argument.
• varname — reçoit la lettre de l'option actuelle à chaque itération.
• OPTARG — reçoit automatiquement la valeur de l'argument lorsqu'un deux-points suit la lettre.
• OPTIND — index du prochain argument à traiter ; utilisez shift $((OPTIND - 1)) après la boucle pour exposer les paramètres positionnels restants.

L'optstring est une déclaration compacte du contrat de votre interface CLI. Chaque caractère représente un indicateur accepté.

• 'abc' — accepte -a, -b et -c (sans arguments)
• 'a:bc' — -a nécessite un argument ; -b et -c n'en nécessitent pas
• ':abc' — un deux-points initial active le mode d'erreur silencieux (votre script gère les mauvaises options au lieu que le shell affiche un message)

Le mode silencieux est préférable dans les scripts de production, car il vous donne un contrôle total sur les messages d'erreur et les codes de sortie.

Lorsqu'un indicateur est suivi d'un deux-points dans l'optstring, getopts enregistre sa valeur dans OPTARG. L'utilisateur peut écrire l'argument avec ou sans espace :

• -o report.txt
• -oreport.txt

Les deux formes sont analysées de manière identique. C'est l'un des principaux avantages par rapport à l'analyse manuelle avec $1/shift.

En mode silencieux (':' au début de l'optstring), l'absence d'un argument amène getopts à définir varname sur : et OPTARG sur la lettre de l'option, ce qui est idéal pour afficher un message d'erreur ciblé.

Lorsque getopts a terminé, OPTIND contient l'index du premier argument qui n'est pas une option. Utilisez shift pour supprimer toutes les options traitées afin que $1, $2… désignent les paramètres positionnels restants (par exemple, les noms de fichiers).

La construction idiomatique est toujours :

shift $((OPTIND - 1))

Après le décalage, $@ contient uniquement les arguments qui n'étaient pas des indicateurs, c'est-à-dire les opérandes de votre commande.

Un script professionnel fournit toujours une fonction usage() qui affiche un message d'aide et quitte le shell. La convention est la suivante :

• Afficher sur la sortie d'erreur standard (descripteur 2) afin de ne pas polluer la sortie dirigée vers un pipeline
• Quitter avec le code 0 pour -h / --help, et avec le code 1 en cas d'utilisation invalide
• Appeler usage 1 depuis les chemins d'erreur et usage 0 depuis le gestionnaire de -h

Après l'analyse, validez les valeurs et définissez les valeurs par défaut avant d'effectuer un quelconque travail réel. Séparez la phase d'analyse (la boucle) de la phase logique. Les deux sections sont ainsi plus faciles à lire et à tester.

• Utilisez ${VAR:-default} pour les valeurs par défaut intégrées
• Validez les arguments numériques avec une expression régulière ou une vérification arithmétique
• Vérifiez que les options obligatoires ont bien été fournies

getopts gère automatiquement les indicateurs courts regroupés et écrits sans espaces, conformément à la convention Unix :

• -v -q équivaut à -vq
• -n 5 -v équivaut à -n5 -v ou à -vn5

Vous n'avez pas besoin d'écrire de code supplémentaire pour prendre cette forme en charge : getopts parcourt automatiquement chaque caractère d'une chaîne d'options regroupées. C'est une autre raison importante d'utiliser getopts plutôt qu'une analyse manuelle.

Les commandes Unix acceptent -- (double tiret) comme signal explicite indiquant que le traitement des options doit s'arrêter. Tout ce qui suit -- est traité comme un argument positionnel, même si cela ressemble à un indicateur.

getopts s'arrête automatiquement lorsqu'il rencontre --. Après shift $((OPTIND - 1)), le double tiret a disparu et $@ contient uniquement les opérandes.

C'est important pour les scripts qui travaillent sur des noms de fichiers pouvant commencer par un tiret, par exemple :

myscript.sh -v -- -strangefile.txt

Dans les scripts modulaires, vous pouvez encapsuler getopts dans une fonction parse_args() qui définit des variables globales (ou des variables référencées par nom). Cela permet de garder main() clair et de charger l'analyseur depuis d'autres scripts.

Règles essentielles de ce modèle :

• Déclarez les variables d'option avant d'appeler la fonction
• Utilisez des variables global ou transmettez les valeurs par référence nommée (declare -n)
• Retournez un code de sortie différent de zéro en cas d'entrée incorrecte afin que main puisse réagir

Voici un script complet, réaliste, qui utilise tout ce qui a été présenté dans cette leçon : un optstring avec arguments obligatoires, le mode d'erreur silencieux, une fonction d'utilisation, des valeurs par défaut, la validation et le décalage avec OPTIND.

Étudiez sa structure : c'est le modèle que vous devez suivre dans chaque script nécessitant une interface CLI.

Lisez l'appel getopts suivant et choisissez la description correcte de son comportement :

while getopts ':f:vq' opt; do

Vous avez appris à créer des interfaces professionnelles en ligne de commande dans Bash à l'aide de getopts. Voici un résumé des points essentiels :

• Syntaxe de l'optstring — les lettres sans deux-points sont des indicateurs booléens ; un deux-points après une lettre signifie qu'elle nécessite un argument ; un deux-points initial active le mode d'erreur silencieux
• OPTARG — contient automatiquement la valeur de l'argument pour les options qui en nécessitent un
• OPTIND — utilisez shift $((OPTIND - 1)) après la boucle pour exposer les paramètres positionnels restants dans $@
• Mode d'erreur silencieux — recommandé en production ; gérez vous-même les cas : (argument manquant) et \? (option inconnue) pour garder le contrôle
• Fonction usage() — écrivez-en toujours une ; affichez le message sur la sortie d'erreur standard, quittez avec 0 pour -h et avec 1 en cas d'erreur
• Indicateurs regroupés — getopts gère automatiquement -vq et -n5, sans code supplémentaire
• Modèle modulaire — encapsulez getopts dans une fonction parse_args() pour obtenir des scripts clairs et réutilisables

Maîtriser getopts transforme vos scripts d'outils à usage unique en programmes CLI fiables et faciles à utiliser, conformes aux conventions Unix.