ftplib
index
/usr/lib/python2.2/ftplib.py

An FTP client class and some helper functions.
 
Based on RFC 959: File Transfer Protocol (FTP), by J. Postel and J. Reynolds
 
Example:
 
>>> from ftplib import FTP
>>> ftp = FTP('ftp.python.org') # connect to host, default port
>>> ftp.login() # default, i.e.: user anonymous, passwd user@hostname
'230 Guest login ok, access restrictions apply.'
>>> ftp.retrlines('LIST') # list directory contents
total 9
drwxr-xr-x   8 root     wheel        1024 Jan  3  1994 .
drwxr-xr-x   8 root     wheel        1024 Jan  3  1994 ..
drwxr-xr-x   2 root     wheel        1024 Jan  3  1994 bin
drwxr-xr-x   2 root     wheel        1024 Jan  3  1994 etc
d-wxrwxr-x   2 ftp      wheel        1024 Sep  5 13:43 incoming
drwxr-xr-x   2 root     wheel        1024 Nov 17  1993 lib
drwxr-xr-x   6 1094     wheel        1024 Sep 13 19:07 pub
drwxr-xr-x   3 root     wheel        1024 Jan  3  1994 usr
-rw-r--r--   1 root     root          312 Aug  1  1994 welcome.msg
'226 Transfer complete.'
>>> ftp.quit()
'221 Goodbye.'
>>>
 
A nice test that reveals some of the network dialogue would be:
python ftplib.py -d localhost -l -p -l

 
Modules
            
os
socket
string
sys
 
Classes
            
exceptions.Exception
Error
error_perm
error_proto
error_reply
error_temp
FTP
Netrc
 
class Error(exceptions.Exception)
      Exception raised when an error or invalid response is received
 
   Data and non-method functions defined here:
__doc__ = None
__module__ = 'ftplib'

Methods inherited from exceptions.Exception:
__getitem__(...)
__init__(...)
__str__(...)
 
class FTP
      An FTP client class.
 
To create a connection, call the class using these argument:
        host, user, passwd, acct
These are all strings, and have default value ''.
Then use connect() with optional host and port argument.
 
To download a file, use ftp.retrlines('RETR ' + filename),
or ftp.retrbinary() with slightly different arguments.
To upload a file, use ftp.storlines() or ftp.storbinary(),
which have an open file as argument (see their definitions
below for details).
The download/upload functions first issue appropriate TYPE
and PORT or PASV commands.
 
   Methods defined here:
__init__(self, host='', user='', passwd='', acct='')
# Initialization method (called by class instantiation).
# Initialize host to localhost, port to standard ftp port
# Optional arguments are host (for connect()),
# and user, passwd, acct (for login())
abort(self)
Abort a file transfer.  Uses out-of-band data.
This does not follow the procedure from the RFC to send Telnet
IP and Synch; that doesn't seem to work with the servers I've
tried.  Instead, just send the ABOR command as OOB data.
acct(self, password)
Send new account name.
close(self)
Close the connection without assuming anything about it.
connect(self, host='', port=0)
Connect to host.  Arguments are:
- host: hostname to connect to (string, default previous host)
- port: port to connect to (integer, default previous port)
cwd(self, dirname)
Change to a directory.
debug = set_debuglevel(self, level)
delete(self, filename)
Delete a file.
dir(self, *args)
List a directory in long form.
By default list current directory to stdout.
Optional last argument is callback function; all
non-empty arguments before it are concatenated to the
LIST command.  (This *should* only be used for a pathname.)
getline(self)
# Internal: return one line from the server, stripping CRLF.
# Raise EOFError if the connection is closed
getmultiline(self)
# Internal: get a response from the server, which may possibly
# consist of multiple lines.  Return a single string with no
# trailing CRLF.  If the response consists of multiple lines,
# these are separated by '\n' characters in the string
getresp(self)
# Internal: get a response from the server.
# Raise various errors if the response indicates an error
getwelcome(self)
Get the welcome message from the server.
(this is read and squirreled away by connect())
login(self, user='', passwd='', acct='')
Login, default anonymous.
makepasv(self)
makeport(self)
Create a new socket and send a PORT command for it.
mkd(self, dirname)
Make a directory, return its full pathname.
nlst(self, *args)
Return a list of files in a given directory (default the current).
ntransfercmd(self, cmd, rest=None)
Initiate a transfer over the data connection.
 
If the transfer is active, send a port command and the
transfer command, and accept the connection.  If the server is
passive, send a pasv command, connect to it, and start the
transfer command.  Either way, return the socket for the
connection and the expected size of the transfer.  The
expected size may be None if it could not be determined.
 
Optional `rest' argument can be a string that is sent as the
argument to a RESTART command.  This is essentially a server
marker used to tell the server to skip over any data up to the
given marker.
putcmd(self, line)
# Internal: send one command to the server (through putline())
putline(self, line)
# Internal: send one line to the server, appending CRLF
pwd(self)
Return current working directory.
quit(self)
Quit, and close the connection.
rename(self, fromname, toname)
Rename a file.
retrbinary(self, cmd, callback, blocksize=8192, rest=None)
Retrieve data in binary mode.
 
`cmd' is a RETR command.  `callback' is a callback function is
called for each block.  No more than `blocksize' number of
bytes will be read from the socket.  Optional `rest' is passed
to transfercmd().
 
