on_file_operation Event

Signifies the start of a file transfer operation.

Syntax

class SFTPClientFileOperationEventParams(object):
  @property
  def operation() -> int: ...
  @property
  def remote_path() -> str: ...
  @property
  def local_path() -> str: ...
  @property
  def skip() -> bool: ...
  @skip.setter
  def skip(value) -> None: ...
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class SFTPClient:
@property
def on_file_operation() -> Callable[[SFTPClientFileOperationEventParams], None]: ...
@on_file_operation.setter
def on_file_operation(event_hook: Callable[[SFTPClientFileOperationEventParams], None]) -> None: ...

Remarks

This event is fired each time the class starts an upload or download operation within a multi-file call. Operation defines the operation about to start, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.

If needed, set Skip to true to ignore the current file, or Cancel to abort the whole batch.

Supported operations: