-
-
Notifications
You must be signed in to change notification settings - Fork 0
2. Parameters (ru)
Patsuckow Aleksey edited this page Dec 27, 2019
·
1 revision
Параметры, которые могут быть изменены по желанию и переданы в конструктор класса SimpleProgressBar.
Параметры
---------
start : int, >= 0, необязательный
Число - начало итераций. Индикатор выполнения отображается в
консоли как начальный процент. Может начинаться не от ноля.
[по умолчанию: 0]
stop : int, >= start, необязательный
Конечное число итераций. Это может быть либо целое число итераций,
либо целое число битов информации при uploading или downloading файла.
[по умолчанию: 100]
progress_bar : str, необязательный
Выберите показать или скрыть индикатор выполнения: ['show', 'hide']
Если вы решите «скрыть», то следующие параметры будут отключены за
ненадобностью: variant_bar, variant_brackets, variant_arrow, len_bar,
variant_space.
[по умолчанию: 'show']
variant_bar : str, необязательный
Выберите один из вариантов отображения индикатора выполнения:
['increasing', 'static', 'decreasing']
'increasing' - возрастающий индикатор выполнения, будет увеличиваться
от 0% до 100%.
'static' - статический индикатор выполнения. Место для движения
прогресс бара будет сразу отображено. Индикатор выполнения
будет увеличиваться от 0% до 100%.
'decreasing' - Убывающий индикатор выполнения, во время работы
уменьшится со 100% до 0%.
Как уменьшение может начинаться не от 100%, а например от 75% и т.п.,
так и увеличение может начинаться не от 0%, а например от 30% и т.п.
Будет отображаться только если progress_bar='show'
[по умолчанию: 'static']
variant_brackets : str, len(str) == 0 or len(str) == 2, необязательный
Укажите символы скобок, которые вы хотите видеть до и после
индикатора выполнения.
Например: '||', '{}', '[]', '//', '**' и т.п. Unicode-символы.
Если вам не нужны скобки, то поставьте: ''
Будет отображаться только если progress_bar='show' и variant_bar='static'
[по умолчанию: '||']
variant_arrow : str, не пустой, не пробел, необязательный
Вариант символа стрелки прогресса.
Например: '⏹', '∎', '▣', '◉', '●', '#', 'X', '=', '/' '\', '.' и т.п.
Unicode-символы.
Будет отображаться только если progress_bar='show'
[по умолчанию: '▇']
variant_space : str, не пустой, может быть пробелом, необязательный
Вариант пробельного символа в незаполненной области индикатора
выполнения прогресса.
Например: ' ', '-', '·', '༝', '༚', '༛', '༞', '•', '⬞', '◯', '▢', '⬜'
и т.п. Unicode-символы.
Будет отображаться только если progress_bar='show' и variant_bar='static'
[по умолчанию: '-']
len_bar : int, 10 >= len_bar <= 100, необязательный
Длина индикатора выполнения. Считается в "консольных" столбцах.
Это имеет смысл только тогда, когда progress_bar='show'
[по умолчанию: 35]
progress_str : str, необязательный
Укажите желаемое имя для индикатора процентов.
Будет отображаться только если progress_bar='hide'
[по умолчанию: 'Progress']
percent : str, необязательный
Этот параметр отвечает за отображение процентов выполнения и по
умолчанию отображается.
Но, если вам нужно отобразить скачивание файла, а размер файла
(content-length) неизвестен и невозможно его получить (так как многие
онлайн сервисы файлов стали скрывать эту информацию и даже прячут
прямые ссылки на файлы), то вам прейдётся проценты выполнения
«спрятать» - 'hide'.
[по умолчанию: 'show']
timer : str, необязательный
Выберите показать или скрыть таймер: ['show', 'hide']
Если вы решите «скрыть», следующие параметры будут отключены за
ненадобностью: variant_timer, icon_timer, variant_icon_timer,
timer_str, reverse_timer_str.
[по умолчанию: 'show']
variant_timer: str, необязательный
Выберите, какой таймер нужен: ['increasing', 'decreasing']
Это имеет смысл только тогда, когда timer='show'
[по умолчанию: 'increasing']
icon_timer : str, необязательный
Выберите вид иконки таймера: ['animated', 'static', 'hide']
Это имеет смысл только тогда, когда timer='show'
[по умолчанию: 'animated']
variant_icon_timer : str, необязательный
Если icon_timer настроен в 'animated', то мы показываем анимированные
часы, используя наш набор символов Unicode.
Например: '⏳⏳⏳⌛⌛⌛ ', '⣾⣷⣯⣟⡿⢿⣻⣽', '⣽⣻⢿⡿⣟⣯⣷⣾',
'᎐᎐᎓᎓᎒᎒᎓᎓᎐᎐', '᎒᎒᎓᎓᎐᎐', '᎐᎐᎓᎓᎒᎒', '᎐᎓᎒᎓᎐', '᎐᎓᎒', '᎒᎓᎐', '∴∵', '∴∵∷',
'▁▂▃▄▅▆▇█▇▆▅▄▃▂▁', '▁▂▃▄▅▆▇█', '█▇▆▅▄▃▂▁', '▞▚', '▬▭', '▮▯', '⚪⚫',
'▏▎▍▌▋▊▉█▉▊▋▌▍▎▏', '▏▎▍▌▋▊▉█', '█▉▊▋▌▍▎▏', 'ↀↀↂↂↈↈ',
'⋮⋰⋱', '⋱⋰⋮', '⋱⋰', '⎽⎼⎻⎺⎻⎼⎽', '-\\|//', '//|\\-',
'ⅠⅠⅡⅡⅢⅢⅢⅡⅡⅠⅠ', 'ⅠⅠⅡⅡⅢⅢ', 'ⅠⅡⅢ', '◑◒◐◓', '○◔◑◕●', '●◕◑◔○',
'◀▼▶▲', '▲▶▼◀', '◢◣◤◥', '◥◤◣◢', '◥◣◤◢', '◢◤◣◥', '◩⬔◪⬕', '⬕◪⬔◩',
'⬜⬜⬛⬛', '⬜⬛', '◨⬓◧⬒', '⬒◧⬓◨', '◨⬓◧⬒◨⬓◧⬒◨⬒◧⬓◨⬒◧⬓◨⬓', '♦♦♢♢', '♦♢',
' ◨⬓◧⬒◨⬓◧⬒◨⬓◧⬒◨⬓◧⬒ ⬒◧⬓◨⬒◧⬓◨⬒◧⬓◨⬒◧⬓◨', '⊕⊗', '☢☢☢ ', '⌃⌄',
'⇑⇗⇒⇘⇓⇙⇐⇖', '←↖↑↗→↘↓↙', '⇠⇡⇢⇣', '↞↟↠↡', '↤↥↦↧', '★☆✪', '★☆✪✫✯',
'☆✪', '⍟✪☆', '☆✪⍟', '✧✦', '✳✴✵✷', '⚹✳✴✵✷', '✲✱', '♡♡♡♡♡♥♥♡♡♥♥'
Отображается когда timer='show' и icon_timer='animated'
[по умолчанию: '🕛🕧🕐🕜🕑🕝🕒🕞🕓🕟🕔🕠🕕🕡🕖🕢🕗🕣🕘🕤🕙🕥🕚🕦']
timer_str : str, необязательный
Строка, отображаемая между иконкой таймера и цифровым счетчиком
таймера, который является возрастающим.
Если вы не хотите показывать эту строку, вам просто нужно передать
пустую строку параметру: timer_str=''
Отображается когда timer='show' и variant_timer='increasing'
[по умолчанию: 'Timer']
reverse_timer_str : str, необязательный
Строка, отображаемая между иконкой таймера и цифровым счетчиком
таймера, который является убывающим.
Если вы не хотите показывать эту строку, вам просто нужно передать
пустую строку параметру: reverse_timer_str=''
Отображается когда timer='show' и variant_timer='decreasing'
[по умолчанию: 'eta']
speed : str, необязательный
Выберите, показать или скрыть индикатор скорости: ['show', 'hide']
Если вы выберите "hide", следующие параметры будут отключены за
ненадобностью: icon_speed, variant_icon_speed, speed_str
По умолчанию индикатор скрыт, поскольку настройка требуется только в
том случае, если индикатор прогресса рассчитывает скорость передачи
файла.
[по умолчанию: 'hide']
icon_speed : str, необязательный
Выберите из списка, показать или скрыть иконку скорости:
['show', 'hide']
Отображается когда speed='show'
[по умолчанию: 'show']
variant_icon_speed : str, необязательный
Если icon_speed="show", тогда мы покажем значок, который установлен
по умолчанию, или тот, который будет установлен пользователем.
Например: '🚄', '🛪', '🛫', '🛧', '🛬', '🛦', '🚴', '🚵', '🏃'
Отображается когда speed='show' and icon_speed='show'
[по умолчанию: '🚀']
speed_str : str, необязательный
Строка, отображаемая между иконкой скорости и цифровым счетчиком
скорости.
Если вы не хотите не показывать эту строку, вам просто нужно передать
пустую строку параметру: speed_str=''
Отображается когда speed='show'
[по умолчанию: 'Speed']
load : str, необязательный, 'show' or 'hide'
Выберите, показать или скрыть индикатор передачи данных:
['show', 'hide']
По умолчанию индикатор скрыт, поскольку настройка требуется только в
том случае, если индикатор выполнения вычисляет размер файла при его
передаче.
[по умолчанию: 'hide']
icon_load : str, необязательный
Выберите из списка, показать или нет значок загрузки: ['show', 'hide']
Это имеет смысл только тогда, когда load='show'
[по умолчанию: 'show']
variant_icon_load : str, необязательный
Если icon_load="show", то мы покажем значок, который установлен по
умолчанию, или тот, который установит пользователь.
Например:
down: '⭳', '↧', '↓', '🡇', '⭣', '⇓', '⮇', '⭭', '🠯', '🠇', etc.
up: '⭱', '↥', '↑', '🡅', '⭡', '⇑', '⮅', '⭫', '🠭', '🠅', etc.
up-down: '⬍', '↕', '⇕', '⇅', '⭥', '⮁', etc.
Отображается когда load='show' and icon_load='show'
[по умолчанию: '⭳']
load_str : str, необязательный
Строка, отображаемая между иконкой загрузки данных и цифровым
счетчиком загрузки данных.
Если вы не хотите показывать эту строку, вам просто нужно передать
пустую строку параметру: load_str=''
Отображается когда load='show'
[по умолчанию: 'Loaded']
color : str, необязательный
Выберите из списка один цвет, которым будут подсвечиваться индикаторы,
и сам индикатор выполнения: ['black', 'red', 'green', 'yellow',
'blue', 'magenta', 'cyan', 'gray', 'white']
[по умолчанию: 'green']
end_msg : str, необязательный
Сообщение показываемое после завершения индикатора выполнения (при
необходимости).
-
Значения Unicode-символов, которые можно использовать для параметров, можно взять из таблицы Unicode. Вы можете скопировать символы Юникода, например, с этого сайта: https://unicode-table.com/ru/
-
По умолчанию ширина консольного окна различна в разных системах, но в среднем составляет 80 столбцов. Если вы не развернете окно консоли на весь экран, этого будет недостаточно для отображения всех возможных индикаторов и надписей в строке индикатора выполнения. Но благодаря настройкам вы можете отображать те индикаторы, иконки и бейджики индикаторов, которые вам нужны, и скрывать то, что вам не нужно.Переведено