Сообщить об ошибке.

Краткий обзор раздела: Модуль click, интерфейс командной строки на Python.

Содержание с кратким описанием:

ОБЗОР: Модуль click, интерфейс командной строки на Python.
Модуль click - это пакет Python для создания красивых интерфейсов командной строки компонуемым способом с минимальным количеством кода, насколько это необходимо. Он легко настраивается, но по умолчанию поставляется с разумными настройками.
Интеграция модуля click с setuptools в Python.
Если созданная утилита командной строки имеет зависимости от сторонних модулей, то перенос ее на другую систему становиться проблемой. Пакет setuptools создан для того, чтобы более легко создавать и распространять пакеты Python, особенно те, которые зависят от сторонних модулей/пакетов.
Cтиль и цвета при выводе текста в терминал, модуль click в Python.
Функция click.echo() поддерживает цвета и стили ANSI. В Windows используется модуль colorama. Функция click.style() стилизует текст со стилями ANSI. Функция click.secho() объединяет в себе две предыдущих.
Опции сценария командной строки модуля click в Python.
Добавление опций к сценариям командной строки может быть выполнено с помощью декоратора @click.option(). Так как опции могут быть разных версий (короткие или длинные), существует множество параметров для настройки их поведения.
Позиционные параметры командной строки модуля click в Python.
Параметры (аргументы) модуля click работают аналогично опциям, но являются позиционными. Они также поддерживают только часть функций опций из-за их синтаксической природы. Модуль click также не будет автоматически генерировать справку по используемым позиционным параметрам.
Встроенные типы опций и параметров модуля click в Python.
Значения опций и параметров сценария всегда извлекаются как тип str, и могут конвертироваться в разные типы Python. Типы могут быть реализованы с различным поведением, некоторые из них встроены в модуль click. Встроенные типы передаются аргументу type декораторов @click.option() и @click.argument()
Произвольное вложение команд в сценариях модуля click в Python.
Самая важная особенность модуля click - это концепция произвольного вложения команд сценария командной строки. Это поведение реализуется через декораторы @click.сommand() и @click.group().
Запрос на ввод данных, подтверждение действий в сценариях модуля click в Python.
Запрос на интерактивный ввод данных возможен двумя разными способами: 1. во время обработки опций и параметров, при помощи передачи аргумента prompt. 2. независимый запрос подсказок позже, с использованием функции модуля click.prompt().
Настройка страницы справки сценария на click в Python.
Модуль click позволяет очень легко вносить изменения/дополнять автоматически генерируемую страницу справки сценария командной строки. Генерируемые страницы справки в настоящее время не настраиваются с точки зрения их макета, можно изменить весь текст.
Индикатор выполнения для модуля click в Python.
Модуль сlick поддерживает простую визуализацию индикатора выполнения с помощью функции click.progressbar(). Базовое использование очень простое: идея состоит в том, что данные, с которыми предстоит работать, представляют из себя итерацию. Обработка каждого элемента в итерации может занять некоторое
Прокрутка длинного текста в терминале с модулем click в Python.
Иногда, бывает необходимо показать длинные тексты в терминале (например длинная справка по сценарию) и позволить пользователю прокручивать его. Такое поведение может быть достигнуто с помощью функции click.echo_via_pager(), которая работает аналогично функции click.echo(), но всегда записывает выво
Ожидание нажатия клавиши в сценарии click в Python.
Иногда бывает полезно сделать паузу, пока пользователь не нажмет любую клавишу на клавиатуре. Это особенно полезно в Windows, где cmd.exe по умолчанию закроет окно в конце выполнения команды. Модуль click позволяет это сделать с помощью функции click.pause().
Запуск приложений ОС из сценария на click в Python.
Модуль click поддерживает запуск приложений ОС через функцию click.launch(). Это поведение можно использовать для открытия приложения по умолчанию, связанного с URL-адресом или типом (расширением) файла, например, для запуска веб-браузеров или программ просмотра изображений.