Vérifier le nombre d'arguments passés à un script de Bash.

Question

Je voudrais que mon script Bash imprime un message d'erreur si le nombre d'arguments requis n'est pas atteint.

J'ai essayé le code suivant :

#!/bin/bash
echo Script name: $0
echo $# arguments 
if [$# -ne 1]; 
    then echo "illegal number of parameters"
fi

Pour une raison inconnue, j'ai obtenu l'erreur suivante :

test: line 4: [2: command not found

Qu'est-ce que je fais de mal ?

Answer 1

Comme toute autre commande simple, [ ... ] o test requiert des espaces entre ses arguments.

if [ "$#" -ne 1 ]; then
    echo "Illegal number of parameters"
fi

Ou

if test "$#" -ne 1; then
    echo "Illegal number of parameters"
fi

Suggestions

Lorsque vous êtes dans Bash, préférez utiliser [[ ]] à la place, puisqu'il n'effectue pas le découpage des mots et l'expansion des noms de chemin pour ses variables, la citation peut ne pas être nécessaire, sauf si elle fait partie d'une expression.

[[ $# -ne 1 ]]

Il dispose également d'autres fonctionnalités telles que le regroupement de conditions non citées, le filtrage de motifs (filtrage de motifs étendu avec extglob ) et la correspondance regex.

L'exemple suivant vérifie si les arguments sont valides. Il autorise un seul ou deux arguments.

[[ ($# -eq 1 || ($# -eq 2 && $2 == <glob pattern>)) && $1 =~ <regex pattern> ]]

Pour les expressions arithmétiques pures, l'utilisation de (( )) pour certains peuvent encore être meilleures, mais elles sont toujours possibles en [[ ]] avec ses opérateurs arithmétiques comme -eq , -ne , -lt , -le , -gt o -ge en plaçant l'expression comme un seul argument de type chaîne :

A=1
[[ 'A + 1' -eq 2 ]] && echo true  ## Prints true.

Cela devrait être utile si vous avez besoin de le combiner avec d'autres fonctionnalités de l'outil de gestion de l'information. [[ ]] également.

Notez que [[ ]] y (( )) sont des mots-clés qui ont le même niveau d'analyse syntaxique que if , case , while y for .

Aussi comme Dave suggéré, les messages d'erreur sont mieux envoyés à stderr afin qu'ils ne soient pas inclus lorsque stdout est redirigé :

echo "Illegal number of parameters" >&2

Sortie du script

Il est également logique de faire en sorte que le script sorte lorsque des paramètres invalides lui sont passés. Cela a déjà été suggéré dans le commentaires por ekangas mais quelqu'un a édité cette réponse pour l'avoir avec -1 comme valeur retournée, alors autant le faire correctement.

-1 bien qu'acceptée par Bash comme un argument pour exit n'est pas explicitement documenté et ne doit pas être utilisé comme une suggestion commune. 64 est également la valeur la plus formelle puisqu'elle est définie dans le document sysexits.h con #define EX_USAGE 64 /* command line usage error */ . La plupart des outils comme ls retourner également 2 sur des arguments non valables. J'avais aussi l'habitude de renvoyer 2 dans mes scripts mais dernièrement je ne m'en souciais plus vraiment et j'ai simplement utilisé 1 dans toutes les erreurs. Mais plaçons 2 ici puisque c'est le plus courant et qu'il n'est probablement pas spécifique au système d'exploitation.

if [[ $# -ne 1 ]]; then
    echo "Illegal number of parameters" >&2
    exit 2
fi

Références

• Expressions conditionnelles de Bash
• Constructions conditionnelles
• Correspondance de motifs
• Séparation des mots
• Expansion de nom de fichier (prev. Expansion de nom de chemin)
• Commandes simples

Answer 2

Ce serait une bonne idée d'utiliser expressions arithmétiques si vous avez affaire à des chiffres.

if (( $# != 1 )); then
    >&2 echo "Illegal number of parameters"
fi

>&2 est utilisé pour écrire le message d'erreur sur stderr.

Answer 3

Sur [] : !=, =, == ... sont chaîne de caractères opérateurs de comparaison et -eq, -gt ... sont des arithmétique binaires.

Je l'utiliserais :

if [ "$#" != "1" ]; then

Ou :

if [ $# -eq 1 ]; then

Answer 4

Si vous n'êtes intéressé que par le fait d'abandonner si un argument particulier est manquant, Substitution de paramètres est génial :

#!/bin/bash
# usage-message.sh

: ${1?"Usage: $0 ARGUMENT"}
#  Script exits here if command-line parameter absent,
#+ with following error message.
#    usage-message.sh: 1: Usage: usage-message.sh ARGUMENT

Answer 5

Un simple "one liner" qui fonctionne peut être fait en utilisant :

[ "$#" -ne 1 ] && ( usage && exit 1 ) || main

Cela se décompose comme suit :

1. tester la variable bash pour la taille des paramètres $# pas égal à 1 (notre nombre de sous-commandes)
2. si c'est vrai, appelez la fonction usage() et sortez avec le statut 1.
3. sinon, appelez la fonction main()

Des choses à noter :

• usage() peut être simple echo "$0 : params".
• main peut être un long script.