progressbar.utils module¶
- class progressbar.utils.AttributeDict[source]¶
Bases:
dict
A dict that can be accessed with .attribute.
>>> attrs = AttributeDict(spam=123)
# Reading
>>> attrs['spam'] 123 >>> attrs.spam 123
# Read after update using attribute
>>> attrs.spam = 456 >>> attrs['spam'] 456 >>> attrs.spam 456
# Read after update using dict access
>>> attrs['spam'] = 123 >>> attrs['spam'] 123 >>> attrs.spam 123
# Read after update using dict access
>>> del attrs.spam >>> attrs['spam'] Traceback (most recent call last): ... KeyError: 'spam' >>> attrs.spam Traceback (most recent call last): ... AttributeError: No such attribute: spam >>> del attrs.spam Traceback (most recent call last): ... AttributeError: No such attribute: spam
- class progressbar.utils.StreamWrapper[source]¶
Bases:
object
Wrap stdout and stderr globally.
- excepthook(exc_type: type[BaseException], exc_value: BaseException, exc_traceback: TracebackType | None) None [source]¶
- original_excepthook: Callable[[Type[BaseException], BaseException, TracebackType | None], None]¶
- start_capturing(bar: ProgressBarMixinBase | None = None) None [source]¶
- stderr: TextIO | WrappingIO¶
- stdout: TextIO | WrappingIO¶
- stop_capturing(bar: ProgressBarMixinBase | None = None) None [source]¶
- wrap_stderr() WrappingIO [source]¶
- wrap_stdout() WrappingIO [source]¶
- class progressbar.utils.WrappingIO(target: base.IO, capturing: bool = False, listeners: types.Optional[types.Set[ProgressBar]] = None)[source]¶
Bases:
object
- buffer: StringIO¶
- progressbar.utils.deltas_to_seconds(*deltas: None | ~datetime.timedelta | float, default: ~typing.Type[ValueError] | None = <class 'ValueError'>) int | float | None [source]¶
Convert timedeltas and seconds as int to seconds as float while coalescing.
>>> deltas_to_seconds(datetime.timedelta(seconds=1, milliseconds=234)) 1.234 >>> deltas_to_seconds(123) 123.0 >>> deltas_to_seconds(1.234) 1.234 >>> deltas_to_seconds(None, 1.234) 1.234 >>> deltas_to_seconds(0, 1.234) 0.0 >>> deltas_to_seconds() Traceback (most recent call last): ... ValueError: No valid deltas passed to `deltas_to_seconds` >>> deltas_to_seconds(None) Traceback (most recent call last): ... ValueError: No valid deltas passed to `deltas_to_seconds` >>> deltas_to_seconds(default=0.0) 0.0
- progressbar.utils.len_color(value: str | bytes) int [source]¶
Return the length of value without ANSI escape codes.
>>> len_color(b'[1234]abc') 3 >>> len_color('[1234]abc') 3 >>> len_color('[1234]abc') 3
- progressbar.utils.no_color(value: StringT) StringT [source]¶
Return the value without ANSI escape codes.
>>> no_color(b'[1234]abc') b'abc' >>> str(no_color('[1234]abc')) 'abc' >>> str(no_color('[1234]abc')) 'abc' >>> no_color(123) Traceback (most recent call last): ... TypeError: `value` must be a string or bytes, got 123