on_transfer Event

Fired during file download/upload.

Syntax

class SFTPTransferEventParams(object):
  @property
  def direction() -> int: ...
  @property
  def local_file() -> str: ...
  @property
  def remote_file() -> str: ...
  @property
  def bytes_transferred() -> int: ...
  @property
  def percent_done() -> int: ...
  @property
  def text() -> bytes: ...
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class SFTP:
@property
def on_transfer() -> Callable[[SFTPTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[SFTPTransferEventParams], None]) -> None: ...

Remarks

One or more on_transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

To cancel the current transfer set Cancel to true.