on_progress Event

Fired as progress is made.

Syntax

class SDAProgressEventParams(object):
  @property
  def filename() -> str: ...
  @property
  def bytes_processed() -> int: ...
  @property
  def percent_processed() -> int: ...

# In class SDA:
@property
def on_progress() -> Callable[[SDAProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[SDAProgressEventParams], None]) -> None: ...

Remarks

The on_progress event is automatically fired as compression is performed.

Filename contains the name of the file being written.

BytesProcessed contains the total number of uncompressed bytes processed.

PercentProcessed contains the percent of uncompressed bytes processed, corresponding roughly to the running time of the operation.