Abort

Abort a file transfer in progress

Close

Close connection to the server unilaterally

Connect

Connect to FTP server

Arguments

Argument Type Default value Description
hoststrnull
portint21
userstr, NoneNone
passwordstr, NoneNone
tlsboolFalse
transferstrpassive
keyfilestr, NoneNone
certfilestr, NoneNone
timeoutint, NoneNone
source_addressTuple[str, int], NoneNone
param host:address of the server
param port:port of the server, defaults to 21
param user:login name, defaults to None
param password:login password, defaults to None
param tls:connect using TLS support, defaults to False
param transfer:mode of the transfer, defaults to "passive"
param keyfile:path to private key file
param certfile:path to certificate file
param timeout:a timeout in seconds for the connection attempt
param source_address:
 socket to bind to as its source address before connecting
raises AuthenticationException:
 on authentication error with the server

Cwd

Change working directory on the server

Arguments

Argument Type Default value Description
dirnamestrnull
param dirname:name of the directory

Delete

Delete file on the server

Arguments

Argument Type Default value Description
filepathstrnull
param filepath:path to server file

Download

Download file from FTP server

Arguments

Argument Type Default value Description
remotefilestrnull
localfilestr, NoneNone
param remotefile:
 path to remote file on the server
param localfile:
 name of the downloaded file on the local filesystem, if None will have same name as remote file

File Size

Return byte size of the file on the server

Arguments

Argument Type Default value Description
filepathstrnull
param filepath:path to server file

Get Welcome Message

Get server welcome message

return:welcome message

List Files

List files on the server directory

Arguments

Argument Type Default value Description
dirnamestr
param dirname:name of the directory

Mkd

Create a new directory on the server

Arguments

Argument Type Default value Description
dirnamestrnull
param dirname:name of the directory

Pwd

Get current working directory on the server

Quit

Send QUIT command to the server and close connection

Rename

Rename file on the server

Arguments

Argument Type Default value Description
fromnamestrnull
tonamestrnull
param fromname:current name of the file
param toname:new name for the file

Rmd

Remove directory on the server

Arguments

Argument Type Default value Description
dirnamestrnull
param dirname:name of the directory

Send Command

Execute command on the server

Arguments

Argument Type Default value Description
commandstrnull

List of FTP commands: https://en.wikipedia.org/wiki/List_of_FTP_commands

param command:name of the command to send

Set Ascii Mode

Set transfer mode to ASCII

Set Binary Mode

Set transfer mode to BINARY

Set Debug Level

Set debug level for the library

Arguments

Argument Type Default value Description
levelint0
param level:integer value of debug level, defaults to 0

0 - no debugging output 1 - moderate amount of debugging 2+ - higher amount of debugging

Upload

Upload file to FTP server

Arguments

Argument Type Default value Description
localfilestrnull
remotefilestrnull
param localfile:
 path to file to upload
param remotefile:
 name of uploaded file in the server