Сообщить об ошибке.

Приемы сочетания необязательных и позиционных параметров в командной строке

В этом разделе на примере разобраны приемы сочетания необязательных и позиционных параметров в командной строке для скрипта, при использовании модуля argparse в Python.

Будем разбираться, как можно комбинировать необязательные и позиционные параметры в командной строке для кода программы в файле prog.py:

# prog.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbose", action="store_true",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbose:
    print(f"the square of {args.square} equals {answer}")
else:
    print(answer)

Запустим скрипт prog.py в командной строке следующим образом.

$ python3 prog.py
usage: prog.py [-h] [-v] square
prog.py: error: the following arguments are required: square
$ python3 prog.py 4
16
$ python3 prog.py 4 --verbose
the square of 4 equals 16
$ python3 prog.py --verbose 4
the square of 4 equals 16
  • При первом запуске скрипт ругается... т.к. обязательный/позиционный параметр square не указан.
  • Возьмите на заметку, что порядок необязательных и позиционных параметров в командной строке не имеет значения.

Дадим возможность программе выводить несколько вариантов детализации расчета квадрата числа и что бы фактически можно было этим пользоваться:

# prog.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print(f"the square of {args.square} equals {answer}")
elif args.verbosity == 1:
    print(f"{args.square}^2 == {answer}")
else:
    print(answer)

Теперь смотрим вывод работы скрипта:

$ python3 prog.py 4
16
$ python3 prog.py 4 -v
usage: prog.py [-h] [-v VERBOSITY] square
prog.py: error: argument -v/--verbosity: expected one argument
$ python3 prog.py 4 -v 1
4^2 == 16
$ python3 prog.py 4 -v 2
the square of 4 equals 16
$ python3 prog.py 4 -v 3
16

Все работает хорошо за исключением последнего варианта -v 3, который выводит то же самое что и первый запуск. Исправим это, ограничив значения, которые может принимать параметр --verbosity. Для этого введем в метод parser.add_argument() ключевой аргумент choices. 

# prog.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print(f"the square of {args.square} equals {answer}")
elif args.verbosity == 1:
    print(f"{args.square}^2 == {answer}")
else:
    print(answer)

Вывод программы:

$ python3 prog.py 4 -v 3
usage: prog.py [-h] [-v {0,1,2}] square
prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
$ python3 prog.py 4 -h
usage: prog.py [-h] [-v {0,1,2}] square

positional arguments:
  square                display a square of a given number

optional arguments:
  -h, --help            show this help message and exit
  -v {0,1,2}, --verbosity {0,1,2}
                        increase output verbosity

Обратите внимание, что изменение также отражается как в сообщении об ошибке, так и в строке справки.

Теперь давайте попробуем использовать другой подход к указанию нескольких вариантов детализации, он довольно распространен на практике. Этот подход также соответствует тому, как исполняемый файл CPython обрабатывает свои собственные аргументы, например -O и -OO (проверьте вывод python --help).

Для этого немного поменяем код. Введем еще одно действие, action="count", для подсчета количества вхождений определенных необязательных аргументов:

