progressbar.utils module

class progressbar.utils.AttributeDict

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

Bases: object

Wrap stdout and stderr globally.

capturing: int = 0

excepthook(exc_type: type[BaseException], exc_value: BaseException, exc_traceback: TracebackType | None) → None

flush() → None

listeners: set[_ProgressListener]

logging_handlers: list[tuple[StreamHandler[IO], IO]]

needs_clear() → bool

original_excepthook: Callable[[type[BaseException], BaseException, TracebackType | None], None]

start_capturing(bar: _ProgressListener | None = None) → None

stderr: TextIO | WrappingIO

stdout: TextIO | WrappingIO

stop_capturing(bar: _ProgressListener | None = None) → None

unwrap(stdout: bool = False, stderr: bool = False) → None

unwrap_excepthook() → None

unwrap_logging() → None

unwrap_stderr() → None

unwrap_stdout() → None

update_capturing() → None

wrap(stdout: bool = False, stderr: bool = False) → None

wrap_excepthook() → None

wrap_logging() → None

Retarget stdout/stderr logging handlers to wrapped streams.

wrap_stderr() → WrappingIO

wrap_stdout() → WrappingIO

wrapped_excepthook: int = 0

wrapped_logging: int = 0

wrapped_stderr: int = 0

wrapped_stdout: int = 0

class progressbar.utils.WrappingIO(target: IO, capturing: bool = False, listeners: set[_ProgressListener] | None = None)

Bases: object

buffer: StringIO

capturing: bool

close() → None

fileno() → int

flush() → None

flush_target() → None

isatty() → bool

listeners: set[_ProgressListener]

needs_clear: bool = False

read(n: int = -1) → str

readable() → bool

readline(limit: int = -1) → str

readlines(hint: int = -1) → list[str]

seek(offset: int, whence: int = 0) → int

seekable() → bool

target: IO

tell() → int

truncate(size: int | None = None) → int

writable() → bool

write(value: str) → int

writelines(lines: Iterable[str]) → None

progressbar.utils.deltas_to_seconds(*deltas: None | timedelta | float | int, default: type[ValueError] = <class 'ValueError'>) → float

progressbar.utils.deltas_to_seconds(*deltas: None | timedelta | float | int, default: T) → float | T

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

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

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