Vega strike Python Modules doc: ftplib Namespace Reference

All Data Structures Namespaces Files Functions Variables

Data Structures
class	Error

class	error_reply

class	error_temp

class	error_perm

class	error_proto

class	FTP

class	Netrc

Functions
def	parse150

def	parse227

def	parse229

def	parse257

def	print_line

def	ftpcp

def	test

Variables
list	__all__ = ["FTP","Netrc"]

int	MSG_OOB = 0x1

int	FTP_PORT = 21

tuple	all_errors = (Error, socket.error, IOError, EOFError)

string	CRLF = '\r\n'

	_150_re = None

	_227_re = None

Detailed Description

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

Function Documentation

def ftplib.ftpcp	(	source,
		sourcename,
		target,
		targetname = `''`,
		type = `'I'`
	)

Copy file from one FTP-instance to another.

Definition at line 636 of file ftplib.py.

References parse227().

 
 def ftpcp(source, sourcename, target, targetname = '', type = 'I'):
     '''Copy file from one FTP-instance to another.'''
     if not targetname: targetname = sourcename
     type = 'TYPE ' + type
     source.voidcmd(type)
     target.voidcmd(type)
     sourcehost, sourceport = parse227(source.sendcmd('PASV'))
     target.sendport(sourcehost, sourceport)
     # RFC 959: the user must "listen" [...] BEFORE sending the
     # transfer request.
     # So: STOR before RETR, because here the target is a "user".
     treply = target.sendcmd('STOR ' + targetname)
     if treply[:3] not in ('125', '150'): raise error_proto  # RFC 959
     sreply = source.sendcmd('RETR ' + sourcename)
     if sreply[:3] not in ('125', '150'): raise error_proto  # RFC 959
     source.voidresp()
     target.voidresp()
 

def ftplib.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.

Definition at line 543 of file ftplib.py.

 
 def 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.
     '''
     if resp[:3] != '150':
         raise error_reply, resp
     global _150_re
     if _150_re is None:
         import re
         _150_re = re.compile("150 .* \((\d+) bytes\)", re.IGNORECASE)
     m = _150_re.match(resp)
     if not m:
         return None
     s = m.group(1)
     try:
         return int(s)
     except (OverflowError, ValueError):
         return long(s)
 

def ftplib.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.

Definition at line 566 of file ftplib.py.

References dospath.join().

 
 def 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.'''
 
     if resp[:3] != '227':
         raise error_reply, resp
     global _227_re
     if _227_re is None:
         import re
         _227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)')
     m = _227_re.search(resp)
     if not m:
         raise error_proto, resp
     numbers = m.groups()
     host = '.'.join(numbers[:4])
     port = (int(numbers[4]) << 8) + int(numbers[5])
     return host, port
 

def ftplib.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.

Definition at line 586 of file ftplib.py.

References string.atoi(), string.find(), and string.split().

 
 def 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.'''
 
     if resp[:3] <> '229':
         raise error_reply, resp
     left = string.find(resp, '(')
     if left < 0: raise error_proto, resp
     right = string.find(resp, ')', left + 1)
     if right < 0:
         raise error_proto, resp # should contain '(|||port|)'
     if resp[left + 1] <> resp[right - 1]:
         raise error_proto, resp
     parts = string.split(resp[left + 1:right], resp[left+1])
     if len(parts) <> 5:
         raise error_proto, resp
     host = peer[0]
     port = string.atoi(parts[3])
     return host, port
 

def ftplib.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.

Definition at line 608 of file ftplib.py.

 
 def 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.'''
 
     if resp[:3] != '257':
         raise error_reply, resp
     if resp[3:5] != ' "':
         return '' # Not compliant to RFC 959, but UNIX ftpd does this
     dirname = ''
     i = 5
     n = len(resp)
     while i < n:
         c = resp[i]
         i = i+1
         if c == '"':
             if i >= n or resp[i] != '"':
                 break
             i = i+1
         dirname = dirname + c
     return dirname
 

def ftplib.test ( )

Test program.
Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...

Definition at line 762 of file ftplib.py.

 
 def test():
     '''Test program.
     Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...'''
 
     debugging = 0
     rcfile = None
     while sys.argv[1] == '-d':
         debugging = debugging+1
         del sys.argv[1]
     if sys.argv[1][:2] == '-r':
         # get name of alternate ~/.netrc file:
         rcfile = sys.argv[1][2:]
         del sys.argv[1]
     host = sys.argv[1]
     ftp = FTP(host)
     ftp.set_debuglevel(debugging)
     userid = passwd = acct = ''
     try:
         netrc = Netrc(rcfile)
     except IOError:
         if rcfile is not None:
             sys.stderr.write("Could not open account file"
                              " -- using anonymous login.")
     else:
         try:
             userid, passwd, acct = netrc.get_account(host)
         except KeyError:
             # no account for host
             sys.stderr.write(
                     "No account -- using anonymous login.")
     ftp.login(userid, passwd, acct)
     for file in sys.argv[2:]:
         if file[:2] == '-l':
             ftp.dir(file[2:])
         elif file[:2] == '-d':
             cmd = 'CWD'
             if file[2:]: cmd = cmd + ' ' + file[2:]
             resp = ftp.sendcmd(cmd)
         elif file == '-p':
             ftp.set_pasv(not ftp.passiveserver)
         else:
             ftp.retrbinary('RETR ' + file, \
                            sys.stdout.write, 1024)
     ftp.quit()
 

Data Structures

Functions

Variables

Detailed Description

Function Documentation

Variable Documentation