Argparse Python: Аргументы командной строки для новичков

Основы работы с аргументами командной строки в Python

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

Преимущества использования аргументов командной строки

Использование аргументов командной строки в Python предоставляет разработчикам множество преимуществ:

Повышение гибкости программы за счет возможности изменения поведения без модификации исходного кода
Возможность управления поведением программы без изменения кода
Удобство автоматизации задач и написания CLI-инструментов
Легкая интеграция скриптов в пайплайны и CI/CD процессы
Упрощение тестирования программы с различными параметрами

Примеры программ с аргументами командной строки

Множество популярных инструментов активно используют аргументы командной строки:

Инсталляторы пакетов (pip, apt, yarn)
Инструменты работы с файлами (tar, zip, rsync)
Системы сборки (make, cmake, gradle)
Инструменты разработки (git, docker, kubectl)
Собственные скрипты для автоматизации рабочих процессов

Импорт и настройка модуля argparse

Модуль argparse встроен в стандартную библиотеку Python начиная с версии 2.7 и 3.2. Для его использования не требуется дополнительная установка пакетов.

import argparse

Создание базового парсера

Для начала работы с аргументами необходимо создать экземпляр класса ArgumentParser:

parser = argparse.ArgumentParser(description="Описание программы")

Первый пример использования argparse

Рассмотрим простой скрипт, который принимает имя пользователя и выводит персональное приветствие:

import argparse

parser = argparse.ArgumentParser(description="Простая программа приветствия")
parser.add_argument("name", help="Имя пользователя")
args = parser.parse_args()

print(f"Привет, {args.name}!")

Запуск скрипта осуществляется следующим образом:

python script.py Иван

Результат выполнения:

Привет, Иван!

Типы аргументов в argparse

Обязательные аргументы

Обязательные аргументы представляют собой параметры, без которых программа не может быть запущена. Они определяются без префиксов и должны быть переданы пользователем в обязательном порядке.

parser.add_argument("filename", help="Имя файла для обработки")
parser.add_argument("output_dir", help="Директория для сохранения результатов")

Необязательные аргументы

Необязательные аргументы обычно начинаются с одного дефиса (-) для короткой формы или двойного дефиса (--) для длинной формы. Они предоставляют дополнительную функциональность программы.

parser.add_argument("-v", "--verbose", help="Вывести подробную информацию", action="store_true")
parser.add_argument("-o", "--output", help="Файл для сохранения результатов")

Работа с типами данных аргументов

По умолчанию все аргументы обрабатываются как строки. Для указания другого типа данных используется параметр type:

parser.add_argument("number", type=int, help="Введите целое число")
parser.add_argument("price", type=float, help="Цена товара")
parser.add_argument("enabled", type=bool, help="Включить функцию")

При передаче неправильного типа данных argparse автоматически выдаст информативную ошибку.

Пример скрипта для математических операций

import argparse

parser = argparse.ArgumentParser(description="Скрипт сложения двух чисел")
parser.add_argument("a", type=int, help="Первое число")
parser.add_argument("b", type=int, help="Второе число")
parser.add_argument("-o", "--operation", choices=["add", "subtract", "multiply"], 
                    default="add", help="Тип операции")

args = parser.parse_args()

if args.operation == "add":
    result = args.a + args.b
elif args.operation == "subtract":
    result = args.a - args.b
elif args.operation == "multiply":
    result = args.a * args.b

print(f"Результат: {result}")

Запуск скрипта:

python math_script.py 5 10 --operation multiply

Результат:

Результат: 50

Флаги и специальные действия

Булевые флаги

Для создания простых флагов включения/выключения используется параметр action="store_true":

parser.add_argument("-v", "--verbose", action="store_true", 
                    help="Включить подробный режим")
parser.add_argument("-q", "--quiet", action="store_true", 
                    help="Тихий режим работы")

Счетчики

Для подсчета количества указаний флага используется action="count":

parser.add_argument("-v", "--verbose", action="count", default=0,
                    help="Уровень детализации вывода")

При запуске с -vvv значение будет равно 3.

Обработка множественных значений

Параметр nargs позволяет принимать несколько значений одним аргументом:

parser.add_argument("numbers", nargs="+", type=int, 
                    help="Числа для суммирования")
parser.add_argument("--files", nargs="*", 
                    help="Список файлов для обработки")

Варианты значений nargs:

"+" - одно или более значений
"*" - ноль или более значений
"?" - ноль или одно значение
число - точное количество значений

Пример обработки списка чисел

import argparse

parser = argparse.ArgumentParser(description="Калькулятор суммы")
parser.add_argument("numbers", nargs="+", type=int, 
                    help="Числа для суммирования")
parser.add_argument("-a", "--average", action="store_true", 
                    help="Вычислить среднее значение")

args = parser.parse_args()

total = sum(args.numbers)
print(f"Сумма: {total}")

if args.average:
    average = total / len(args.numbers)
    print(f"Среднее: {average:.2f}")

Значения по умолчанию

Параметр default позволяет установить значение по умолчанию для аргумента:

