remote_path Property

The remote path on the server.

Syntax

def get_remote_path() -> str: ...
def set_remote_path(value: str) -> None: ...

remote_path = property(get_remote_path, set_remote_path)

Default Value

""

Remarks

The remote_path is either an absolute file path, or a relative path based on the server current directory.

This property specifies the remote path on the server when uploading or downloading.

This is required when using a filemask to upload multiple files.

In all other cases it is optional and path information may instead be specified in remote_file. If this is set, it is combined with remote_file to form a complete path to the file.

Multiple file uploads and downloads are supported through the use of filemasks.

To upload files matching a filemask set local_file to a local path including a filemask. Set remote_path to the directory on the server where the files will be uploaded. In this case remote_file is ignored. All matching files will be upload when upload is called. The on_start_transfer, on_transfer, and on_end_transfer events provide details about the individual file transfers.

To download files matching a filemask set remote_file to a filemask. The path may be specified as part of the value in remote_file or may be set separately in remote_path. local_file should be set to a local directory where files will be downloaded. When download is called all matching files are downloaded. The on_start_transfer, on_transfer, and on_end_transfer events provide details about the individual file transfers. In the event an individual file fails to transfer the on_error event will fire.