Python для начинающих

- Создание парсеров для командной строки с помощью модуль click.

203 views00:40

### Создание парсеров для командной строки с помощью модуля click

В мире Python есть разнообразные инструменты для создания утилит командной строки. Кто-то обожает библиотеку argparse, а кто-то выбирает сторонние решения вроде typer или docopt. Сегодня мы поговорим о звезде в этой коллекции – библиотеке click. Простая, лаконичная, интуитивно понятная – click помогает создавать мощные CLI-приложения легко и непринужденно. Разберём, как работает модуль, и создадим несколько простых утилит для вас.

Итак, что же такое click? На самом деле, название произошло от слова Command Line Interface Creation Kit (инструментарий для создания CLI). Эта библиотека предназначена для парсинга командной строки и предоставляет гибкий, но при этом удобный API.

---

#### Установка click

Для начала установим библиотеку. Если она у вас ещё не установлена, выполните команду:

pip install click

---

#### Первый скрипт: приветственное сообщение

Давайте для начала создадим утилиту, которая будет приветствовать пользователя. Вот пример кода:

import click

@click.command()
@click.argument("name")
def greet(name):
    """Простая программа для приветствия пользователя."""
    click.echo(f"Hello, {name}!")

if __name__ == "__main__":
    greet()

Рассмотрим, что здесь происходит. С помощью декоратора @click.command мы указываем, что функция greet является командой CLI. Декоратор @click.argument позволяет добавить аргумент, передаваемый через командную строку (в данном случае name).

Когда мы запускаем скрипт в терминале, передав имя:

python script.py Alice

Получаем результат:

Hello, Alice!

Просто, правда?

---

#### Обработка опций

Теперь давайте добавим к нашей программе опции. Как насчёт возможности задать язык приветствия? Для этого используется декоратор @click.option:

import click

@click.command()
@click.option("--lang", default="en", help="Set language (en, ru or es).")
@click.argument("name")
def greet(lang, name):
    """Программа для приветствия пользователя на разных языках."""
    greetings = {
        "en": "Hello",
        "ru": "Привет",
        "es": "Hola"
    }
    greeting = greetings.get(lang, "Hello")
    click.echo(f"{greeting}, {name}!")

if __name__ == "__main__":
    greet()

Теперь попробуем передать параметр для выбора языка:

python script.py Alice --lang ru

Вывод:

Привет, Alice!

Здесь опция --lang задаёт язык приветствия. Значение по умолчанию – английский.

---

#### Несколько команд

Иногда в приложении нужен доступ сразу к нескольким командам. Например, одна команда могла бы вычислять сумму чисел, а другая – приветствовать пользователя. В этом случае нам поможет @click.group.

Вот пример:

import click

@click.group()
def cli():
    """Группа команд."""
    pass

@cli.command()
@click.argument("a", type=int)
@click.argument("b", type=int)
def add(a, b):
    """Суммирует два числа."""
    click.echo(f"The sum is: {a + b}")

@cli.command()
@click.argument("name")
def greet(name):
    """Приветствует пользователя."""
    click.echo(f"Hi, {name}!")

if __name__ == "__main__":
    cli()

Теперь мы получаем приложение с двумя командами: add (сложение) и greet (приветствие). Используем их так:

python script.py add 5 7

Вывод:

The sum is: 12

Или:

python script.py greet Bob

Вывод:

Hi, Bob!

---

#### Продвинутое использование

click позволяет делать и более сложные вещи: запрашивать пользовательский ввод, валидировать данные, обрабатывать исключения.

208 views00:40