parser.add_argument("-c", "--count", type=int, default=1, 
                    help="Количество повторений")
parser.add_argument("--format", default="json", 
                    choices=["json", "xml", "csv"], 
                    help="Формат вывода данных")

Автоматическая справка

При запуске скрипта с параметром -h или --help автоматически отображается справочная информация:

python script.py --help

Результат:

usage: script.py [-h] name

Простая программа приветствия

positional arguments:
  name        Имя пользователя

optional arguments:
  -h, --help  show this help message and exit

Настройка справки

Можно настроить различные аспекты справочной информации:

parser = argparse.ArgumentParser(
    description="Подробное описание программы",
    epilog="Дополнительная информация внизу справки",
    formatter_class=argparse.RawDescriptionHelpFormatter
)

Создание подкоманд

Модуль argparse поддерживает создание сложных CLI-инструментов с подкомандами, подобно git или docker:

import argparse

parser = argparse.ArgumentParser(description="Файловый менеджер")
subparsers = parser.add_subparsers(dest="command", help="Доступные команды")

# Команда копирования
copy_parser = subparsers.add_parser("copy", help="Копирование файлов")
copy_parser.add_argument("source", help="Исходный файл")
copy_parser.add_argument("destination", help="Файл назначения")

# Команда удаления
delete_parser = subparsers.add_parser("delete", help="Удаление файлов")
delete_parser.add_argument("files", nargs="+", help="Файлы для удаления")

args = parser.parse_args()

if args.command == "copy":
    print(f"Копирование {args.source} в {args.destination}")
elif args.command == "delete":
    print(f"Удаление файлов: {', '.join(args.files)}")

Пример запуска:

python file_manager.py copy source.txt destination.txt

Валидация аргументов

Использование choices

Параметр choices ограничивает возможные значения аргумента:

parser.add_argument("--level", choices=["debug", "info", "warning", "error"],
                    default="info", help="Уровень логирования")

Пользовательская валидация

Для сложной валидации можно использовать пользовательские функции:

def validate_positive_int(value):
    ivalue = int(value)
    if ivalue <= 0:
        raise argparse.ArgumentTypeError(f"{value} не является положительным числом")
    return ivalue

parser.add_argument("--timeout", type=validate_positive_int, 
                    help="Время ожидания в секундах")

Группировка аргументов

Для лучшей организации справки можно группировать аргументы:

parser = argparse.ArgumentParser(description="Обработка изображений")

input_group = parser.add_argument_group("Входные параметры")
input_group.add_argument("input_file", help="Входной файл")
input_group.add_argument("--format", help="Формат входного файла")

output_group = parser.add_argument_group("Выходные параметры")
output_group.add_argument("--output", help="Выходной файл")
output_group.add_argument("--quality", type=int, help="Качество сжатия")

Альтернативы argparse

Модуль sys.argv

Для простейшей работы с аргументами можно использовать sys.argv:

import sys

if len(sys.argv) < 2:
    print("Использование: python script.py <имя>")
    sys.exit(1)

name = sys.argv[1]
print(f"Привет, {name}!")

Библиотека click

Click представляет собой мощную стороннюю библиотеку для создания CLI-приложений:

import click

@click.command()
@click.argument('name')
@click.option('--count', default=1, help='Количество приветствий')
def hello(name, count):
    for _ in range(count):
        click.echo(f'Привет, {name}!')

if __name__ == '__main__':
    hello()

Библиотека typer

Typer - современная библиотека, основанная на type hints:

import typer

def main(name: str, count: int = 1):
    for _ in range(count):
        typer.echo(f"Привет, {name}!")

if __name__ == "__main__":
    typer.run(main)

Часто задаваемые вопросы

Как обрабатывать ситуацию, когда аргументы не передаются?

Проверьте правильность синтаксиса запуска скрипта и корректность обработки аргументов в коде. Используйте отладочную печать для проверки значений:

args = parser.parse_args()
print(f"Полученные аргументы: {vars(args)}")

Как обрабатывать ввод некорректных данных?

Используйте параметр type и обрабатывайте исключения через try-except:

try:
    args = parser.parse_args()
except SystemExit:
    print("Ошибка в аргументах командной строки")

Можно ли использовать argparse с Jupyter Notebook?

Это технически возможно, но не рекомендуется. В Jupyter Notebook лучше передавать параметры через переменные или использовать специальные magic-команды.

Как создать обязательный флаг?

Используйте параметр required=True:

parser.add_argument("--config", required=True, 
                    help="Путь к конфигурационному файлу")

Как получить все аргументы в виде словаря?

Используйте функцию vars():

args = parser.parse_args()
args_dict = vars(args)
print(args_dict)

Заключение

Модуль argparse предоставляет мощный и гибкий инструментарий для работы с аргументами командной строки в Python. Освоение этого модуля позволяет создавать профессиональные CLI-приложения, которые легко интегрируются в различные рабочие процессы и системы автоматизации.

Изучение базовых и продвинутых возможностей argparse значительно повышает качество и удобство использования ваших скриптов, делая их более универсальными и пригодными для различных сценариев применения.