A new port is created for you.  Return the response code.
retrlines(self, cmd, callback=None)
Retrieve data in line mode.
The argument is a RETR or LIST command.
The callback function (2nd argument) is called for each line,
with trailing CRLF stripped.  This creates a new port for you.
print_line() is the default callback.
rmd(self, dirname)
Remove a directory.
sanitize(self, s)
# Internal: "sanitize" a string for printing
sendcmd(self, cmd)
Send a command and return the response.
sendeprt(self, host, port)
Send a EPRT command with the current host and the given port number.
sendport(self, host, port)
Send a PORT command with the current host and the given
port number.
set_debuglevel(self, level)
Set the debugging level.
The required argument level means:
0: no debugging output (default)
1: print commands and responses but not body text etc.
2: also print raw lines read and sent before stripping CR/LF
set_pasv(self, val)
Use passive or active mode for data transfers.
With a false argument, use the normal PORT mode,
With a true argument, use the PASV command.
size(self, filename)
Retrieve the size of a file.
storbinary(self, cmd, fp, blocksize=8192)
Store a file in binary mode.
storlines(self, cmd, fp)
Store a file in line mode.
transfercmd(self, cmd, rest=None)
Like ntransfercmd() but returns only the socket.
voidcmd(self, cmd)
Send a command and expect a response beginning with '2'.
voidresp(self)
Expect a response beginning with '2'.

Data and non-method functions defined here:
__doc__ = 'An FTP client class.\n\n To create a connect...propriate TYPE\n and PORT or PASV commands.\n'
__module__ = 'ftplib'
debugging = 0
file = None
host = ''
passiveserver = 1
port = 21
sock = None
welcome = None
 
class Netrc
      Class to parse & provide access to 'netrc' format files.
 
See the netrc(4) man page for information on the file format.
 
WARNING: This class is obsolete -- use module netrc instead.
 
   Methods defined here:
__init__(self, filename=None)
get_account(self, host)
Returns login information for the named host.
 
The return value is a triple containing userid,
password, and the accounting field.
get_hosts(self)
Return a list of hosts mentioned in the .netrc file.
get_macro(self, macro)
Return a sequence of lines which define a named macro.
get_macros(self)
Return a list of all defined macro names.

Data and non-method functions defined here:
_Netrc__defacct = None
_Netrc__defpasswd = None
_Netrc__defuser = None
__doc__ = "Class to parse & provide access to 'netrc' form...is obsolete -- use module netrc instead.\n\n "
__module__ = 'ftplib'
 
class error_perm(Error)
       
  
Method resolution order:
error_perm
Error
exceptions.Exception

Data and non-method functions defined here:
__doc__ = None
__module__ = 'ftplib'

Methods inherited from exceptions.Exception:
__getitem__(...)
__init__(...)
__str__(...)
 
class error_proto(Error)
       
  
Method resolution order:
error_proto
Error
exceptions.Exception

Data and non-method functions defined here:
__doc__ = None
__module__ = 'ftplib'

Methods inherited from exceptions.Exception:
__getitem__(...)
__init__(...)
__str__(...)
 
class error_reply(Error)
       
  
Method resolution order:
error_reply
Error
exceptions.Exception

Data and non-method functions defined here:
__doc__ = None
__module__ = 'ftplib'

Methods inherited from exceptions.Exception:
__getitem__(...)
__init__(...)
__str__(...)
 
class error_temp(Error)
       
  
Method resolution order:
error_temp
Error
exceptions.Exception

Data and non-method functions defined here:
__doc__ = None
__module__ = 'ftplib'

Methods inherited from exceptions.Exception:
__getitem__(...)
__init__(...)
__str__(...)
 
Functions
            
ftpcp(source, sourcename, target, targetname='', type='I')
Copy file from one FTP-instance to another.
parse150(resp)
Parse the '150' response for a RETR request.
Returns the expected transfer size or None; size is not guaranteed to
be present in the 150 message.
parse227(resp)
Parse the '227' response for a PASV request.
Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)'
Return ('host.addr.as.numbers', port#) tuple.
parse229(resp, peer)
Parse the '229' response for a EPSV request.
Raises error_proto if it does not contain '(|||port|)'
Return ('host.addr.as.numbers', port#) tuple.
parse257(resp)
Parse the '257' response for a MKD or PWD request.
This is a response to a MKD or PWD request: a directory name.
Returns the directoryname in the 257 reply.
print_line(line)
Default retrlines callback to print a line.
test()
Test program.
Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
 
Data
             CRLF = '\r\n'
FTP_PORT = 21
MSG_OOB = 1
_150_re = None
_227_re = None
__all__ = ['FTP', 'Netrc']
__file__ = '/usr/lib/python2.2/ftplib.pyc'
__name__ = 'ftplib'
all_errors = (<class ftplib.Error>, <class socket.error>, <class exceptions.IOError>, <class exceptions.EOFError>)