Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`ftplib` --- FTP protocol client |
| 2 | ===================================== |
| 3 | |
| 4 | .. module:: ftplib |
| 5 | :synopsis: FTP protocol client (requires sockets). |
| 6 | |
| 7 | |
| 8 | .. index:: |
| 9 | pair: FTP; protocol |
| 10 | single: FTP; ftplib (standard module) |
| 11 | |
| 12 | This module defines the class :class:`FTP` and a few related items. The |
| 13 | :class:`FTP` class implements the client side of the FTP protocol. You can use |
| 14 | this to write Python programs that perform a variety of automated FTP jobs, such |
Senthil Kumaran | aca8fd7 | 2008-06-23 04:41:59 +0000 | [diff] [blame] | 15 | as mirroring other ftp servers. It is also used by the module |
| 16 | :mod:`urllib.request` to handle URLs that use FTP. For more information on FTP |
| 17 | (File Transfer Protocol), see Internet :rfc:`959`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 18 | |
| 19 | Here's a sample session using the :mod:`ftplib` module:: |
| 20 | |
| 21 | >>> from ftplib import FTP |
| 22 | >>> ftp = FTP('ftp.cwi.nl') # connect to host, default port |
| 23 | >>> ftp.login() # user anonymous, passwd anonymous@ |
| 24 | >>> ftp.retrlines('LIST') # list directory contents |
| 25 | total 24418 |
| 26 | drwxrwsr-x 5 ftp-usr pdmaint 1536 Mar 20 09:48 . |
| 27 | dr-xr-srwt 105 ftp-usr pdmaint 1536 Mar 21 14:32 .. |
| 28 | -rw-r--r-- 1 ftp-usr pdmaint 5305 Mar 20 09:48 INDEX |
| 29 | . |
| 30 | . |
| 31 | . |
| 32 | >>> ftp.retrbinary('RETR README', open('README', 'wb').write) |
| 33 | '226 Transfer complete.' |
| 34 | >>> ftp.quit() |
| 35 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 36 | |
Benjamin Peterson | 5e55b3e | 2010-02-03 02:35:45 +0000 | [diff] [blame] | 37 | The module defines the following items: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 38 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 39 | .. class:: FTP(host='', user='', passwd='', acct=''[, timeout]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 40 | |
| 41 | Return a new instance of the :class:`FTP` class. When *host* is given, the |
Alexandre Vassalotti | 5f8ced2 | 2008-05-16 00:03:33 +0000 | [diff] [blame] | 42 | method call ``connect(host)`` is made. When *user* is given, additionally |
| 43 | the method call ``login(user, passwd, acct)`` is made (where *passwd* and |
| 44 | *acct* default to the empty string when not given). The optional *timeout* |
| 45 | parameter specifies a timeout in seconds for blocking operations like the |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 46 | connection attempt (if is not specified, the global default timeout setting |
| 47 | will be used). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 48 | |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 49 | :class:`FTP` class supports the :keyword:`with` statement. Here is a sample |
| 50 | on how using it: |
| 51 | |
| 52 | >>> from ftplib import FTP |
| 53 | >>> with FTP("ftp1.at.proftpd.org") as ftp: |
| 54 | ... ftp.login() |
| 55 | ... ftp.dir() |
| 56 | ... |
| 57 | '230 Anonymous login ok, restrictions apply.' |
| 58 | dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 . |
| 59 | dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .. |
| 60 | dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS |
| 61 | dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora |
| 62 | >>> |
| 63 | |
| 64 | .. versionchanged:: 3.2 |
| 65 | Support for the :keyword:`with` statement was added. |
| 66 | |
| 67 | |
Giampaolo Rodolà | a67299e | 2010-05-26 18:06:04 +0000 | [diff] [blame] | 68 | .. class:: FTP_TLS(host='', user='', passwd='', acct='', [keyfile[, certfile[, context[, timeout]]]]) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 69 | |
| 70 | A :class:`FTP` subclass which adds TLS support to FTP as described in |
| 71 | :rfc:`4217`. |
| 72 | Connect as usual to port 21 implicitly securing the FTP control connection |
Benjamin Peterson | 5e55b3e | 2010-02-03 02:35:45 +0000 | [diff] [blame] | 73 | before authenticating. Securing the data connection requires the user to |
| 74 | explicitly ask for it by calling the :meth:`prot_p` method. |
| 75 | *keyfile* and *certfile* are optional -- they can contain a PEM formatted |
| 76 | private key and certificate chain file name for the SSL connection. |
Giampaolo Rodolà | a67299e | 2010-05-26 18:06:04 +0000 | [diff] [blame] | 77 | *context* parameter is a :class:`ssl.SSLContext` object which allows |
| 78 | bundling SSL configuration options, certificates and private keys into a |
| 79 | single (potentially long-lived) structure. |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 80 | |
Benjamin Peterson | 5e55b3e | 2010-02-03 02:35:45 +0000 | [diff] [blame] | 81 | .. versionadded:: 3.2 |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 82 | |
Benjamin Peterson | 5e55b3e | 2010-02-03 02:35:45 +0000 | [diff] [blame] | 83 | Here's a sample session using the :class:`FTP_TLS` class: |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 84 | |
| 85 | >>> from ftplib import FTP_TLS |
| 86 | >>> ftps = FTP_TLS('ftp.python.org') |
Benjamin Peterson | 5e55b3e | 2010-02-03 02:35:45 +0000 | [diff] [blame] | 87 | >>> ftps.login() # login anonymously before securing control channel |
| 88 | >>> ftps.prot_p() # switch to secure data connection |
| 89 | >>> ftps.retrlines('LIST') # list directory content securely |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 90 | total 9 |
| 91 | drwxr-xr-x 8 root wheel 1024 Jan 3 1994 . |
| 92 | drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .. |
| 93 | drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin |
| 94 | drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc |
| 95 | d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming |
| 96 | drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib |
| 97 | drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub |
| 98 | drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr |
| 99 | -rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg |
| 100 | '226 Transfer complete.' |
| 101 | >>> ftps.quit() |
| 102 | >>> |
| 103 | |
| 104 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 105 | .. exception:: error_reply |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 106 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 107 | Exception raised when an unexpected reply is received from the server. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 108 | |
| 109 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 110 | .. exception:: error_temp |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 111 | |
Benjamin Peterson | 5e55b3e | 2010-02-03 02:35:45 +0000 | [diff] [blame] | 112 | Exception raised when an unexpected reply is received from the server. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 113 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 114 | .. exception:: error_perm |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 115 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 116 | Exception raised when an error code in the range 500--599 is received. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 117 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 118 | .. exception:: error_proto |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 119 | |
Benjamin Peterson | 5e55b3e | 2010-02-03 02:35:45 +0000 | [diff] [blame] | 120 | Exception raised when a reply is received from the server that does not |
| 121 | begin with a digit in the range 1--5. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 122 | |
Benjamin Peterson | 5e55b3e | 2010-02-03 02:35:45 +0000 | [diff] [blame] | 123 | .. data:: all_errors |
| 124 | |
| 125 | The set of all exceptions (as a tuple) that methods of :class:`FTP` |
| 126 | instances may raise as a result of problems with the FTP connection (as |
| 127 | opposed to programming errors made by the caller). This set includes the |
Georg Brandl | 8569e58 | 2010-05-19 20:57:08 +0000 | [diff] [blame] | 128 | four exceptions listed above as well as :exc:`socket.error` and |
Benjamin Peterson | 5e55b3e | 2010-02-03 02:35:45 +0000 | [diff] [blame] | 129 | :exc:`IOError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 130 | |
| 131 | .. seealso:: |
| 132 | |
| 133 | Module :mod:`netrc` |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 134 | Parser for the :file:`.netrc` file format. The file :file:`.netrc` is |
| 135 | typically used by FTP clients to load user authentication information |
| 136 | before prompting the user. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 137 | |
| 138 | .. index:: single: ftpmirror.py |
| 139 | |
| 140 | The file :file:`Tools/scripts/ftpmirror.py` in the Python source distribution is |
| 141 | a script that can mirror FTP sites, or portions thereof, using the :mod:`ftplib` |
| 142 | module. It can be used as an extended example that applies this module. |
| 143 | |
| 144 | |
| 145 | .. _ftp-objects: |
| 146 | |
| 147 | FTP Objects |
| 148 | ----------- |
| 149 | |
| 150 | Several methods are available in two flavors: one for handling text files and |
| 151 | another for binary files. These are named for the command which is used |
| 152 | followed by ``lines`` for the text version or ``binary`` for the binary version. |
| 153 | |
| 154 | :class:`FTP` instances have the following methods: |
| 155 | |
| 156 | |
| 157 | .. method:: FTP.set_debuglevel(level) |
| 158 | |
| 159 | Set the instance's debugging level. This controls the amount of debugging |
| 160 | output printed. The default, ``0``, produces no debugging output. A value of |
| 161 | ``1`` produces a moderate amount of debugging output, generally a single line |
| 162 | per request. A value of ``2`` or higher produces the maximum amount of |
| 163 | debugging output, logging each line sent and received on the control connection. |
| 164 | |
| 165 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 166 | .. method:: FTP.connect(host='', port=0[, timeout]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 167 | |
| 168 | Connect to the given host and port. The default port number is ``21``, as |
| 169 | specified by the FTP protocol specification. It is rarely needed to specify a |
| 170 | different port number. This function should be called only once for each |
| 171 | instance; it should not be called at all if a host was given when the instance |
| 172 | was created. All other methods can only be used after a connection has been |
| 173 | made. |
| 174 | |
| 175 | The optional *timeout* parameter specifies a timeout in seconds for the |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 176 | connection attempt. If no *timeout* is passed, the global default timeout |
| 177 | setting will be used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 178 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 179 | |
| 180 | .. method:: FTP.getwelcome() |
| 181 | |
| 182 | Return the welcome message sent by the server in reply to the initial |
| 183 | connection. (This message sometimes contains disclaimers or help information |
| 184 | that may be relevant to the user.) |
| 185 | |
| 186 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 187 | .. method:: FTP.login(user='anonymous', passwd='', acct='') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 188 | |
| 189 | Log in as the given *user*. The *passwd* and *acct* parameters are optional and |
| 190 | default to the empty string. If no *user* is specified, it defaults to |
| 191 | ``'anonymous'``. If *user* is ``'anonymous'``, the default *passwd* is |
| 192 | ``'anonymous@'``. This function should be called only once for each instance, |
| 193 | after a connection has been established; it should not be called at all if a |
| 194 | host and user were given when the instance was created. Most FTP commands are |
Benjamin Peterson | 8719ad5 | 2009-09-11 22:24:02 +0000 | [diff] [blame] | 195 | only allowed after the client has logged in. The *acct* parameter supplies |
| 196 | "accounting information"; few systems implement this. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 197 | |
| 198 | |
| 199 | .. method:: FTP.abort() |
| 200 | |
| 201 | Abort a file transfer that is in progress. Using this does not always work, but |
| 202 | it's worth a try. |
| 203 | |
| 204 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 205 | .. method:: FTP.sendcmd(cmd) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 206 | |
| 207 | Send a simple command string to the server and return the response string. |
| 208 | |
| 209 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 210 | .. method:: FTP.voidcmd(cmd) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 211 | |
| 212 | Send a simple command string to the server and handle the response. Return |
| 213 | nothing if a response code in the range 200--299 is received. Raise an exception |
| 214 | otherwise. |
| 215 | |
| 216 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 217 | .. method:: FTP.retrbinary(cmd, callback, blocksize=8192, rest=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 218 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 219 | Retrieve a file in binary transfer mode. *cmd* should be an appropriate |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 220 | ``RETR`` command: ``'RETR filename'``. The *callback* function is called for |
| 221 | each block of data received, with a single string argument giving the data |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 222 | block. The optional *blocksize* argument specifies the maximum chunk size to |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 223 | read on the low-level socket object created to do the actual transfer (which |
| 224 | will also be the largest size of the data blocks passed to *callback*). A |
| 225 | reasonable default is chosen. *rest* means the same thing as in the |
| 226 | :meth:`transfercmd` method. |
| 227 | |
| 228 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 229 | .. method:: FTP.retrlines(cmd, callback=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 230 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 231 | Retrieve a file or directory listing in ASCII transfer mode. *cmd* |
Christian Heimes | af98da1 | 2008-01-27 15:18:18 +0000 | [diff] [blame] | 232 | should be an appropriate ``RETR`` command (see :meth:`retrbinary`) or a |
| 233 | command such as ``LIST``, ``NLST`` or ``MLSD`` (usually just the string |
Georg Brandl | b3b96bd | 2010-07-30 07:03:39 +0000 | [diff] [blame] | 234 | ``'LIST'``). The *callback* function is called for each line with a |
| 235 | string argument containing the line with the trailing CRLF stripped. |
| 236 | The default *callback* prints the line to ``sys.stdout``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 237 | |
| 238 | |
| 239 | .. method:: FTP.set_pasv(boolean) |
| 240 | |
Georg Brandl | e6bcc91 | 2008-05-12 18:05:20 +0000 | [diff] [blame] | 241 | Enable "passive" mode if *boolean* is true, other disable passive mode. |
| 242 | Passive mode is on by default. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 243 | |
| 244 | |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 245 | .. method:: FTP.storbinary(cmd, file, blocksize=8192, callback=None, rest=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 246 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 247 | Store a file in binary transfer mode. *cmd* should be an appropriate |
Antoine Pitrou | 11cb961 | 2010-09-15 11:11:28 +0000 | [diff] [blame^] | 248 | ``STOR`` command: ``"STOR filename"``. *file* is an open :term:`file object` |
| 249 | which is read until EOF using its :meth:`read` method in blocks of size |
| 250 | *blocksize* to provide the data to be stored. The *blocksize* argument |
| 251 | defaults to 8192. *callback* is an optional single parameter callable that |
| 252 | is called on each block of data after it is sent. *rest* means the same thing |
| 253 | as in the :meth:`transfercmd` method. |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 254 | |
| 255 | .. versionchanged:: 3.2 |
| 256 | *rest* parameter added. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 257 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 258 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 259 | .. method:: FTP.storlines(cmd, file, callback=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 260 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 261 | Store a file in ASCII transfer mode. *cmd* should be an appropriate |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 262 | ``STOR`` command (see :meth:`storbinary`). Lines are read until EOF from the |
Antoine Pitrou | 11cb961 | 2010-09-15 11:11:28 +0000 | [diff] [blame^] | 263 | open :term:`file object` *file* using its :meth:`readline` method to provide |
| 264 | the data to be stored. *callback* is an optional single parameter callable |
Christian Heimes | af98da1 | 2008-01-27 15:18:18 +0000 | [diff] [blame] | 265 | that is called on each line after it is sent. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 266 | |
| 267 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 268 | .. method:: FTP.transfercmd(cmd, rest=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 269 | |
| 270 | Initiate a transfer over the data connection. If the transfer is active, send a |
| 271 | ``EPRT`` or ``PORT`` command and the transfer command specified by *cmd*, and |
| 272 | accept the connection. If the server is passive, send a ``EPSV`` or ``PASV`` |
| 273 | command, connect to it, and start the transfer command. Either way, return the |
| 274 | socket for the connection. |
| 275 | |
| 276 | If optional *rest* is given, a ``REST`` command is sent to the server, passing |
| 277 | *rest* as an argument. *rest* is usually a byte offset into the requested file, |
| 278 | telling the server to restart sending the file's bytes at the requested offset, |
| 279 | skipping over the initial bytes. Note however that RFC 959 requires only that |
| 280 | *rest* be a string containing characters in the printable range from ASCII code |
| 281 | 33 to ASCII code 126. The :meth:`transfercmd` method, therefore, converts |
| 282 | *rest* to a string, but no check is performed on the string's contents. If the |
| 283 | server does not recognize the ``REST`` command, an :exc:`error_reply` exception |
| 284 | will be raised. If this happens, simply call :meth:`transfercmd` without a |
| 285 | *rest* argument. |
| 286 | |
| 287 | |
Georg Brandl | 036490d | 2009-05-17 13:00:36 +0000 | [diff] [blame] | 288 | .. method:: FTP.ntransfercmd(cmd, rest=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 289 | |
| 290 | Like :meth:`transfercmd`, but returns a tuple of the data connection and the |
| 291 | expected size of the data. If the expected size could not be computed, ``None`` |
| 292 | will be returned as the expected size. *cmd* and *rest* means the same thing as |
| 293 | in :meth:`transfercmd`. |
| 294 | |
| 295 | |
| 296 | .. method:: FTP.nlst(argument[, ...]) |
| 297 | |
| 298 | Return a list of files as returned by the ``NLST`` command. The optional |
| 299 | *argument* is a directory to list (default is the current server directory). |
| 300 | Multiple arguments can be used to pass non-standard options to the ``NLST`` |
| 301 | command. |
| 302 | |
| 303 | |
| 304 | .. method:: FTP.dir(argument[, ...]) |
| 305 | |
| 306 | Produce a directory listing as returned by the ``LIST`` command, printing it to |
| 307 | standard output. The optional *argument* is a directory to list (default is the |
| 308 | current server directory). Multiple arguments can be used to pass non-standard |
| 309 | options to the ``LIST`` command. If the last argument is a function, it is used |
| 310 | as a *callback* function as for :meth:`retrlines`; the default prints to |
| 311 | ``sys.stdout``. This method returns ``None``. |
| 312 | |
| 313 | |
| 314 | .. method:: FTP.rename(fromname, toname) |
| 315 | |
| 316 | Rename file *fromname* on the server to *toname*. |
| 317 | |
| 318 | |
| 319 | .. method:: FTP.delete(filename) |
| 320 | |
| 321 | Remove the file named *filename* from the server. If successful, returns the |
| 322 | text of the response, otherwise raises :exc:`error_perm` on permission errors or |
| 323 | :exc:`error_reply` on other errors. |
| 324 | |
| 325 | |
| 326 | .. method:: FTP.cwd(pathname) |
| 327 | |
| 328 | Set the current directory on the server. |
| 329 | |
| 330 | |
| 331 | .. method:: FTP.mkd(pathname) |
| 332 | |
| 333 | Create a new directory on the server. |
| 334 | |
| 335 | |
| 336 | .. method:: FTP.pwd() |
| 337 | |
| 338 | Return the pathname of the current directory on the server. |
| 339 | |
| 340 | |
| 341 | .. method:: FTP.rmd(dirname) |
| 342 | |
| 343 | Remove the directory named *dirname* on the server. |
| 344 | |
| 345 | |
| 346 | .. method:: FTP.size(filename) |
| 347 | |
| 348 | Request the size of the file named *filename* on the server. On success, the |
| 349 | size of the file is returned as an integer, otherwise ``None`` is returned. |
| 350 | Note that the ``SIZE`` command is not standardized, but is supported by many |
| 351 | common server implementations. |
| 352 | |
| 353 | |
| 354 | .. method:: FTP.quit() |
| 355 | |
| 356 | Send a ``QUIT`` command to the server and close the connection. This is the |
Benjamin Peterson | f10a79a | 2008-10-11 00:49:57 +0000 | [diff] [blame] | 357 | "polite" way to close a connection, but it may raise an exception if the server |
Georg Brandl | 2ee470f | 2008-07-16 12:55:28 +0000 | [diff] [blame] | 358 | responds with an error to the ``QUIT`` command. This implies a call to the |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 359 | :meth:`close` method which renders the :class:`FTP` instance useless for |
| 360 | subsequent calls (see below). |
| 361 | |
| 362 | |
| 363 | .. method:: FTP.close() |
| 364 | |
| 365 | Close the connection unilaterally. This should not be applied to an already |
| 366 | closed connection such as after a successful call to :meth:`quit`. After this |
| 367 | call the :class:`FTP` instance should not be used any more (after a call to |
| 368 | :meth:`close` or :meth:`quit` you cannot reopen the connection by issuing |
| 369 | another :meth:`login` method). |
| 370 | |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 371 | |
| 372 | FTP_TLS Objects |
| 373 | --------------- |
| 374 | |
| 375 | :class:`FTP_TLS` class inherits from :class:`FTP`, defining these additional objects: |
| 376 | |
| 377 | .. attribute:: FTP_TLS.ssl_version |
| 378 | |
| 379 | The SSL version to use (defaults to *TLSv1*). |
| 380 | |
| 381 | .. method:: FTP_TLS.auth() |
| 382 | |
| 383 | Set up secure control connection by using TLS or SSL, depending on what specified in :meth:`ssl_version` attribute. |
| 384 | |
| 385 | .. method:: FTP_TLS.prot_p() |
| 386 | |
| 387 | Set up secure data connection. |
| 388 | |
| 389 | .. method:: FTP_TLS.prot_c() |
| 390 | |
| 391 | Set up clear text data connection. |
| 392 | |
| 393 | |