Всіх вітаю! Чи цікавилися ви коли небудь як створювати прогрес бари прямо у консолі? Якщо ні, то дана стаття саме для вас! У цій невеличкій статті ми дізнаємося, яким чином можна сторювати прогрес бари за допомогою бібліотеки tqdm у Python.
Встановлення tqdm
Windows:
pip install tqdmMacOS:
pip3 install tqdmLinux:
pip install tqdmСтворення прогрес барів
Як приклад побудуємо просту програму з реєстрацією, де користувач повинен буде написати свій логін та пароль, щоб якби увійти у систему.
Ось такий простий код:
def registration():
print("+===================+\n"
"| Registration form |\n"
"+===================+\n")
login = input("Login: ")
password = input("Password: ")
registration()Тепер пропоную додати прогрес бар після того, як користувач введе логін та пароль. Для цього імпортуємо бібліотеку tqdm та вбудований модуль time:
import tqdm
import timeДалі сторюємо сам прогрес бар за допомогою функції tqdm():
for i in tqdm.tqdm(range(500)):
time.sleep(0.01)По суті єдине, що ми зробили — це передали функції tqdm() функцію range() з кількістю ітерацій. Таким чином ми вже створили свій перший прогрес бар, але також у циклі варто додати час затримки, щоб ми встигли побачити як рухається наш прогрес бар.
Отже, ось повний код нашої програми:
import tqdm
import time
def registration():
print("+===================+\n"
"| Registration form |\n"
"+===================+\n")
login = input("Login: ")
password = input("Password: ")
for i in tqdm.tqdm(range(500)):
time.sleep(0.01)
print(f"Welcome, {login}! We're glad to see you!")
registration()Таким чином, тепер після реєстрації програма буде робити вигляд, наче вона обробляє дані від користувача, а потім вітає його у системі.
Ось як виглядає результат програми:
+===================+
| Registration form |
+===================+
Login: sandman
Password: asdwer4
100%|██████████| 500/500 [00:07<00:00, 64.34it/s]
Welcome, sandman! We're glad to see you!Звісно, тут я лиш додав вже готовий результат, але у вас прогрес бар буде рухатися і ви це побачите.
Параметри прогрес бара
У функції tqdm() насправді є безліч параметрів для надання прогрес барам додаткових можливостей. Декілька таких ми розглянемо у цій частині статті.
Параметр description
Завдяки параметру description ми можемо вказати текст, який буде видно біля прогрес бара. Таким чином ми якби можемо зазначити, що саме ми заватажуємо.
Приклад:
for i in tqdm.tqdm(range(500), desc="Data processing"):
time.sleep(0.01)+===================+
| Registration form |
+===================+
Login: sandman
Password: asdwer4
Data processing: 100%|██████████| 500/500 [00:07<00:00, 64.47it/s]
Welcome, sandman! We're glad to see you!Отже, бачимо напис “Data processing“.
Параметр total
Параметр total надає змогу вказати очікувану кількість ітерацій у прогрес барі. Напис 500/500 у рядку прогрес бара якраз-таки показує, скільки ітерацій пройшов прогрес бар та ту саму очікувану кількість ітерацій.
Ось як це працює:
for i in tqdm.tqdm(range(500), total=1000):
time.sleep(0.01)+===================+
| Registration form |
+===================+
Login: sandman
Password: asdwer4
50%|█████ | 500/1000 [00:07<00:07, 64.42it/s]
Welcome, sandman! We're glad to see you!У даному випадку ми вказали у якості очікуваної кількості ітерацій 1000, але у функції range() кількість ітерацій 500, тому прогрес бар зупинився на 50 відсотках. Тобто за треба розрізняти фактичну кількість ітерацій (500) та очікувану. Так і виходить, що у рядку прогрес бара ми отримали значення 500/1000.
Параметр leave
Параметр leave дозволяє прогрес бару моментально зникнути з консолі, коли він завершив повну кількість ітерацій, що були зазначені у range(). Він приймає тільки булеві значення True та False, причому значення True задано за замовчуванням. Тому, якщо ми задамо цьому параметру значення False, тоді при проходженні повної кількості ітерацій прогрес бар зникне з консолі.
Ось приклад роботи параметра:
for i in tqdm.tqdm(range(500), leave=False):
time.sleep(0.01)+===================+
| Registration form |
+===================+
Login: sandman
Password: asdwer4
Welcome, sandman! We're glad to see you!Як бачимо, прогрес бар дійсно зник з консолі. Якщо ви запустите параметр leave зі значенням True, то прогрес бар залишиться.
Параметр unit
Параметр unit дозволяє вказати конкретну одиницю вимірювання з якою працює наш прогрес бар. Відображатися нова одиниця вимірювання буде у частині рядка з прогрес баром — 64.34it/s.
Ось приклад:
for i in tqdm.tqdm(range(500), unit="MB"):
time.sleep(0.01)+===================+
| Registration form |
+===================+
Login: sandman
Password: asdwer4
100%|██████████| 500/500 [00:07<00:00, 64.27MB/s]
Welcome, sandman! We're glad to see you!Можемо спостерігати, що тепер одиниця вимірювання у нас саме мегабайти — 64.27MB/s.
Параметр colour
За допомогою параметра colour ми маємо можливість вказати колір, яким прогрес бар буде заповнюватися при проходженні ітерацій.
Ось як це виглядає:
for i in tqdm.tqdm(range(500), colour="yellow"):
time.sleep(0.01)
Також крім назви кольорів, ви можете записувати їхній хеш-код.
Висновок
У рамках сьогоднішньої статті ми дізналися як створювати прорес бари за допомогою бібліотеки tqdm. Також ми ознайомилися із декількома параметрами функції tqdm() та впевнилися, що tqdm є простим інструментом для створення прогрес барів із особливостями на різний смак.
