solidipes.utils.progress module

class solidipes.utils.progress.ProgressBar(description: str, total: float = 100, show_datasize: bool = False)

Bases: ProgressDisplay

_abc_impl = <_abc._abc_data object>

abstractmethod update(advance: float = 0, text: str | None = None) → None

Update the progress bar.

class solidipes.utils.progress.ProgressDisplay(description: str)

Bases: ABC

_abc_impl = <_abc._abc_data object>

close() → None

Close the progress display context.

reset() → None

Reset the progress display to its initial state.

start() → None

Open the progress display context.

class solidipes.utils.progress.Spinner(description: str)

Bases: ProgressDisplay

Generic spinner interface. Can be used as a context manager.

_abc_impl = <_abc._abc_data object>

class solidipes.utils.progress.StreamlitProgressBar(*args, layout: DeltaGenerator | None = None, **kwargs)

Bases: ProgressBar

_abc_impl = <_abc._abc_data object>

close() → None

Close the progress display context.

reset() → None

Reset the progress display to its initial state.

update(advance: float = 0, text: str | None = None) → None

Update the progress bar.

class solidipes.utils.progress.StreamlitSpinner(description: str, layout: DeltaGenerator | None = None)

Bases: Spinner

_abc_impl = <_abc._abc_data object>

start() → None

Open the progress display context.

class solidipes.utils.progress.TextProgressBar(*args, **kwargs)

Bases: ProgressBar

_abc_impl = <_abc._abc_data object>

_set_display_info(text: str | None = None) → None

Set the display info (description, progress, text).

close() → None

Close the progress display context.

reset() → None

Reset the progress display to its initial state.

start() → None

Open the progress display context.

update(advance: float = 0, text: str | None = None) → None

Update the progress bar.

class solidipes.utils.progress.TextSpinner(description: str)

Bases: Spinner

_abc_impl = <_abc._abc_data object>

start() → None

Open the progress display context.

solidipes.utils.progress.get_progress_bar(description: str, total: float = 100, show_datasize: bool = False, backend: str | None = None, streamlit_layout: DeltaGenerator | None = None) → ProgressBar

solidipes.utils.progress.get_spinner(description: str, backend: str | None = None, streamlit_layout: DeltaGenerator | None = None) → Spinner

solidipes.utils.progress.get_streamlit_layout() → DeltaGenerator

solidipes.utils.progress.set_streamlit_layout(layout: DeltaGenerator) → None