Руководство о том, как добавить простой индикатор выполнения в код Python с помощью библиотеки Rich.
Привет, мир!
Сегодня мы рассмотрим, как добавить простой индикатор выполнения в код Python с помощью библиотеки Rich.
Я уже рассказывал об этой библиотеке в своем посте о создании таблиц внутри вашего терминала:
Для тех, кто никогда не видел эту библиотеку, Rich — это пакет Python для форматированного текста и красивого форматирования в терминале. Он довольно прост в использовании и быстро интегрируется в ваши проекты. С помощью этого пакета вы можете делать много интересных вещей в своем терминале, вот краткий пример с веб-страницы GitHub:
Сегодня мы собираемся сделать это простым и просто посмотрим, как показать индикатор выполнения для вашего кода.
Как обычно, я разделю пост на абзацы, так что не стесняйтесь пропустить.
0. Требования и цель
Для этого урока вам понадобится:
- Питон 3.х
- Следующий пакет: богатый
Мы собираемся установить требования (кроме Python) на следующем шаге.
Учебник ориентирован на:
- начинающие программисты на питоне
- Людям, которые хотят узнать больше о TUI (терминальных пользовательских интерфейсах) в Python.
1. Установка требований
богатый
Первое, что нам нужно сделать, это установить требования. В этом уроке мы собираемся использовать rich для создания нашего индикатора выполнения.
Для установки пакета нам достаточно написать в терминале:
pip install rich
Если вы хотите взглянуть на документацию, вы найдете ее здесь:
2. Создание цикла for
Теперь, когда мы установили пакет, нам нужно создать фрагмент кода для работы с ним:
В этой первой части кода мы определяем нашу функцию do_something, которая ожидает 0,1 секунды, а затем возвращает строку. Чтобы проверить это без реализации индикатора выполнения, мы можем просто написать простой цикл for, вызывающий нашу функцию и выводящий после завершения процесса:
3. Реализация индикатора выполнения
Чтобы реализовать индикатор выполнения с помощью Rich, у нас есть два разных способа:
Использование трека
Трек — это быстрый способ добавить в код индикатор выполнения. Вам не нужно вносить серьезные изменения в код, вы можете просто вставить функцию там, где вы объявили размер цикла for, и все готово.
Вам также необходимо удалить печать внутри вашего цикла, потому что это будет конфликтовать с отображением индикатора выполнения:
Использование прогресса
Если вы хотите лучше контролировать свой индикатор выполнения, вы можете использовать класс Progress. Чтобы использовать это, вам нужно создать объект прогресса, а затем создать задачу для каждого индикатора выполнения, который вам понадобится. Когда у вас есть все, что вам нужно, вы можете продвигать индикаторы выполнения, используя метод обновления.
Как видно из приведенного выше примера, вы также можете изменить описание индикатора выполнения после того, как создали объект:
Использование прогресса (несколько тактов)
Вы также можете создать более одного индикатора выполнения, создав несколько задач. После этого вы можете обновлять каждую задачу по мере необходимости:
И это все на сегодня. Как обычно, вы можете найти полный пример на моем GitHub.
Если вы хотите поддержать меня, рассмотрите возможность подписки на Medium, используя мою реферальную ссылку:
Другие URL-адреса:
Персональный сайт:
Социальные ссылки:
Линкедин:
Дополнительные материалы на PlainEnglish.io. Подпишитесь на нашу бесплатную еженедельную рассылку новостей. Подпишитесь на нас в Twitter и LinkedIn. Присоединяйтесь к нашему сообществу Discord.
