on_progress Event

Reports the data transfer progress.

Syntax

class FTPClientProgressEventParams(object):
  @property
  def total() -> int: ...
  @property
  def current() -> int: ...
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

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

Remarks

This event fires periodically during a file transfer operation to report its progress.

Use the Cancel parameter to terminate the transfer if needed.