Как получить аргументы с флагами в Bash


284

Я знаю, что я могу легко получить позиционированные параметры, как это в Bash:

$0 или $1

Я хочу иметь возможность использовать такие параметры флага, чтобы указать, для чего используется каждый параметр:

mysql -u user -h host

Каков наилучший способ получить -u paramзначение и -h paramзначение по флагу, а не по позиции?


2
Это может быть хорошей идеей , чтобы спросить / проверить более в unix.stackexchange.com а
MRR0GERS

8
Google для "Bash Getopts" - много учебников.
Гленн Джекман

89
@ glenn-jackman: я определенно буду гуглить, теперь, когда знаю имя. Суть вопроса в Google - задать вопрос - вы уже должны знать 50% ответа.
Стэнн

Ответы:


292

Это идиома, которую я обычно использую:

while test $# -gt 0; do
  case "$1" in
    -h|--help)
      echo "$package - attempt to capture frames"
      echo " "
      echo "$package [options] application [arguments]"
      echo " "
      echo "options:"
      echo "-h, --help                show brief help"
      echo "-a, --action=ACTION       specify an action to use"
      echo "-o, --output-dir=DIR      specify a directory to store output in"
      exit 0
      ;;
    -a)
      shift
      if test $# -gt 0; then
        export PROCESS=$1
      else
        echo "no process specified"
        exit 1
      fi
      shift
      ;;
    --action*)
      export PROCESS=`echo $1 | sed -e 's/^[^=]*=//g'`
      shift
      ;;
    -o)
      shift
      if test $# -gt 0; then
        export OUTPUT=$1
      else
        echo "no output dir specified"
        exit 1
      fi
      shift
      ;;
    --output-dir*)
      export OUTPUT=`echo $1 | sed -e 's/^[^=]*=//g'`
      shift
      ;;
    *)
      break
      ;;
  esac
done

Ключевые моменты:

  • $# количество аргументов
  • Цикл while просматривает все предоставленные аргументы, сопоставляя их значения внутри оператора case
  • Сдвиг убирает первого. Вы можете смещаться несколько раз внутри оператора case, чтобы принимать несколько значений.

3
Что делает --action*и --output-dir*дела?
Лусио

1
Они просто сохраняют ценности, которые попадают в окружающую среду.
Флексо

22
@Lucio Очень старый комментарий, но добавляем его на тот случай, если кто-нибудь еще посетит эту страницу. Знак * (подстановочный знак) предназначен для случая, когда кто-то печатает, --action=[ACTION]а также для случая, когда кто-то печатает--action [ACTION]
бондарь

2
Зачем *)ты ломаешься там, не должен ли ты выйти или проигнорировать плохой вариант? Другими словами часть никогда не обрабатывается. -bad -o dir-o dir
Newguy

@newguy хороший вопрос. Я думаю, что пытался позволить им провалиться во что-то еще
Флекс

428

Этот пример использует встроенную getoptsкоманду Bash и взят из Руководства по стилю Google Shell :

a_flag=''
b_flag=''
files=''
verbose='false'

print_usage() {
  printf "Usage: ..."
}

while getopts 'abf:v' flag; do
  case "${flag}" in
    a) a_flag='true' ;;
    b) b_flag='true' ;;
    f) files="${OPTARG}" ;;
    v) verbose='true' ;;
    *) print_usage
       exit 1 ;;
  esac
done

Примечание. Если за символом следует двоеточие (например f:), ожидается, что этот параметр будет иметь аргумент.

Пример использования: ./script -v -a -b -f filename

Использование getopts имеет несколько преимуществ перед принятым ответом:

  • условие while намного более читаемо и показывает, какие параметры доступны
  • более чистый код; нет подсчета количества параметров и сдвига
  • Вы можете присоединиться к опциям (например, -a -b -c-abc)

Однако большим недостатком является то, что он не поддерживает длинные опции, а только односимвольные.


48
Интересно, почему этот ответ, использующий встроенный bash, не самый лучший
Уилл Барнвелл,

