progressbar.base module

Sentinels for “no length known” and “no value given”.

Both sentinels are classes, not instances, and both are falsey. That is the whole point of FalseMeta: it lets the rest of the library write if self.max_value: and have that mean “has a known, usable length”, without a separate is UnknownLength check at every site. See ProgressBar.data and the update-gate logic in progressbar.bar for the call sites that rely on it.

class progressbar.base.FalseMeta

Bases: type

Metaclass making its classes evaluate as false.

Applied to the sentinels below so they can stand in for a missing value in a boolean test rather than needing an identity comparison.

class progressbar.base.IO

Bases: Generic

Generic base class for TextIO and BinaryIO.

This is an abstract, generic version of the return of open().

NOTE: This does not distinguish between the different possible classes (text vs. binary, read vs. write vs. read/write, append-only, unbuffered). The TextIO and BinaryIO subclasses below capture the distinctions between text vs. binary, which is pervasive in the interface; however we currently do not offer a way to track the other distinctions in the type system.

abstractmethod close() → None

abstract property closed: bool

abstractmethod fileno() → int

abstractmethod flush() → None

abstractmethod isatty() → bool

abstract property mode: str

abstract property name: str

abstractmethod read(n: int = -1) → AnyStr

abstractmethod readable() → bool

abstractmethod readline(limit: int = -1) → AnyStr

abstractmethod readlines(hint: int = -1) → List

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

abstractmethod seekable() → bool

abstractmethod tell() → int

abstractmethod truncate(size: int = None) → int

abstractmethod writable() → bool

abstractmethod write(s: AnyStr) → int

abstractmethod writelines(lines: List) → None

class progressbar.base.TextIO

Bases: IO[str]

Typed version of the return of open() in text mode.

abstract property buffer: BinaryIO

abstract property encoding: str

abstract property errors: str | None

abstract property line_buffering: bool

abstract property newlines: Any

class progressbar.base.Undefined

Bases: object

No value was supplied, where None is itself meaningful.

class progressbar.base.UnknownLength

Bases: object

The total amount of work is not knowable in advance.

Passed as max_value for an iterable with no __len__ (a generator, a stream) so the bar renders progress without a percentage or an ETA.