getopt, getopts ou analyse manuelle - que dois-je utiliser lorsque je veux prendre en charge les options courtes et longues?

Actuellement, j'écris un script Bash qui a les exigences suivantes:

• il devrait fonctionner sur une grande variété de plates-formes Unix / Linux
• il devrait prendre en charge les options courtes et (GNU) longues

Je sais que ce getoptsserait le moyen préféré en termes de portabilité mais AFAIK ne prend pas en charge les options longues.

getoptprend en charge les options longues mais le BashGuide le déconseille fortement:

N'utilisez jamais getopt (1). getopt ne peut pas gérer des chaînes d'arguments vides ou des arguments avec des espaces blancs intégrés. Veuillez oublier qu'il a jamais existé.

Donc, il y a toujours la possibilité d'une analyse manuelle. Ceci est sujet aux erreurs, produit un peu de code passe-partout, et j'ai besoin de gérer les erreurs par moi-même (je suppose getopt(s)que le traitement des erreurs par eux-mêmes).

Alors, quel serait le choix préféré dans ce cas?

Si elle doit être portable sur une gamme d'unités, vous devez vous en tenir à POSIX sh. Et AFAIU là, vous n'avez tout simplement pas d'autre choix que de rouler la gestion des arguments à la main.

getoptvs getoptssemble être un problème religieux. Quant aux arguments contre getoptdans la FAQ Bash :

• " getoptne peut pas gérer les chaînes d'arguments vides" semble faire référence à un problème connu avec des arguments facultatifs , qui ne semble getoptspas du tout prendre en charge (du moins d'après la lecture help getoptsde Bash 4.2.24). De man getopt:

  getopt (3) peut analyser les options longues avec des arguments facultatifs auxquels un argument facultatif vide est donné (mais ne peut pas le faire pour les options courtes). Cette getopt (1) traite les arguments facultatifs qui sont vides comme s'ils n'étaient pas présents.

Je ne sais pas d'où vient le " getoptne peut pas gérer les [...] arguments avec des espaces intégrés", mais testons-le:

• test.sh:

  #!/usr/bin/env bash
  set -o errexit -o noclobber -o nounset -o pipefail
  params="$(getopt -o ab:c -l alpha,bravo:,charlie --name "$0" -- "$@")"
  eval set -- "$params"
  
  while true
  do
      case "$1" in
          -a|--alpha)
              echo alpha
              shift
              ;;
          -b|--bravo)
              echo "bravo=$2"
              shift 2
              ;;
          -c|--charlie)
              echo charlie
              shift
              ;;
          --)
              shift
              break
              ;;
          *)
              echo "Not implemented: $1" >&2
              exit 1
              ;;
      esac
  done

• courir:

  $ ./test.sh -
  $ ./test.sh -acb '   whitespace   FTW   '
  alpha
  charlie
  bravo=   whitespace   FTW   
  $ ./test.sh -ab '' -c
  alpha
  bravo=
  charlie
  $ ./test.sh --alpha --bravo '   whitespace   FTW   ' --charlie
  alpha
  bravo=   whitespace   FTW   
  charlie

On dirait chèque et compagnon pour moi, mais je suis sûr que quelqu'un va montrer comment j'ai complètement mal compris la phrase. Bien sûr, le problème de la portabilité persiste; vous devrez décider combien de temps vaut la peine d'investir dans des plateformes avec un Bash plus ancien ou aucun disponible. Ma propre astuce consiste à utiliser les directives YAGNI et KISS - Développez uniquement pour les plates-formes spécifiques que vous savez que vous allez utiliser. La portabilité du code shell atteint généralement 100% lorsque le temps de développement passe à l'infini.

Il y a ce getopts_long écrit comme une fonction shell POSIX que vous pouvez intégrer dans votre script.

Notez que Linux getopt(de util-linux) fonctionne correctement lorsqu'il n'est pas en mode traditionnel et prend en charge les options longues, mais n'est probablement pas une option pour vous si vous devez être portable sur d'autres Unices.

Les versions récentes de ksh93 ( getopts) et zsh ( zparseopts) ont un support intégré pour analyser les options longues qui pourraient être une option pour vous car elles sont disponibles pour la plupart des Unices (bien que souvent non installées par défaut).

Une autre option serait d'utiliser perlet son Getopt::Longmodule qui devrait être disponible sur la plupart des Unices de nos jours, soit en écrivant le script entier perlsoit en appelant simplement perl juste pour analyser l'option et envoyer les informations extraites au shell. Quelque chose comme:

parsed_ops=$(
  perl -MGetopt::Long -le '

    @options = (
      "foo=s", "bar", "neg!"
    );

    Getopt::Long::Configure "bundling";
    $q="'\''";
    GetOptions(@options) or exit 1;
    for (map /(\w+)/, @options) {
      eval "\$o=\$opt_$_";
      $o =~ s/$q/$q\\$q$q/g;
      print "opt_$_=$q$o$q"
    }' -- "$@"
) || exit
eval "$parsed_ops"
# and then use $opt_foo, $opt_bar...

Voyez perldoc Getopt::Longce qu'il peut faire et comment il diffère des autres analyseurs d'options.

Chaque discussion sur ce sujet met en évidence la possibilité d'écrire le code d'analyse manuellement - alors seulement vous pouvez être sûr de la fonctionnalité et de la portabilité. Je vous conseille de ne pas écrire de code que vous pouvez avoir généré et recréé par des générateurs de code open source faciles à utiliser. Utilisez Argbash , qui a été conçu pour fournir la réponse définitive à votre problème. Il s'agit d'un générateur de code bien documenté disponible sous forme d' application en ligne de commande , en ligne ou sous forme d' image Docker .

Je déconseille les bibliothèques bash, certaines d'entre elles utilisent getopt(ce qui rend tout à fait impossible à transporter) et il est difficile de regrouper un gigantesque blob shell illisible avec votre script.

Vous pouvez utiliser getoptsur des systèmes qui le prennent en charge et utiliser une solution de repli pour les systèmes qui ne le font pas.

Par exemple, pure-getoptest implémenté dans Bash pur pour être un remplacement direct de GNU getopt.