13
Для потомков: двоеточие после в 'abf: v' означает, что -f принимает дополнительный аргумент (имя файла в этом случае).
Захбаз

1
Я должен был изменить строку ошибки на это:?) printf '\nUsage: %s: [-a] aflag [-b] bflag\n' $0; exit 2 ;;
Энди

7
Не могли бы вы добавить заметку о колонах? В том, что после каждой буквы ни двоеточие не означает арг, одно двоеточие означает арг, а два двоеточия означают необязательный аргумент?
limasxgoesto0

3
@WillBarnwell следует отметить, что он был добавлен через 3 года после того, как был задан вопрос, тогда как главный ответ был добавлен в тот же день.
rbennell

47

getopt твой друг .. простой пример:

function f () {
TEMP=`getopt --long -o "u:h:" "$@"`
eval set -- "$TEMP"
while true ; do
    case "$1" in
        -u )
            user=$2
            shift 2
        ;;
        -h )
            host=$2
            shift 2
        ;;
        *)
            break
        ;;
    esac 
done;

echo "user = $user, host = $host"
}

f -u myself -h some_host

В вашем каталоге / usr / bin должно быть несколько примеров.


3
Более подробный пример можно найти в каталоге /usr/share/doc/util-linux/examples, по крайней мере, на машинах с Ubuntu.
Серж Строобандт

10

Я думаю, что это послужило бы более простым примером того, чего вы хотите достичь. Нет необходимости использовать внешние инструменты. Встроенные инструменты Bash могут сделать эту работу за вас.

function DOSOMETHING {

   while test $# -gt 0; do
           case "$1" in
                -first)
                    shift
                    first_argument=$1
                    shift
                    ;;
                -last)
                    shift
                    last_argument=$1
                    shift
                    ;;
                *)
                   echo "$1 is not a recognized flag!"
                   return 1;
                   ;;
          esac
  done  

  echo "First argument : $first_argument";
  echo "Last argument : $last_argument";
 }

Это позволит вам использовать флаги, поэтому независимо от того, в каком порядке вы передаете параметры, вы получите правильное поведение.

Пример :

 DOSOMETHING -last "Adios" -first "Hola"

Вывод :

 First argument : Hola
 Last argument : Adios

Вы можете добавить эту функцию в свой профиль или поместить ее в скрипт.

Спасибо!

Изменить: сохранить это как файл, а затем выполнить его как yourfile.sh -last "Adios" -first "Hola"

#!/bin/bash
while test $# -gt 0; do
           case "$1" in
                -first)
                    shift
                    first_argument=$1
                    shift
                    ;;
                -last)
                    shift
                    last_argument=$1
                    shift
                    ;;
                *)
                   echo "$1 is not a recognized flag!"
                   return 1;
                   ;;
          esac
  done  

  echo "First argument : $first_argument";
  echo "Last argument : $last_argument";

Я использую приведенный выше код, и при запуске он ничего не печатает. ./hello.sh DOSOMETHING -last "Adios" -first "Hola"
dinu0101

@ dinu0101 Это функция. Не сценарий. Вы должны использовать его как ДОСОМЕТИ - последний "Адиос" - первый "Хола"
Матиас Барриос

Спасибо @Matias. Понял. как запустить внутри скрипта.
dinu0101

1
Большое спасибо @Matias
dinu0101

2
Использование return 1;с последним примером выводит can only 'return' from a function or sourced scriptна macOS. Переключение на exit 1;работу, как ожидалось, хотя.
Маттиас

5

Другой альтернативой может быть использование чего-то вроде приведенного ниже примера, который позволит вам использовать длинные теги --image или short -i, а также разрешить скомпилированные -i = "example.jpg" или отдельные методы -i example.jpg для передачи аргументов ,

# declaring a couple of associative arrays
declare -A arguments=();  
declare -A variables=();

# declaring an index integer
declare -i index=1;

