Clear message

Python FtpLib

The ftplib module is an FTP client.

---

Usage

from ftplib import FTP

# connect
conn = FTP('ftp.example.com')
conn.login(user='example', passwd='secret')

# list files
conn.dir('folder1')
# or
conn.cwd('folder1')
conn.dir()

# close connection
conn.quit()

---

Classes

Ftp

See the example above.

The following methods are available as interfaces to established FTP commands:

---

Abort

The abort() method tries to abort an ongoing file transfer. This leverages the ABOR command, which actually aborts the last FTP command. This method won't always work.

---

Close

Unilaterally close a connection with the close() method.

The 'correct' thing to do is to instead use quit() which implicitly closes the connection.

---

Connect

If an ftplib.FTP object was not instantiated with a host, call the connect method to connect to a server.

ftp = ftplib.FTP()

ftp.connect(host='ftp.example.com',  port=21, timeout=300)

---

GetWelcome

The getwelcome() method returns the server's welcome message. This is not guaranteed to be a machine-readable message, but may include useful information.

---

Login

The login() method authenticates with the server. See the above example.

---

NTransferCmd

---

RetrBinary

The retrbinary method is a low-level file download interface. The first argument should be a valid RETR command. The second argument should be a callback that can handle binary data received as a response. If a blocksize is not specified, 8192 is the default.

Try:

with open('destination.txt', 'wb') as f:
    ftp.retrbinary('RETR source.txt', f.write, blocksize=1024)

---

RetrLines

---

SendCmd

The sendcmd() method sends an FTP command and returns the response as a string.

---

Set_DebugLevel

---

Set_Pasv

---

StorBinary

The storbinary method is a low-level file download interface. The first argument should be a valid STOR command. The second argument is a binary file object. If a blocksize is not specified, 8192 is the default.

Try:

with open('source.txt', 'b') as f:
    ftp.storbinary('STOR source.txt', f)

---

StorLines

---

TransferCmd

---

VoidCmd

The voidcmd() method sends an FTP command. If a response outside of 200-299 is received, an ftplib.error_reply is raised.

---

Ftp_Tls

A subclass of ftplib.FTP with additional methods and properties.

---

Exceptions

---

See also

Python ftplib module documentation

---

CategoryRicottone