1. Стандартная библиотека `argparse`

Обзор библиотек для создания интерфейсов командной строки (CLI) в Python: возможности и примеры использования

Интерфейсы командной строки (CLI) остаются важным инструментом для разработчиков, DevOps-инженеров и специалистов по автоматизации. Они позволяют быстро взаимодействовать с программами, управлять серверами и создавать скрипты для сложных задач. Python, благодаря своей гибкости и богатой экосистеме, предлагает множество библиотек для создания CLI. В этой статье мы рассмотрим популярные решения, их особенности и примеры применения.

---

1. Стандартная библиотека argparse

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

Основные возможности:

• Поддержка позиционных и опциональных аргументов.
• Автоматическая генерация справки (--help).
• Валидация типов данных.
• Создание вложенных команд (subcommands).

Пример:

import argparse

parser = argparse.ArgumentParser(description="Суммирует числа.")
parser.add_argument("numbers", type=int, nargs="+", help="Список чисел.")
parser.add_argument("--sum", dest="action", action="store_const", const=sum, default=max, 
                    help="Суммировать (по умолчанию ищет максимум).")
args = parser.parse_args()
print(args.action(args.numbers))

Когда использовать:
Для простых задач, где важна минималистичность и отсутствие внешних зависимостей.

---

2. Click: Мощь и элегантность

Описание:
Библиотека Click, разработанная создателями Flask, использует декораторы для создания интуитивных CLI. Она идеальна для сложных приложений с множеством команд и опций.

Особенности:

• Цепочка команд (commands) и подкоманд.
• Подсказки при вводе (prompts).
• Цветной вывод и обработка контекста.
• Интеграция с другими библиотеками (например, Flask).

Пример:

import click

@click.group()
def cli():
    pass

@cli.command()
@click.option("--name", prompt="Ваше имя", help="Имя для приветствия.")
@click.option("--count", default=1, help="Количество повторов.")
def greet(name, count):
    for _ in range(count):
        click.echo(f"Привет, {name}!")

if __name__ == "__main__":
    cli()

Когда использовать:
Для проектов с множеством опций, вложенных команд и необходимостью кастомизации.

---

3. Fire: CLI за минуту

Описание:
Fire от Google автоматически генерирует CLI на основе вашего кода. Достаточно добавить вызов fire.Fire(), чтобы превратить классы или функции в команды.

Преимущества:

• Минимальный boilerplate-код.
• Поддержка классов, функций и словарей.
• Автоматическая документация.

Пример:

import fire

class CLI:
    def add(self, a: int, b: int):
        return a + b

    def greet(self, name: str):
        return f"Hello, {name}!"

if __name__ == "__main__":
    fire.Fire(CLI)

Когда использовать:
Для быстрого прототипирования или превращения существующего кода в CLI без правок.

---

4. Typer: Современный подход с типами

Описание:
Typer построен на базе Click, но использует аннотации типов Python 3.6+. Это делает код чище и удобнее для статического анализа.

Фичи:

• Синтаксис с аннотациями типов.
• Автодополнение в терминале.
• Поддержка асинхронных функций.

Пример:

import typer

app = typer.Typer()

@app.command()
def calculate_sum(numbers: list[int]):
    typer.echo(sum(numbers))

if __name__ == "__main__":
    app()

Когда использовать:
В новых проектах с использованием современных возможностей Python.

---

5. Docopt: CLI через документацию

Описание:
Docopt предлагает уникальный подход: вы пишете документацию в формате usage, а библиотека генерирует парсер аргументов.

Особенности:

• Минимальный код.
• Естественный синтаксис для описания команд.

Пример:

"""Usage:
  cli.py <file> [--verbose] [--output=<path>]
"""

from docopt import docopt

if __name__ == "__main__":
    args = docopt(__doc__)
    print(args)

Когда использовать:
Если вы предпочитаете описывать интерфейс через документацию.

---

6. Plac: Упрощённый argparse

Описание:
Plac упрощает argparse, используя параметры функций для определения аргументов CLI.

Пример:

import plac

@plac.annotations(
    name=plac.Annotation("Имя", "positional", type=str),
    count=plac.Annotation("Количество", "option", int, default=1)
)
def main(name, count):
    for _ in range(count):
        print(f"Привет, {name}!")

if __name__ == "__main__":
    plac.call(main)

Когда использовать:
Для небольших скриптов с минимальной настройкой.

---

Сравнение библиотек

Библиотека	Сложность	Фичи	Зависимости	Версии Python
argparse	Средняя	Базовые	Нет	2.7+, 3.x
Click	Средняя	Расширенные	Click	3.6+
Fire	Низкая	Автогенерация	Нет	2.7+, 3.4+
Typer	Низкая	Аннотации типов, async	Click, Typer	3.6+
Docopt	Низкая	Документация как код	Нет	2.6+, 3.x
Plac	Низкая	Упрощённый argparse	Нет	2.6+, 3.x

---

Как выбрать библиотеку?

• Простота и скорость: Fire или Plac.
• Сложные CLI: Click или Typer.
• Современный код: Typer (с аннотациями типов).
• Минимум зависимостей: argparse или Docopt.
• Гибкость через документацию: Docopt.

---

Заключение
Python предлагает инструменты для любых задач: от быстрых скриптов до профессиональных утилит. Выбор зависит от сложности проекта, предпочтений в синтаксисе и необходимости интеграции с другими инструментами. Начните с argparse для основ, переходите на Click или Typer для сложных сценариев, а Fire и Docopt помогут сэкономить время.