# any variables you want to use here
# on the left left side is argument label or key (entered at the command line along with it's value) 
# on the right side is the variable name the value of these arguments should be mapped to.
# (the examples above show how these are being passed into this script)
variables["-gu"]="git_user";  
variables["--git-user"]="git_user";  
variables["-gb"]="git_branch";  
variables["--git-branch"]="git_branch";  
variables["-dbr"]="db_fqdn";  
variables["--db-redirect"]="db_fqdn";  
variables["-e"]="environment";  
variables["--environment"]="environment";

# $@ here represents all arguments passed in
for i in "$@"  
do  
  arguments[$index]=$i;
  prev_index="$(expr $index - 1)";

  # this if block does something akin to "where $i contains ="
  # "%=*" here strips out everything from the = to the end of the argument leaving only the label
  if [[ $i == *"="* ]]
    then argument_label=${i%=*} 
    else argument_label=${arguments[$prev_index]}
  fi

  # this if block only evaluates to true if the argument label exists in the variables array
  if [[ -n ${variables[$argument_label]} ]]
    then
        # dynamically creating variables names using declare
        # "#$argument_label=" here strips out the label leaving only the value
        if [[ $i == *"="* ]]
            then declare ${variables[$argument_label]}=${i#$argument_label=} 
            else declare ${variables[$argument_label]}=${arguments[$index]}
        fi
  fi

  index=index+1;
done;

# then you could simply use the variables like so:
echo "$git_user";

3

Мне больше нравится ответ Роберта МакМахана, поскольку его легче всего превратить в файлы общего доступа для любых ваших сценариев. Но, похоже, есть ошибка с строкой, которая if [[ -n ${variables[$argument_label]} ]]выдает сообщение «переменные: неверный индекс массива». У меня нет респ комментировать, и я сомневаюсь , что это правильная «исправить» , но упаковка , что ifв if [[ -n $argument_label ]] ; thenочищает его.

Вот код, который я закончил, если вы знаете лучший способ, пожалуйста, добавьте комментарий к ответу Роберта.

Включить файл "flags-declares.sh"

# declaring a couple of associative arrays
declare -A arguments=();
declare -A variables=();

# declaring an index integer
declare -i index=1;

Включить файл "flags-arguments.sh"

# $@ here represents all arguments passed in
for i in "$@"
do
  arguments[$index]=$i;
  prev_index="$(expr $index - 1)";

  # this if block does something akin to "where $i contains ="
  # "%=*" here strips out everything from the = to the end of the argument leaving only the label
  if [[ $i == *"="* ]]
    then argument_label=${i%=*}
    else argument_label=${arguments[$prev_index]}
  fi

  if [[ -n $argument_label ]] ; then
    # this if block only evaluates to true if the argument label exists in the variables array
    if [[ -n ${variables[$argument_label]} ]] ; then
      # dynamically creating variables names using declare
      # "#$argument_label=" here strips out the label leaving only the value
      if [[ $i == *"="* ]]
        then declare ${variables[$argument_label]}=${i#$argument_label=} 
        else declare ${variables[$argument_label]}=${arguments[$index]}
      fi
    fi
  fi

  index=index+1;
done;

Ваш "script.sh"

. bin/includes/flags-declares.sh

# any variables you want to use here
# on the left left side is argument label or key (entered at the command line along with it's value) 
# on the right side is the variable name the value of these arguments should be mapped to.
# (the examples above show how these are being passed into this script)
variables["-gu"]="git_user";
variables["--git-user"]="git_user";
variables["-gb"]="git_branch";
variables["--git-branch"]="git_branch";
variables["-dbr"]="db_fqdn";
variables["--db-redirect"]="db_fqdn";
variables["-e"]="environment";
variables["--environment"]="environment";

. bin/includes/flags-arguments.sh

# then you could simply use the variables like so:
echo "$git_user";
echo "$git_branch";
echo "$db_fqdn";
echo "$environment";

3

Если вы знакомы с Python argparse и не против вызвать python для разбора аргументов bash, есть фрагмент кода, который я считаю действительно полезным и очень простым в использовании, называемый argparse-bash https://github.com/nhoffman/ argparse-баш

Пример берут из их скрипта example.sh:

#!/bin/bash

source $(dirname $0)/argparse.bash || exit 1
argparse "$@" <<EOF || exit 1
parser.add_argument('infile')
parser.add_argument('outfile')
parser.add_argument('-a', '--the-answer', default=42, type=int,
                    help='Pick a number [default %(default)s]')
parser.add_argument('-d', '--do-the-thing', action='store_true',
                    default=False, help='store a boolean [default %(default)s]')
parser.add_argument('-m', '--multiple', nargs='+',
                    help='multiple values allowed')
EOF

echo required infile: "$INFILE"
echo required outfile: "$OUTFILE"
echo the answer: "$THE_ANSWER"
echo -n do the thing?
if [[ $DO_THE_THING ]]; then
    echo " yes, do it"
else
    echo " no, do not do it"
fi
echo -n "arg with multiple values: "
for a in "${MULTIPLE[@]}"; do
    echo -n "[$a] "
done
echo

2

Я предлагаю простой TLDR :; пример для непосвященных.

Создайте bash-скрипт с именем helloworld.sh

#!/bin/bash

while getopts "n:" arg; do
  case $arg in
    n) Name=$OPTARG;;
  esac
done

echo "Hello $Name!"

Затем вы можете передать необязательный параметр -nпри выполнении скрипта.

Выполните скрипт так:

$ bash helloworld.sh -n 'World'

Вывод

$ Hello World!

Ноты

Если вы хотите использовать несколько параметров:

  1. расширить while getops "n:" arg: doс помощью большего количества параметров, таких как while getops "n:o:p:" arg: do
  2. расширить регистр переключателя дополнительными переменными. Такие как o) Option=$OPTARGиp) Parameter=$OPTARG