# prog.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display the square of a given number")
parser.add_argument("-v", "--verbosity", action="count",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print(f"the square of {args.square} equals {answer}")
elif args.verbosity == 1:
    print(f"{args.square}^2 == {answer}")
else:
    print(answer)

Результат тестирования.

$ python3 prog.py 4
16
$ python3 prog.py 4 -v
4^2 == 16
$ python3 prog.py 4 -vv
the square of 4 equals 16
$ python3 prog.py 4 --verbosity --verbosity
the square of 4 equals 16
$ python3 prog.py 4 -v 1
usage: prog.py [-h] [-v] square
prog.py: error: unrecognized arguments: 1
$ python3 prog.py 4 -h
usage: prog.py [-h] [-v] square

positional arguments:
  square           display a square of a given number

optional arguments:
  -h, --help       show this help message and exit
  -v, --verbosity  increase output verbosity
$ python3 prog.py 4 -vvv
16

Разберем, что происходит:

  • Теперь скорее это флаг (похожий на action='store_true') в первой версии скрипта.
  • Флаг ведет себя аналогично действию store_true.
  • Видно демонстрацию того, что дает действие count.
  • Если не указать флаг -v, то флаг принимает значение None.
  • Как и следовало ожидать, указав длинную форму флага, получается тот же результат.
  • К сожалению, справка не очень информативна о новой способности, которую приобрел скрипт. Это можно исправить, улучшив документацию для скрипта (например, с помощью ключевого аргумента справки).
  • Последний вывод некорректен, т.к. третий вариант детализации не предусмотрен программой.

Исправим это:

# prog.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action="count",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2

# bugfix: replace == with >=
if args.verbosity >= 2:
    print(f"the square of {args.square} equals {answer}")
elif args.verbosity >= 1:
    print(f"{args.square}^2 == {answer}")
else:
    print(answer)

Вывод:

$ python3 prog.py 4 -vvv
the square of 4 equals 16
$ python3 prog.py 4 -vvvv
the square of 4 equals 16
$ python3 prog.py 4
Traceback (most recent call last):
  File "prog.py", line 11, in <module>
    if args.verbosity >= 2:
TypeError: '>=' not supported between instances of 'NoneType' and 'int'

Разбор тестирования программы:

  • Вывод первого запуска прошел успешно, и исправлена ​​предыдущая ошибка. То есть необходимо, чтобы любое количество необязательного параметра -v равнялось 2 и вывод был максимально детализированным.
  • Вывод третьего запуска показал ошибку.

Исправляем эту ошибку. Для этого введем в метод parser.add_argument() еще один ключевой аргумент default. Установим его равным 0, чтобы можно было сравнивать с другими значениями int. Помните, если необязательный аргумент не указан, то он по умолчанию получает значение None, по этому его нельзя сравнить с целым числом int (отсюда и исключение TypeError).

# prog.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action="count", default=0,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity >= 2:
    print(f"the square of {args.square} equals {answer}")
elif args.verbosity >= 1:
    print(f"{args.square}^2 == {answer}")
else:
    print(answer)

Вывод:

$ python3 prog.py 4
16

Расширим программу, тем самым дадим возможность возводить указанное в командной строке число в любую степень. Для этого введем еще один необязательный параметр -e и --exp - экспонента. Еще добавим описание программы, что бы знать, чем она занимается. Описание программы можно добавить как аргумент description класса argparse.ArgumentParser().

# prog.py
import argparse
parser = argparse.ArgumentParser(description="calculate X to the power of Y")
parser.add_argument("base", type=int, help="the base")
parser.add_argument("-e", "--exp", type=int, default=2, help="the exponent")
parser.add_argument("-v", "--verbosity", action="count", default=0)
args = parser.parse_args()
answer = args.base**args.exp
if args.verbosity >= 2:
    if args.exp == 2:
        print(f"the square of {args.exp} equals {answer}")
    else:
        print(f"{args.base} to the power {args.exp} equals {answer}")
elif args.verbosity >= 1:
    print(f"{args.base}^{args.exp} == {answer}")
else:
    print(answer)

Проверяем работу скрипта prog.py:

$ python3 prog.py -h
usage: prog.py [-h] [-e EXP] [-v] base

calculate X to the power of Y

positional arguments:
  base               the base

optional arguments:
  -h, --help         show this help message and exit
  -e EXP, --exp EXP  the exponent
  -v, --verbosity
$ python3 prog.py
usage: prog.py [-h] [-e EXP] [-v] base
prog.py: error: the following arguments are required: base
$ python3 prog.py 4
16
$ python3 prog.py 4 -e3
64
$ python3 prog.py 4 --exp=3
64
$ python3 prog.py 4 --exp=3 -v
4^3 == 64
$ python3 prog.py 4 -v
4^2 == 16
$ python3 prog.py 4 -vv
the square of 2 equals 16
$ python3 prog.py 4 --exp=3 -vv
4 to the power 3 equals 64

С теми приемами работы, которые показаны в этом разделе уже можно сделать очень многое и это только начало. Модуль argparse на самом деле очень мощный.