Правила создания CLI - PlatonB/high-perf-bio GitHub Wiki

Порядок добавления аргументов CLI.

I.

  1. обязательные
  2. необязательные

II.

  1. позволяющие задать пути к папкам и имя базы
  2. относящиеся к исходным файлам
  3. относящиеся к базе данных
  4. относящиеся к конечным файлам
  5. все остальные

Расположение аргументов функции add_argument.

Общий принцип: сначала должны быть те, которые "ближе к пользователю", потом - которые "ближе к программе", и в конце - справка.

Место Аргумент Толкование
1 -a краткая форма аргумента
2 --argument полная форма аргумента
3 required True - аргумент обязательный
4 metavar тип данных, присваиваемый значению обязательного аргумента, или (в квадратных скобках) значение по умолчанию необязательного аргумента
5 choices допустимые значения при указании аргумента
6 default значение при неуказании аргумента
7 dest имя переменной для значения
8 type тип данных значения
9 help справка по аргументу и его возможным значениям