ralsei.console

Module Contents

Functions

track

Track progress by iterating over a sequence.

Data

console

Rich console used for logging

API

ralsei.console.console : rich.console.Console = 'RalseiConsole(...)'

Rich console used for logging

When calling rich.console.Console.log() from within MapToNewTable.fn or MapToNewColumns.fn, will print additional information related to the current row

ralsei.console.track(sequence: collections.abc.Sequence[ralsei.console.track.T] | collections.abc.Iterable[ralsei.console.track.T], description: str = 'Working...', total: float | None = None) → collections.abc.Iterable[ralsei.console.track.T]

Track progress by iterating over a sequence.

Unlike rich.progress.track(), this supports multiple nested progress bars

Parameters:
sequence: collections.abc.Sequence[ralsei.console.track.T] | collections.abc.Iterable[ralsei.console.track.T]

A sequence of values you want to iterate over and track progress.

description: str = 'Working...'

Description of the task

total: float | None = None

Total number of steps. Default is length_hint(sequence)