Skip to content

Interfaces and Protocols

Protocols for fspachinko.

Classes:

Name Description
Observer

Interface for fspachinko Observer.

Observer

Bases: ABC

Interface for fspachinko Observer.

Methods:

Name Description
on_progress_total

Call when starting a new total progress cycle.

on_count_total

Call to update total progress percentage.

on_progress

Call when starting a new progress cycle.

on_finished

Call when processing is finished.

on_log

Call to log a message.

on_time

Call to update time remaining.

on_count

Call to update progress percentage.

on_progress_total(maximum: int) -> None abstractmethod

Call when starting a new total progress cycle.

on_count_total() -> None abstractmethod

Call to update total progress percentage.

on_progress(maximum: int) -> None abstractmethod

Call when starting a new progress cycle.

on_finished() -> None abstractmethod

Call when processing is finished.

on_log(msg: str) -> None abstractmethod

Call to log a message.

on_time() -> None abstractmethod

Call to update time remaining.

on_count(count: int) -> None abstractmethod

Call to update progress percentage.