1
#!/bin/bash

if getopts "n:" arg; then
  echo "Welcome $OPTARG"
fi

Сохраните его как sample.sh и попробуйте запустить

sh sample.sh -n John

в вашем терминале.


1

У меня были проблемы с использованием getopts с несколькими флагами, поэтому я написал этот код. Он использует модальную переменную для определения флагов и использования этих флагов для назначения аргументов переменным.

Обратите внимание, что если у флага не должно быть аргумента, можно сделать что-то кроме установки CURRENTFLAG.

    for MYFIELD in "$@"; do

        CHECKFIRST=`echo $MYFIELD | cut -c1`

        if [ "$CHECKFIRST" == "-" ]; then
            mode="flag"
        else
            mode="arg"
        fi

        if [ "$mode" == "flag" ]; then
            case $MYFIELD in
                -a)
                    CURRENTFLAG="VARIABLE_A"
                    ;;
                -b)
                    CURRENTFLAG="VARIABLE_B"
                    ;;
                -c)
                    CURRENTFLAG="VARIABLE_C"
                    ;;
            esac
        elif [ "$mode" == "arg" ]; then
            case $CURRENTFLAG in
                VARIABLE_A)
                    VARIABLE_A="$MYFIELD"
                    ;;
                VARIABLE_B)
                    VARIABLE_B="$MYFIELD"
                    ;;
                VARIABLE_C)
                    VARIABLE_C="$MYFIELD"
                    ;;
            esac
        fi
    done

0

Так что вот мое решение. Я хотел иметь возможность обрабатывать логические флаги без дефиса, с одним дефисом и с двумя дефисами, а также с параметром / назначением значения с одним и двумя дефисами.

