Skip to content
Navigation Menu
{{ message }}
forked from wolph/python-progressbar
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwidgets.py
More file actions
1345 lines (1077 loc) · 41.2 KB
/
Copy pathwidgets.py
File metadata and controls
1345 lines (1077 loc) · 41.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
from __future__ import annotations
import abc
import datetime
import functools
import pprint
import sys
import typing
from typing import Callable
from python_utils import converters, types
from . import base, terminal, utils
from .terminal import colors
if types.TYPE_CHECKING:
from .bar import ProgressBarMixinBase
MAX_DATE = datetime.date.max
MAX_TIME = datetime.time.max
MAX_DATETIME = datetime.datetime.max
Data = types.Dict[str, types.Any]
FormatString = typing.Optional[str]
def string_or_lambda(input_):
if isinstance(input_, str):
def render_input(progress, data, width):
return input_ % data
return render_input
else:
return input_
def create_wrapper(wrapper):
'''Convert a wrapper tuple or format string to a format string
>>> create_wrapper('')
>>> print(create_wrapper('a{}b'))
a{}b
>>> print(create_wrapper(('a', 'b')))
a{}b
'''
if isinstance(wrapper, tuple) and len(wrapper) == 2:
a, b = wrapper
wrapper = (a or '') + '{}' + (b or '')
elif not wrapper:
return
if isinstance(wrapper, str):
assert '{}' in wrapper, 'Expected string with {} for formatting'
else:
raise RuntimeError(
'Pass either a begin/end string as a tuple or a'
' template string with {}'
)
return wrapper
def wrapper(function, wrapper_):
'''Wrap the output of a function in a template string or a tuple with
begin/end strings
'''
wrapper_ = create_wrapper(wrapper_)
if not wrapper_:
return function
@functools.wraps(function)
def wrap(*args, **kwargs):
return wrapper_.format(function(*args, **kwargs))
return wrap
def create_marker(marker, wrap=None):
def _marker(progress, data, width):
if (
progress.max_value is not base.UnknownLength
and progress.max_value > 0
):
length = int(progress.value / progress.max_value * width)
return marker * length
else:
return marker
if isinstance(marker, str):
marker = converters.to_unicode(marker)
assert (
utils.len_color(marker) == 1
), 'Markers are required to be 1 char'
return wrapper(_marker, wrap)
else:
return wrapper(marker, wrap)
class FormatWidgetMixin(abc.ABC):
'''Mixin to format widgets using a formatstring
Variables available:
- max_value: The maximum value (can be None with iterators)
- value: The current value
- total_seconds_elapsed: The seconds since the bar started
- seconds_elapsed: The seconds since the bar started modulo 60
- minutes_elapsed: The minutes since the bar started modulo 60
- hours_elapsed: The hours since the bar started modulo 24
- days_elapsed: The hours since the bar started
- time_elapsed: Shortcut for HH:MM:SS time since the bar started including
days
- percentage: Percentage as a float
'''
def __init__(self, format: str, new_style: bool = False, **kwargs):
self.new_style = new_style
self.format = format
def get_format(
self,
progress: ProgressBarMixinBase,
data: Data,
format: types.Optional[str] = None,
) -> str:
return format or self.format
def __call__(
self,
progress: ProgressBarMixinBase,
data: Data,
format: types.Optional[str] = None,
) -> str:
'''Formats the widget into a string'''
format = self.get_format(progress, data, format)
try:
return format.format(**data) if self.new_style else format % data
except (TypeError, KeyError):
print('Error while formatting %r' % format, file=sys.stderr)
pprint.pprint(data, stream=sys.stderr)
raise
class WidthWidgetMixin(abc.ABC):
'''Mixing to make sure widgets are only visible if the screen is within a
specified size range so the progressbar fits on both large and small
screens.
Variables available:
- min_width: Only display the widget if at least `min_width` is left
- max_width: Only display the widget if at most `max_width` is left
>>> class Progress:
... term_width = 0
>>> WidthWidgetMixin(5, 10).check_size(Progress)
False
>>> Progress.term_width = 5
>>> WidthWidgetMixin(5, 10).check_size(Progress)
True
>>> Progress.term_width = 10
>>> WidthWidgetMixin(5, 10).check_size(Progress)
True
>>> Progress.term_width = 11
>>> WidthWidgetMixin(5, 10).check_size(Progress)
False
'''
def __init__(self, min_width=None, max_width=None, **kwargs):
self.min_width = min_width
self.max_width = max_width
def check_size(self, progress: ProgressBarMixinBase):
if self.min_width and self.min_width > progress.term_width:
return False
elif self.max_width and self.max_width < progress.term_width:
return False
else:
return True
class WidgetBase(WidthWidgetMixin, metaclass=abc.ABCMeta):
'''The base class for all widgets
The ProgressBar will call the widget's update value when the widget should
be updated. The widget's size may change between calls, but the widget may
display incorrectly if the size changes drastically and repeatedly.
The INTERVAL timedelta informs the ProgressBar that it should be
updated more often because it is time sensitive.
The widgets are only visible if the screen is within a
specified size range so the progressbar fits on both large and small
screens.
WARNING: Widgets can be shared between multiple progressbars so any state
information specific to a progressbar should be stored within the
progressbar instead of the widget.
Variables available:
- min_width: Only display the widget if at least `min_width` is left
- max_width: Only display the widget if at most `max_width` is left
- weight: Widgets with a higher `weigth` will be calculated before widgets
with a lower one
- copy: Copy this widget when initializing the progress bar so the
progressbar can be reused. Some widgets such as the FormatCustomText
require the shared state so this needs to be optional
'''
copy = True
@abc.abstractmethod
def __call__(self, progress: ProgressBarMixinBase, data: Data) -> str:
'''Updates the widget.
progress - a reference to the calling ProgressBar
'''
_fixed_colors: dict[str, terminal.Color | None] = dict()
_gradient_colors: dict[str, terminal.OptionalColor | None] = dict()
_len: Callable[[str | bytes], int] = len
@functools.cached_property
def uses_colors(self):
for key, value in self._gradient_colors.items():
if value is not None:
return True
return any(value is not None for key, value in self._fixed_colors.items())
def _apply_colors(self, text: str, data: Data) -> str:
if self.uses_colors:
return terminal.apply_colors(
text,
data.get('percentage'),
**self._gradient_colors,
**self._fixed_colors,
)
else:
return text
def __init__(
self, *args, fixed_colors=None, gradient_colors=None, **kwargs
):
if fixed_colors is not None:
self._fixed_colors.update(fixed_colors)
if gradient_colors is not None:
self._gradient_colors.update(gradient_colors)
if self.uses_colors:
self._len = utils.len_color
super().__init__(*args, **kwargs)
class AutoWidthWidgetBase(WidgetBase, metaclass=abc.ABCMeta):
'''The base class for all variable width widgets.
This widget is much like the \\hfill command in TeX, it will expand to
fill the line. You can use more than one in the same line, and they will
all have the same width, and together will fill the line.
'''
@abc.abstractmethod
def __call__(
self,
progress: ProgressBarMixinBase,
data: Data,
width: int = 0,
) -> str:
'''Updates the widget providing the total width the widget must fill.
progress - a reference to the calling ProgressBar
width - The total width the widget must fill
'''
class TimeSensitiveWidgetBase(WidgetBase, metaclass=abc.ABCMeta):
'''The base class for all time sensitive widgets.
Some widgets like timers would become out of date unless updated at least
every `INTERVAL`
'''
INTERVAL = datetime.timedelta(milliseconds=100)
class FormatLabel(FormatWidgetMixin, WidgetBase):
'''Displays a formatted label
>>> label = FormatLabel('%(value)s', min_width=5, max_width=10)
>>> class Progress:
... pass
>>> label = FormatLabel('{value} :: {value:^6}', new_style=True)
>>> str(label(Progress, dict(value='test')))
'test :: test '
'''
mapping = {
'finished': ('end_time', None),
'last_update': ('last_update_time', None),
'max': ('max_value', None),
'seconds': ('seconds_elapsed', None),
'start': ('start_time', None),
'elapsed': ('total_seconds_elapsed', utils.format_time),
'value': ('value', None),
}
def __init__(self, format: str, **kwargs):
FormatWidgetMixin.__init__(self, format=format, **kwargs)
WidgetBase.__init__(self, **kwargs)
def __call__(
self,
progress: ProgressBarMixinBase,
data: Data,
format: types.Optional[str] = None,
):
for name, (key, transform) in self.mapping.items():
try:
data[name] = data[key] if transform is None else transform(data[key])
except (KeyError, ValueError, IndexError): # pragma: no cover
pass
return FormatWidgetMixin.__call__(self, progress, data, format)
class Timer(FormatLabel, TimeSensitiveWidgetBase):
'''WidgetBase which displays the elapsed seconds.'''
def __init__(self, format='Elapsed Time: %(elapsed)s', **kwargs):
if '%s' in format and '%(elapsed)s' not in format:
format = format.replace('%s', '%(elapsed)s')
FormatLabel.__init__(self, format=format, **kwargs)
TimeSensitiveWidgetBase.__init__(self, **kwargs)
# This is exposed as a static method for backwards compatibility
format_time = staticmethod(utils.format_time)
class SamplesMixin(TimeSensitiveWidgetBase, metaclass=abc.ABCMeta):
'''
Mixing for widgets that average multiple measurements
Note that samples can be either an integer or a timedelta to indicate a
certain amount of time
>>> class progress:
... last_update_time = datetime.datetime.now()
... value = 1
... extra = dict()
>>> samples = SamplesMixin(samples=2)
>>> samples(progress, None, True)
(None, None)
>>> progress.last_update_time += datetime.timedelta(seconds=1)
>>> samples(progress, None, True) == (datetime.timedelta(seconds=1), 0)
True
>>> progress.last_update_time += datetime.timedelta(seconds=1)
>>> samples(progress, None, True) == (datetime.timedelta(seconds=1), 0)
True
>>> samples = SamplesMixin(samples=datetime.timedelta(seconds=1))
>>> _, value = samples(progress, None)
>>> value
[1, 1]
>>> samples(progress, None, True) == (datetime.timedelta(seconds=1), 0)
True
'''
def __init__(
self,
samples=datetime.timedelta(seconds=2),
key_prefix=None,
**kwargs,
):
self.samples = samples
self.key_prefix = (
key_prefix if key_prefix else self.__class__.__name__
) + '_'
TimeSensitiveWidgetBase.__init__(self, **kwargs)
def get_sample_times(self, progress: ProgressBarMixinBase, data: Data):
return progress.extra.setdefault(f'{self.key_prefix}sample_times', [])
def get_sample_values(self, progress: ProgressBarMixinBase, data: Data):
return progress.extra.setdefault(f'{self.key_prefix}sample_values', [])
def __call__(
self, progress: ProgressBarMixinBase, data: Data, delta: bool = False
):
sample_times = self.get_sample_times(progress, data)
sample_values = self.get_sample_values(progress, data)
sample_time = sample_times[-1] if sample_times else datetime.datetime.min
if progress.last_update_time - sample_time > self.INTERVAL:
# Add a sample but limit the size to `num_samples`
sample_times.append(progress.last_update_time)
sample_values.append(progress.value)
if isinstance(self.samples, datetime.timedelta):
minimum_time = progress.last_update_time - self.samples
minimum_value = sample_values[-1]
while (
sample_times[2:]
and minimum_time > sample_times[1]
and minimum_value > sample_values[1]
):
sample_times.pop(0)
sample_values.pop(0)
elif len(sample_times) > self.samples:
sample_times.pop(0)
sample_values.pop(0)
if not delta:
return sample_times, sample_values
delta_time = sample_times[-1] - sample_times[0]
delta_value = sample_values[-1] - sample_values[0]
return (delta_time, delta_value) if delta_time else (None, None)
class ETA(Timer):
'''WidgetBase which attempts to estimate the time of arrival.'''
def __init__(
self,
format_not_started='ETA: --:--:--',
format_finished='Time: %(elapsed)8s',
format='ETA: %(eta)8s',
format_zero='ETA: 00:00:00',
format_NA='ETA: N/A',
**kwargs,
):
if '%s' in format and '%(eta)s' not in format:
format = format.replace('%s', '%(eta)s')
Timer.__init__(self, **kwargs)
self.format_not_started = format_not_started
self.format_finished = format_finished
self.format = format
self.format_zero = format_zero
self.format_NA = format_NA
def _calculate_eta(
self, progress: ProgressBarMixinBase, data: Data, value, elapsed
):
'''Updates the widget to show the ETA or total time when finished.'''
if not elapsed:
return 0
# The max() prevents zero division errors
per_item = elapsed.total_seconds() / max(value, 1e-6)
return (progress.max_value - data['value']) * per_item
def __call__(
self,
progress: ProgressBarMixinBase,
data: Data,
value=None,
elapsed=None,
):
'''Updates the widget to show the ETA or total time when finished.'''
if value is None:
value = data['value']
if elapsed is None:
elapsed = data['time_elapsed']
ETA_NA = False
try:
data['eta_seconds'] = self._calculate_eta(
progress, data, value=value, elapsed=elapsed
)
except TypeError:
data['eta_seconds'] = None
ETA_NA = True
data['eta'] = None
if data['eta_seconds']:
try:
data['eta'] = utils.format_time(data['eta_seconds'])
except (ValueError, OverflowError): # pragma: no cover
pass
if data['value'] == progress.min_value:
format = self.format_not_started
elif progress.end_time:
format = self.format_finished
elif data['eta']:
format = self.format
elif ETA_NA:
format = self.format_NA
else:
format = self.format_zero
return Timer.__call__(self, progress, data, format=format)
class AbsoluteETA(ETA):
'''Widget which attempts to estimate the absolute time of arrival.'''
def _calculate_eta(
self, progress: ProgressBarMixinBase, data: Data, value, elapsed
):
eta_seconds = ETA._calculate_eta(self, progress, data, value, elapsed)
now = datetime.datetime.now()
try:
return now + datetime.timedelta(seconds=eta_seconds)
except OverflowError: # pragma: no cover
return datetime.datetime.max
def __init__(
self,
format_not_started='Estimated finish time: ----/--/-- --:--:--',
format_finished='Finished at: %(elapsed)s',
format='Estimated finish time: %(eta)s',
**kwargs,
):
ETA.__init__(
self,
format_not_started=format_not_started,
format_finished=format_finished,
format=format,
**kwargs,
)
class AdaptiveETA(ETA, SamplesMixin):
'''WidgetBase which attempts to estimate the time of arrival.
Uses a sampled average of the speed based on the 10 last updates.
Very convenient for resuming the progress halfway.
'''
def __init__(self, **kwargs):
ETA.__init__(self, **kwargs)
SamplesMixin.__init__(self, **kwargs)
def __call__(
self,
progress: ProgressBarMixinBase,
data: Data,
value=None,
elapsed=None,
):
elapsed, value = SamplesMixin.__call__(
self, progress, data, delta=True
)
if not elapsed:
value = None
elapsed = 0
return ETA.__call__(self, progress, data, value=value, elapsed=elapsed)
class DataSize(FormatWidgetMixin, WidgetBase):
'''
Widget for showing an amount of data transferred/processed.
Automatically formats the value (assumed to be a count of bytes) with an
appropriate sized unit, based on the IEC binary prefixes (powers of 1024).
'''
def __init__(
self,
variable='value',
format='%(scaled)5.1f %(prefix)s%(unit)s',
unit='B',
prefixes=('', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi', 'Yi'),
**kwargs,
):
self.variable = variable
self.unit = unit
self.prefixes = prefixes
FormatWidgetMixin.__init__(self, format=format, **kwargs)
WidgetBase.__init__(self, **kwargs)
def __call__(
self,
progress: ProgressBarMixinBase,
data: Data,
format: types.Optional[str] = None,
):
value = data[self.variable]
if value is not None:
scaled, power = utils.scale_1024(value, len(self.prefixes))
else:
scaled = power = 0
data['scaled'] = scaled
data['prefix'] = self.prefixes[power]
data['unit'] = self.unit
return FormatWidgetMixin.__call__(self, progress, data, format)
class FileTransferSpeed(FormatWidgetMixin, TimeSensitiveWidgetBase):
'''
Widget for showing the current transfer speed (useful for file transfers).
'''
def __init__(
self,
format='%(scaled)5.1f %(prefix)s%(unit)-s/s',
inverse_format='%(scaled)5.1f s/%(prefix)s%(unit)-s',
unit='B',
prefixes=('', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi', 'Yi'),
**kwargs,
):
self.unit = unit
self.prefixes = prefixes
self.inverse_format = inverse_format
FormatWidgetMixin.__init__(self, format=format, **kwargs)
TimeSensitiveWidgetBase.__init__(self, **kwargs)
def _speed(self, value, elapsed):
speed = float(value) / elapsed
return utils.scale_1024(speed, len(self.prefixes))
def __call__(
self,
progress: ProgressBarMixinBase,
data,
value=None,
total_seconds_elapsed=None,
):
'''Updates the widget with the current SI prefixed speed.'''
if value is None:
value = data['value']
elapsed = utils.deltas_to_seconds(
total_seconds_elapsed, data['total_seconds_elapsed']
)
if (
value is not None
and elapsed is not None
and elapsed > 2e-6
and value > 2e-6
): # =~ 0
scaled, power = self._speed(value, elapsed)
else:
scaled = power = 0
data['unit'] = self.unit
if power == 0 and scaled < 0.1:
if scaled > 0:
scaled = 1 / scaled
data['scaled'] = scaled
data['prefix'] = self.prefixes[0]
return FormatWidgetMixin.__call__(
self, progress, data, self.inverse_format
)
else:
data['scaled'] = scaled
data['prefix'] = self.prefixes[power]
return FormatWidgetMixin.__call__(self, progress, data)
class AdaptiveTransferSpeed(FileTransferSpeed, SamplesMixin):
'''Widget for showing the transfer speed based on the last X samples'''
def __init__(self, **kwargs):
FileTransferSpeed.__init__(self, **kwargs)
SamplesMixin.__init__(self, **kwargs)
def __call__(
self,
progress: ProgressBarMixinBase,
data,
value=None,
total_seconds_elapsed=None,
):
elapsed, value = SamplesMixin.__call__(
self, progress, data, delta=True
)
return FileTransferSpeed.__call__(self, progress, data, value, elapsed)
class AnimatedMarker(TimeSensitiveWidgetBase):
'''An animated marker for the progress bar which defaults to appear as if
it were rotating.
'''
def __init__(
self,
markers='|/-\\',
default=None,
fill='',
marker_wrap=None,
fill_wrap=None,
**kwargs,
):
self.markers = markers
self.marker_wrap = create_wrapper(marker_wrap)
self.default = default or markers[0]
self.fill_wrap = create_wrapper(fill_wrap)
self.fill = create_marker(fill, self.fill_wrap) if fill else None
WidgetBase.__init__(self, **kwargs)
def __call__(self, progress: ProgressBarMixinBase, data: Data, width=None):
'''Updates the widget to show the next marker or the first marker when
finished'''
if progress.end_time:
return self.default
marker = self.markers[data['updates'] % len(self.markers)]
if self.marker_wrap:
marker = self.marker_wrap.format(marker)
if self.fill:
# Cut the last character so we can replace it with our marker
fill = self.fill(
progress,
data,
width - progress.custom_len(marker), # type: ignore
)
else:
fill = ''
# Python 3 returns an int when indexing bytes
if isinstance(marker, int): # pragma: no cover
marker = bytes(marker)
fill = fill.encode()
else:
# cast fill to the same type as marker
fill = type(marker)(fill)
return fill + marker # type: ignore
# Alias for backwards compatibility
RotatingMarker = AnimatedMarker
class Counter(FormatWidgetMixin, WidgetBase):
'''Displays the current count'''
def __init__(self, format='%(value)d', **kwargs):
FormatWidgetMixin.__init__(self, format=format, **kwargs)
WidgetBase.__init__(self, format=format, **kwargs)
def __call__(
self, progress: ProgressBarMixinBase, data: Data, format=None
):
return FormatWidgetMixin.__call__(self, progress, data, format)
class ColoredMixin:
_fixed_colors: dict[str, terminal.Color | None] = dict(
fg_none=colors.yellow,
bg_none=None,
)
_gradient_colors: dict[str, terminal.OptionalColor | None] = dict(
fg=colors.gradient,
bg=None,
)
class Percentage(FormatWidgetMixin, ColoredMixin, WidgetBase):
'''Displays the current percentage as a number with a percent sign.'''
def __init__(self, format='%(percentage)3d%%', na='N/A%%', **kwargs):
self.na = na
FormatWidgetMixin.__init__(self, format=format, **kwargs)
WidgetBase.__init__(self, format=format, **kwargs)
def get_format(
self, progress: ProgressBarMixinBase, data: Data, format=None
):
# If percentage is not available, display N/A%
percentage = data.get('percentage', base.Undefined)
if not percentage and percentage != 0:
output = self.na
else:
output = FormatWidgetMixin.get_format(self, progress, data, format)
return self._apply_colors(output, data)
class SimpleProgress(FormatWidgetMixin, ColoredMixin, WidgetBase):
'''Returns progress as a count of the total (e.g.: "5 of 47")'''
max_width_cache: dict[
types.Union[str, tuple[float, float | types.Type[base.UnknownLength]]],
types.Optional[int],
]
DEFAULT_FORMAT = '%(value_s)s of %(max_value_s)s'
def __init__(self, format=DEFAULT_FORMAT, **kwargs):
FormatWidgetMixin.__init__(self, format=format, **kwargs)
WidgetBase.__init__(self, format=format, **kwargs)
self.max_width_cache = {'default': self.max_width or 0}
def __call__(
self, progress: ProgressBarMixinBase, data: Data, format=None
):
# If max_value is not available, display N/A
data['max_value_s'] = data['max_value'] if data.get('max_value') else 'N/A'
# if value is not available it's the zeroth iteration
data['value_s'] = data['value'] if data.get('value') else 0
formatted = FormatWidgetMixin.__call__(
self, progress, data, format=format
)
# Guess the maximum width from the min and max value
key = progress.min_value, progress.max_value
max_width: types.Optional[int] = self.max_width_cache.get(
key, self.max_width
)
if not max_width:
temporary_data = data.copy()
for value in key:
if value is None: # pragma: no cover
continue
temporary_data['value'] = value
if width := progress.custom_len(
FormatWidgetMixin.__call__(
self, progress, temporary_data, format=format
)
):
max_width = max(max_width or 0, width)
self.max_width_cache[key] = max_width
# Adjust the output to have a consistent size in all cases
if max_width: # pragma: no branch
formatted = formatted.rjust(max_width)
return self._apply_colors(formatted, data)
class Bar(AutoWidthWidgetBase):
'''A progress bar which stretches to fill the line.'''
fg: terminal.OptionalColor | None = colors.gradient
bg: terminal.OptionalColor | None = None
def __init__(
self,
marker='#',
left='|',
right='|',
fill=' ',
fill_left=True,
marker_wrap=None,
**kwargs,
):
'''Creates a customizable progress bar.
The callable takes the same parameters as the `__call__` method
marker - string or callable object to use as a marker
left - string or callable object to use as a left border
right - string or callable object to use as a right border
fill - character to use for the empty part of the progress bar
fill_left - whether to fill from the left or the right
'''
self.marker = create_marker(marker, marker_wrap)
self.left = string_or_lambda(left)
self.right = string_or_lambda(right)
self.fill = string_or_lambda(fill)
self.fill_left = fill_left
AutoWidthWidgetBase.__init__(self, **kwargs)
def __call__(
self,
progress: ProgressBarMixinBase,
data: Data,
width: int = 0,
color=True,
):
'''Updates the progress bar and its subcomponents'''
left = converters.to_unicode(self.left(progress, data, width))
right = converters.to_unicode(self.right(progress, data, width))
width -= progress.custom_len(left) + progress.custom_len(right)
marker = converters.to_unicode(self.marker(progress, data, width))
fill = converters.to_unicode(self.fill(progress, data, width))
# Make sure we ignore invisible characters when filling
width += len(marker) - progress.custom_len(marker)
if self.fill_left:
marker = marker.ljust(width, fill)
else:
marker = marker.rjust(width, fill)
if color:
marker = self._apply_colors(marker, data)
return left + marker + right
class ReverseBar(Bar):
'''A bar which has a marker that goes from right to left'''
def __init__(
self,
marker='#',
left='|',
right='|',
fill=' ',
fill_left=False,
**kwargs,
):
'''Creates a customizable progress bar.
marker - string or updatable object to use as a marker
left - string or updatable object to use as a left border
right - string or updatable object to use as a right border
fill - character to use for the empty part of the progress bar
fill_left - whether to fill from the left or the right
'''
Bar.__init__(
self,
marker=marker,
left=left,
right=right,
fill=fill,
fill_left=fill_left,
**kwargs,
)
class BouncingBar(Bar, TimeSensitiveWidgetBase):
'''A bar which has a marker which bounces from side to side.'''
INTERVAL = datetime.timedelta(milliseconds=100)
def __call__(
self,
progress: ProgressBarMixinBase,
data: Data,
width: int = 0,
):
'''Updates the progress bar and its subcomponents'''
left = converters.to_unicode(self.left(progress, data, width))
right = converters.to_unicode(self.right(progress, data, width))
width -= progress.custom_len(left) + progress.custom_len(right)
marker = converters.to_unicode(self.marker(progress, data, width))
fill = converters.to_unicode(self.fill(progress, data, width))
if width: # pragma: no branch
value = int(
data['total_seconds_elapsed'] / self.INTERVAL.total_seconds()
)
a = value % width
b = width - a - 1
if value % (width * 2) >= width:
a, b = b, a
if self.fill_left:
marker = a * fill + marker + b * fill
else:
marker = b * fill + marker + a * fill
return left + marker + right
class FormatCustomText(FormatWidgetMixin, WidgetBase):
mapping: types.Dict[str, types.Any] = {}
copy = False
def __init__(
self,
format: str,
mapping: types.Optional[types.Dict[str, types.Any]] = None,
**kwargs,
):
self.format = format
self.mapping = mapping or self.mapping
FormatWidgetMixin.__init__(self, format=format, **kwargs)
WidgetBase.__init__(self, **kwargs)
def update_mapping(self, **mapping: types.Dict[str, types.Any]):
self.mapping.update(mapping)
def __call__(
self,
progress: ProgressBarMixinBase,
data: Data,
You can’t perform that action at this time.