Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | |
| 2 | :mod:`ftplib` --- FTP protocol client |
| 3 | ===================================== |
| 4 | |
| 5 | .. module:: ftplib |
| 6 | :synopsis: FTP protocol client (requires sockets). |
| 7 | |
| 8 | |
| 9 | .. index:: |
| 10 | pair: FTP; protocol |
| 11 | single: FTP; ftplib (standard module) |
| 12 | |
| 13 | This module defines the class :class:`FTP` and a few related items. The |
| 14 | :class:`FTP` class implements the client side of the FTP protocol. You can use |
| 15 | this to write Python programs that perform a variety of automated FTP jobs, such |
| 16 | as mirroring other ftp servers. It is also used by the module :mod:`urllib` to |
| 17 | handle URLs that use FTP. For more information on FTP (File Transfer Protocol), |
| 18 | see Internet :rfc:`959`. |
| 19 | |
| 20 | Here's a sample session using the :mod:`ftplib` module:: |
| 21 | |
| 22 | >>> from ftplib import FTP |
| 23 | >>> ftp = FTP('ftp.cwi.nl') # connect to host, default port |
| 24 | >>> ftp.login() # user anonymous, passwd anonymous@ |
| 25 | >>> ftp.retrlines('LIST') # list directory contents |
| 26 | total 24418 |
| 27 | drwxrwsr-x 5 ftp-usr pdmaint 1536 Mar 20 09:48 . |
| 28 | dr-xr-srwt 105 ftp-usr pdmaint 1536 Mar 21 14:32 .. |
| 29 | -rw-r--r-- 1 ftp-usr pdmaint 5305 Mar 20 09:48 INDEX |
| 30 | . |
| 31 | . |
| 32 | . |
| 33 | >>> ftp.retrbinary('RETR README', open('README', 'wb').write) |
| 34 | '226 Transfer complete.' |
| 35 | >>> ftp.quit() |
| 36 | |
| 37 | The module defines the following items: |
| 38 | |
| 39 | |
| 40 | .. class:: FTP([host[, user[, passwd[, acct[, timeout]]]]]) |
| 41 | |
| 42 | Return a new instance of the :class:`FTP` class. When *host* is given, the |
| 43 | method call ``connect(host)`` is made. When *user* is given, additionally the |
| 44 | method call ``login(user, passwd, acct)`` is made (where *passwd* and *acct* |
| 45 | default to the empty string when not given). The optional *timeout* parameter |
| 46 | specifies a timeout in seconds for the connection attempt (if is not specified, |
| 47 | or passed as None, the global default timeout setting will be used). |
| 48 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 49 | |
| 50 | .. data:: all_errors |
| 51 | |
| 52 | The set of all exceptions (as a tuple) that methods of :class:`FTP` instances |
| 53 | may raise as a result of problems with the FTP connection (as opposed to |
| 54 | programming errors made by the caller). This set includes the four exceptions |
| 55 | listed below as well as :exc:`socket.error` and :exc:`IOError`. |
| 56 | |
| 57 | |
| 58 | .. exception:: error_reply |
| 59 | |
| 60 | Exception raised when an unexpected reply is received from the server. |
| 61 | |
| 62 | |
| 63 | .. exception:: error_temp |
| 64 | |
| 65 | Exception raised when an error code in the range 400--499 is received. |
| 66 | |
| 67 | |
| 68 | .. exception:: error_perm |
| 69 | |
| 70 | Exception raised when an error code in the range 500--599 is received. |
| 71 | |
| 72 | |
| 73 | .. exception:: error_proto |
| 74 | |
| 75 | Exception raised when a reply is received from the server that does not begin |
| 76 | with a digit in the range 1--5. |
| 77 | |
| 78 | |
| 79 | .. seealso:: |
| 80 | |
| 81 | Module :mod:`netrc` |
| 82 | Parser for the :file:`.netrc` file format. The file :file:`.netrc` is typically |
| 83 | used by FTP clients to load user authentication information before prompting the |
| 84 | user. |
| 85 | |
| 86 | .. index:: single: ftpmirror.py |
| 87 | |
| 88 | The file :file:`Tools/scripts/ftpmirror.py` in the Python source distribution is |
| 89 | a script that can mirror FTP sites, or portions thereof, using the :mod:`ftplib` |
| 90 | module. It can be used as an extended example that applies this module. |
| 91 | |
| 92 | |
| 93 | .. _ftp-objects: |
| 94 | |
| 95 | FTP Objects |
| 96 | ----------- |
| 97 | |
| 98 | Several methods are available in two flavors: one for handling text files and |
| 99 | another for binary files. These are named for the command which is used |
| 100 | followed by ``lines`` for the text version or ``binary`` for the binary version. |
| 101 | |
| 102 | :class:`FTP` instances have the following methods: |
| 103 | |
| 104 | |
| 105 | .. method:: FTP.set_debuglevel(level) |
| 106 | |
| 107 | Set the instance's debugging level. This controls the amount of debugging |
| 108 | output printed. The default, ``0``, produces no debugging output. A value of |
| 109 | ``1`` produces a moderate amount of debugging output, generally a single line |
| 110 | per request. A value of ``2`` or higher produces the maximum amount of |
| 111 | debugging output, logging each line sent and received on the control connection. |
| 112 | |
| 113 | |
| 114 | .. method:: FTP.connect(host[, port[, timeout]]) |
| 115 | |
| 116 | Connect to the given host and port. The default port number is ``21``, as |
| 117 | specified by the FTP protocol specification. It is rarely needed to specify a |
| 118 | different port number. This function should be called only once for each |
| 119 | instance; it should not be called at all if a host was given when the instance |
| 120 | was created. All other methods can only be used after a connection has been |
| 121 | made. |
| 122 | |
| 123 | The optional *timeout* parameter specifies a timeout in seconds for the |
| 124 | connection attempt. If is not specified, or passed as None, the object timeout |
| 125 | is used (the timeout that you passed when instantiating the class); if the |
| 126 | object timeout is also None, the global default timeout setting will be used. |
| 127 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 128 | |
| 129 | .. method:: FTP.getwelcome() |
| 130 | |
| 131 | Return the welcome message sent by the server in reply to the initial |
| 132 | connection. (This message sometimes contains disclaimers or help information |
| 133 | that may be relevant to the user.) |
| 134 | |
| 135 | |
| 136 | .. method:: FTP.login([user[, passwd[, acct]]]) |
| 137 | |
| 138 | Log in as the given *user*. The *passwd* and *acct* parameters are optional and |
| 139 | default to the empty string. If no *user* is specified, it defaults to |
| 140 | ``'anonymous'``. If *user* is ``'anonymous'``, the default *passwd* is |
| 141 | ``'anonymous@'``. This function should be called only once for each instance, |
| 142 | after a connection has been established; it should not be called at all if a |
| 143 | host and user were given when the instance was created. Most FTP commands are |
| 144 | only allowed after the client has logged in. |
| 145 | |
| 146 | |
| 147 | .. method:: FTP.abort() |
| 148 | |
| 149 | Abort a file transfer that is in progress. Using this does not always work, but |
| 150 | it's worth a try. |
| 151 | |
| 152 | |
| 153 | .. method:: FTP.sendcmd(command) |
| 154 | |
| 155 | Send a simple command string to the server and return the response string. |
| 156 | |
| 157 | |
| 158 | .. method:: FTP.voidcmd(command) |
| 159 | |
| 160 | Send a simple command string to the server and handle the response. Return |
| 161 | nothing if a response code in the range 200--299 is received. Raise an exception |
| 162 | otherwise. |
| 163 | |
| 164 | |
| 165 | .. method:: FTP.retrbinary(command, callback[, maxblocksize[, rest]]) |
| 166 | |
| 167 | Retrieve a file in binary transfer mode. *command* should be an appropriate |
| 168 | ``RETR`` command: ``'RETR filename'``. The *callback* function is called for |
| 169 | each block of data received, with a single string argument giving the data |
| 170 | block. The optional *maxblocksize* argument specifies the maximum chunk size to |
| 171 | read on the low-level socket object created to do the actual transfer (which |
| 172 | will also be the largest size of the data blocks passed to *callback*). A |
| 173 | reasonable default is chosen. *rest* means the same thing as in the |
| 174 | :meth:`transfercmd` method. |
| 175 | |
| 176 | |
| 177 | .. method:: FTP.retrlines(command[, callback]) |
| 178 | |
Christian Heimes | af98da1 | 2008-01-27 15:18:18 +0000 | [diff] [blame^] | 179 | Retrieve a file or directory listing in ASCII transfer mode. *command* |
| 180 | should be an appropriate ``RETR`` command (see :meth:`retrbinary`) or a |
| 181 | command such as ``LIST``, ``NLST`` or ``MLSD`` (usually just the string |
| 182 | ``'LIST'``). The *callback* function is called for each line, with the |
| 183 | trailing CRLF stripped. The default *callback* prints the line to |
| 184 | ``sys.stdout``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 185 | |
| 186 | |
| 187 | .. method:: FTP.set_pasv(boolean) |
| 188 | |
| 189 | Enable "passive" mode if *boolean* is true, other disable passive mode. (In |
| 190 | Python 2.0 and before, passive mode was off by default; in Python 2.1 and later, |
| 191 | it is on by default.) |
| 192 | |
| 193 | |
Christian Heimes | af98da1 | 2008-01-27 15:18:18 +0000 | [diff] [blame^] | 194 | .. method:: FTP.storbinary(command, file[, blocksize, callback]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 195 | |
| 196 | Store a file in binary transfer mode. *command* should be an appropriate |
| 197 | ``STOR`` command: ``"STOR filename"``. *file* is an open file object which is |
| 198 | read until EOF using its :meth:`read` method in blocks of size *blocksize* to |
| 199 | provide the data to be stored. The *blocksize* argument defaults to 8192. |
Christian Heimes | af98da1 | 2008-01-27 15:18:18 +0000 | [diff] [blame^] | 200 | *callback* is an optional single parameter callable that is called |
| 201 | on each block of data after it is sent. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 202 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 203 | |
Christian Heimes | af98da1 | 2008-01-27 15:18:18 +0000 | [diff] [blame^] | 204 | .. method:: FTP.storlines(command, file[, callback]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 205 | |
| 206 | Store a file in ASCII transfer mode. *command* should be an appropriate |
| 207 | ``STOR`` command (see :meth:`storbinary`). Lines are read until EOF from the |
| 208 | open file object *file* using its :meth:`readline` method to provide the data to |
Christian Heimes | af98da1 | 2008-01-27 15:18:18 +0000 | [diff] [blame^] | 209 | be stored. *callback* is an optional single parameter callable |
| 210 | that is called on each line after it is sent. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 211 | |
| 212 | |
| 213 | .. method:: FTP.transfercmd(cmd[, rest]) |
| 214 | |
| 215 | Initiate a transfer over the data connection. If the transfer is active, send a |
| 216 | ``EPRT`` or ``PORT`` command and the transfer command specified by *cmd*, and |
| 217 | accept the connection. If the server is passive, send a ``EPSV`` or ``PASV`` |
| 218 | command, connect to it, and start the transfer command. Either way, return the |
| 219 | socket for the connection. |
| 220 | |
| 221 | If optional *rest* is given, a ``REST`` command is sent to the server, passing |
| 222 | *rest* as an argument. *rest* is usually a byte offset into the requested file, |
| 223 | telling the server to restart sending the file's bytes at the requested offset, |
| 224 | skipping over the initial bytes. Note however that RFC 959 requires only that |
| 225 | *rest* be a string containing characters in the printable range from ASCII code |
| 226 | 33 to ASCII code 126. The :meth:`transfercmd` method, therefore, converts |
| 227 | *rest* to a string, but no check is performed on the string's contents. If the |
| 228 | server does not recognize the ``REST`` command, an :exc:`error_reply` exception |
| 229 | will be raised. If this happens, simply call :meth:`transfercmd` without a |
| 230 | *rest* argument. |
| 231 | |
| 232 | |
| 233 | .. method:: FTP.ntransfercmd(cmd[, rest]) |
| 234 | |
| 235 | Like :meth:`transfercmd`, but returns a tuple of the data connection and the |
| 236 | expected size of the data. If the expected size could not be computed, ``None`` |
| 237 | will be returned as the expected size. *cmd* and *rest* means the same thing as |
| 238 | in :meth:`transfercmd`. |
| 239 | |
| 240 | |
| 241 | .. method:: FTP.nlst(argument[, ...]) |
| 242 | |
| 243 | Return a list of files as returned by the ``NLST`` command. The optional |
| 244 | *argument* is a directory to list (default is the current server directory). |
| 245 | Multiple arguments can be used to pass non-standard options to the ``NLST`` |
| 246 | command. |
| 247 | |
| 248 | |
| 249 | .. method:: FTP.dir(argument[, ...]) |
| 250 | |
| 251 | Produce a directory listing as returned by the ``LIST`` command, printing it to |
| 252 | standard output. The optional *argument* is a directory to list (default is the |
| 253 | current server directory). Multiple arguments can be used to pass non-standard |
| 254 | options to the ``LIST`` command. If the last argument is a function, it is used |
| 255 | as a *callback* function as for :meth:`retrlines`; the default prints to |
| 256 | ``sys.stdout``. This method returns ``None``. |
| 257 | |
| 258 | |
| 259 | .. method:: FTP.rename(fromname, toname) |
| 260 | |
| 261 | Rename file *fromname* on the server to *toname*. |
| 262 | |
| 263 | |
| 264 | .. method:: FTP.delete(filename) |
| 265 | |
| 266 | Remove the file named *filename* from the server. If successful, returns the |
| 267 | text of the response, otherwise raises :exc:`error_perm` on permission errors or |
| 268 | :exc:`error_reply` on other errors. |
| 269 | |
| 270 | |
| 271 | .. method:: FTP.cwd(pathname) |
| 272 | |
| 273 | Set the current directory on the server. |
| 274 | |
| 275 | |
| 276 | .. method:: FTP.mkd(pathname) |
| 277 | |
| 278 | Create a new directory on the server. |
| 279 | |
| 280 | |
| 281 | .. method:: FTP.pwd() |
| 282 | |
| 283 | Return the pathname of the current directory on the server. |
| 284 | |
| 285 | |
| 286 | .. method:: FTP.rmd(dirname) |
| 287 | |
| 288 | Remove the directory named *dirname* on the server. |
| 289 | |
| 290 | |
| 291 | .. method:: FTP.size(filename) |
| 292 | |
| 293 | Request the size of the file named *filename* on the server. On success, the |
| 294 | size of the file is returned as an integer, otherwise ``None`` is returned. |
| 295 | Note that the ``SIZE`` command is not standardized, but is supported by many |
| 296 | common server implementations. |
| 297 | |
| 298 | |
| 299 | .. method:: FTP.quit() |
| 300 | |
| 301 | Send a ``QUIT`` command to the server and close the connection. This is the |
| 302 | "polite" way to close a connection, but it may raise an exception of the server |
| 303 | reponds with an error to the ``QUIT`` command. This implies a call to the |
| 304 | :meth:`close` method which renders the :class:`FTP` instance useless for |
| 305 | subsequent calls (see below). |
| 306 | |
| 307 | |
| 308 | .. method:: FTP.close() |
| 309 | |
| 310 | Close the connection unilaterally. This should not be applied to an already |
| 311 | closed connection such as after a successful call to :meth:`quit`. After this |
| 312 | call the :class:`FTP` instance should not be used any more (after a call to |
| 313 | :meth:`close` or :meth:`quit` you cannot reopen the connection by issuing |
| 314 | another :meth:`login` method). |
| 315 | |