# Handle multiple types of arguments and prints some variables
#
# Boolean flags
# 1) No hyphen
#    create   Assigns `true` to the variable `CREATE`.
#             Default is `CREATE_DEFAULT`.
#    delete   Assigns true to the variable `DELETE`.
#             Default is `DELETE_DEFAULT`.
# 2) One hyphen
#      a      Assigns `true` to a. Default is `false`.
#      b      Assigns `true` to b. Default is `false`.
# 3) Two hyphens
#    cats     Assigns `true` to `cats`. By default is not set.
#    dogs     Assigns `true` to `cats`. By default is not set.
#
# Parameter - Value
# 1) One hyphen
#      c      Assign any value you want
#      d      Assign any value you want
#
# 2) Two hyphens
#   ... Anything really, whatever two-hyphen argument is given that is not
#       defined as flag, will be defined with the next argument after it.
#
# Example:
# ./parser_example.sh delete -a -c VA_1 --cats --dir /path/to/dir
parser() {
    # Define arguments with one hyphen that are boolean flags
    HYPHEN_FLAGS="a b"
    # Define arguments with two hyphens that are boolean flags
    DHYPHEN_FLAGS="cats dogs"

    # Iterate over all the arguments
    while [ $# -gt 0 ]; do
        # Handle the arguments with no hyphen
        if [[ $1 != "-"* ]]; then
            echo "Argument with no hyphen!"
            echo $1
            # Assign true to argument $1
            declare $1=true
            # Shift arguments by one to the left
            shift
        # Handle the arguments with one hyphen
        elif [[ $1 == "-"[A-Za-z0-9]* ]]; then
            # Handle the flags
            if [[ $HYPHEN_FLAGS == *"${1/-/}"* ]]; then
                echo "Argument with one hyphen flag!"
                echo $1
                # Remove the hyphen from $1
                local param="${1/-/}"
                # Assign true to $param
                declare $param=true
                # Shift by one
                shift
            # Handle the parameter-value cases
            else
                echo "Argument with one hyphen value!"
                echo $1 $2
                # Remove the hyphen from $1
                local param="${1/-/}"
                # Assign argument $2 to $param
                declare $param="$2"
                # Shift by two
                shift 2
            fi
        # Handle the arguments with two hyphens
        elif [[ $1 == "--"[A-Za-z0-9]* ]]; then
            # NOTE: For double hyphen I am using `declare -g $param`.
            #   This is the case because I am assuming that's going to be
            #   the final name of the variable
            echo "Argument with two hypens!"
            # Handle the flags
            if [[ $DHYPHEN_FLAGS == *"${1/--/}"* ]]; then
                echo $1 true
                # Remove the hyphens from $1
                local param="${1/--/}"
                # Assign argument $2 to $param
                declare -g $param=true
                # Shift by two
                shift
            # Handle the parameter-value cases
            else
                echo $1 $2
                # Remove the hyphens from $1
                local param="${1/--/}"
                # Assign argument $2 to $param
                declare -g $param="$2"
                # Shift by two
                shift 2
            fi
        fi

    done
    # Default value for arguments with no hypheb
    CREATE=${create:-'CREATE_DEFAULT'}
    DELETE=${delete:-'DELETE_DEFAULT'}
    # Default value for arguments with one hypen flag
    VAR1=${a:-false}
    VAR2=${b:-false}
    # Default value for arguments with value
    # NOTE1: This is just for illustration in one line. We can well create
    #   another function to handle this. Here I am handling the cases where
    #   we have a full named argument and a contraction of it.
    #   For example `--arg1` can be also set with `-c`.
    # NOTE2: What we are doing here is to check if $arg is defined. If not,
    #   check if $c was defined. If not, assign the default value "VD_"
    VAR3=$(if [[ $arg1 ]]; then echo $arg1; else echo ${c:-"VD_1"}; fi)
    VAR4=$(if [[ $arg2 ]]; then echo $arg2; else echo ${d:-"VD_2"}; fi)
}


# Pass all the arguments given to the script to the parser function
parser "$@"


echo $CREATE $DELETE $VAR1 $VAR2 $VAR3 $VAR4 $cats $dir

Некоторые ссылки

  • Основная процедура была найдена здесь .
  • Подробнее о передаче всех аргументов функции здесь .
  • Больше информации о значениях по умолчанию здесь .
  • Больше информации о declareдо $ bash -c "help declare".
  • Больше информации о shiftдо $ bash -c "help shift".
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.