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

Установка Click

Для начала установите библиотеку с помощью pip:

 # pip
 pip install click

  # poetry
 poetry add click 

Основы Click

Click использует декораторы для определения команд и их параметров. Основные элементы:

1. @click.command(): Создаёт команду.
2. @click.option(): Добавляет опции (аргументы с флагами, например, --name).
3. @click.argument(): Добавляет обязательные аргументы.

Пример CLI-приложения

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

import click

@click.command()
@click.option('--name', default='Гость', help='Ваше имя')
@click.option('--phrase', prompt='Введите фразу', help='Фраза для подсчёта слов')
def greet(name, phrase):
    """Приветствует пользователя и считает слова в фразе."""
    click.echo(f"Привет, {name}!")
    word_count = len(phrase.split())
    click.echo(f"В вашей фразе {word_count} слов(а).")

if __name__ == '__main__':
    greet()

Разбор примера

1. Декоратор @click.command(): Определяет функцию greet как команду CLI.
2. Опция --name: Позволяет указать имя через флаг --name (по умолчанию "Гость").
3. Опция --phrase: Запрашивает фразу у пользователя (с помощью prompt), если она не передана.
4. click.echo: Выводит текст в консоль (рекомендуется вместо print для совместимости).
5. Запуск: if __name__ == '__main__': обеспечивает выполнение команды.

Как запустить

Сохраните код в файл, например, cli.py, и выполните:

python cli.py --name Анна --phrase "Я люблю программировать"

Или без параметров, чтобы ввести фразу вручную:

python cli.py

Вывод (пример):

Привет, Анна!
В вашей фразе 3 слов(а).

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

1. Простота: Минимум кода для создания CLI.
2. Гибкость: Поддержка подкоманд, групп, сложных опций.
3. Документация: Автоматическая генерация справки (--help).
4. Кроссплатформенность: Работает на Windows, Linux, MacOS.

Полезные советы

1. Добавление подкоманд: Используйте @click.group() для создания группы команд:

   @click.group()
   def cli():
       pass
   
   @cli.command()
   def hello():
       click.echo("Привет, мир!")

2. Обработка ошибок: Click автоматически проверяет типы данных и выводит понятные сообщения об ошибках.
3. Справка: Добавьте описание в функцию с помощью docstring или параметра help в декораторах.

Заключение

Click — отличный выбор для создания CLI-приложений в Python. С помощью простых декораторов вы можете быстро настроить команды, опции и аргументы. Попробуйте добавить больше опций или подкоманд в пример выше, чтобы изучить возможности библиотеки! Вы можете написать свои команды без использования библиотеки click, но это будет похоже на костыль. Обычно эту библиотеку используют для создания команд в FastApi. Вам просто нужно сделать отдельную папку для команд. Я обычно наполняю базу данных данными при помощи команды.