Lc @ s d Z d d k Z d d k Z y5 d d k Z e Z [ d d k l Z e e _ [ Wn e j
o d d k Z n Xd d k l Z d d g Z d Z d Z
d Z d
e f d YZ
d e
f d
YZ d e
f d YZ d e
f d YZ d e
f d YZ e
e e f Z d Z d f d YZ e a d Z e a d Z d Z d Z d Z d d d Z d f d YZ d Z! e" d j o e! n d S(! sS 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 anonymous@
'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
iN( t getfqdn( t _GLOBAL_DEFAULT_TIMEOUTt FTPt Netrci i i t Errorc B s e Z RS( ( t __name__t
__module__( ( ( s /usr/lib64/python2.6/ftplib.pyR > s t error_replyc B s e Z RS( ( R R ( ( ( s /usr/lib64/python2.6/ftplib.pyR ? s t
error_tempc B s e Z RS( ( R R ( ( ( s /usr/lib64/python2.6/ftplib.pyR @ s t
error_permc B s e Z RS( ( R R ( ( ( s /usr/lib64/python2.6/ftplib.pyR A s t error_protoc B s e Z RS( ( R R ( ( ( s /usr/lib64/python2.6/ftplib.pyR
B s s
c B s e Z d Z d Z d Z e Z e Z d, Z
d, Z d, Z d Z
d d d d e d Z d d d d Z d Z d Z e Z d Z d
Z d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d Z! d Z" d, d Z# d, d Z$ d d d d Z% d d, d Z& d, d Z' d d, d Z( d, d Z) d Z* d! Z+ d" Z, d# Z- d$ Z. d% Z/ d& Z0 d' Z1 d( Z2 d) Z3 d* Z4 d+ Z5 RS(- su An FTP client class.
To create a connection, call the class using these arguments:
host, user, passwd, acct, timeout
The first four arguments are all strings, and have default value ''.
timeout must be numeric and defaults to None if not passed,
meaning that no timeout will be set on any ftp socket(s)
If a timeout is passed, then this is now the default timeout for all ftp
socket operations for this instance.
Then use self.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.
i t i c C sC | | _ | o/ | i | | o | i | | | q? n d S( N( t timeoutt connectt login( t selft hostt usert passwdt acctR ( ( s /usr/lib64/python2.6/ftplib.pyt __init__s s
ic C s | d j o
| | _ n | d j o
| | _ n | d j o
| | _ n t i | i | i f | i | _ | i i | _ | i i d | _ | i
| _ | i S( s Connect to host. Arguments are:
- host: hostname to connect to (string, default previous host)
- port: port to connect to (integer, default previous port)
R i it rb( R t portR t sockett create_connectiont sockt familyt aft makefilet filet getrespt welcome( R R R R ( ( s /usr/lib64/python2.6/ftplib.pyR
{ s
$c C s* | i o d G| i | i GHn | i S( s` Get the welcome message from the server.
(this is read and squirreled away by connect())s *welcome*( t debuggingt sanitizeR ( R ( ( s /usr/lib64/python2.6/ftplib.pyt
getwelcome s
c C s
| | _ d S( s 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/LFN( R ( R t level( ( s /usr/lib64/python2.6/ftplib.pyt set_debuglevel s c C s
| | _ d S( s 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.N( t
passiveserver( R t val( ( s /usr/lib64/python2.6/ftplib.pyt set_pasv s c C s | d d j p | d d j ob t | } x1 | d j o# | | d d j o | d } q1 W| d d | d | | } n t | S( Ni s pass s PASS i s
t *( t lent repr( R t st i( ( s /usr/lib64/python2.6/ftplib.pyR! s " ""c C sD | t } | i d j o d G| i | GHn | i i | d S( Ni s *put*( t CRLFR R! R t sendall( R t line( ( s /usr/lib64/python2.6/ftplib.pyt putline s
c C s1 | i o d G| i | GHn | i | d S( Ns *cmd*( R R! R0 ( R R/ ( ( s /usr/lib64/python2.6/ftplib.pyt putcmd s
c C s | i i | i d } t | | i j o t d | i n | i d j o d G| i | GHn | p
t n | d t j o | d } n | d t j o | d } n | S( Ni s got more than %d bytess *get*ii( R t readlinet maxlineR) R R R! t EOFErrorR- ( R R/ ( ( s /usr/lib64/python2.6/ftplib.pyt getline s
c C s| | i } | d d !d j oX | d } xK | i } | d | } | d | j o | d d !d j o Pq- q- n | S( Ni i t -s
( R5 ( R R/ t codet nextline( ( s /usr/lib64/python2.6/ftplib.pyt getmultiline s
c C s | i } | i o d G| i | GHn | d | _ | d } | d j o | S| d j o
t | n | d j o
t | n t | d S(
Ns *resp*i i t 1t 2t 3t 4t 5( R: R; R< ( R9 R R! t lastrespR R R
( R t respt c( ( s /usr/lib64/python2.6/ftplib.pyR s
c C s. | i } | d d j o
t | n | S( s% Expect a response beginning with '2'.i R; ( R R ( R R@ ( ( s /usr/lib64/python2.6/ftplib.pyt voidresp s
c C sq d t } | i d j o d G| i | GHn | i i | t | i } | d d j o
t | n d S(
s 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.t ABORi s *put urgent*i t 426t 225t 226N( RD RE RF ( R- R R! R R. t MSG_OOBR9 R
( R R/ R@ ( ( s /usr/lib64/python2.6/ftplib.pyt abort s
c C s | i | | i S( s' Send a command and return the response.( R1 R ( R t cmd( ( s /usr/lib64/python2.6/ftplib.pyt sendcmd s
c C s | i | | i S( s8 Send a command and expect a response beginning with '2'.( R1 RB ( R RI ( ( s /usr/lib64/python2.6/ftplib.pyt voidcmd s
c C sY | i d } t | d t | d g } | | } d d i | } | i | S( sU Send a PORT command with the current host and the given
port number.
t .i s PORT t ,( t splitR* t joinRK ( R R R t hbytest pbytest bytesRI ( ( s /usr/lib64/python2.6/ftplib.pyt sendport s
c C s d } | i t i j o
d } n | i t i j o
d } n | d j o
t d n d t | | t | d g } d d i | } | i | S( sD Send a EPRT command with the current host and the given port number.i i i s unsupported address familyR s EPRT t |( R R t AF_INETt AF_INET6R
R* RO RK ( R R R R t fieldsRI ( ( s /usr/lib64/python2.6/ftplib.pyt sendeprt s
!c C s] d } d } x t i d d | i t i d t i D]{ } | \ } } } } } y& t i | | | } | i | Wn6 t i j
o' } | o | i n d } q4 n XPq4 W| p t i | n | i d | i
d } | i i
d }
| i t i j o | i
|
| } n | i |
| } | i t j o | i | i n | S( s3 Create a new socket and send a PORT command for it.s! getaddrinfo returns an empty listi i N( t NoneR t getaddrinfoR t SOCK_STREAMt
AI_PASSIVEt bindt errort closet listent getsocknameR RU RS RX R R t
settimeout( R t msgR t resR t socktypet protot canonnamet saR R R@ ( ( s /usr/lib64/python2.6/ftplib.pyt makeport s2 (
c C sc | i t i j o t | i d \ } } n( t | i d | i i \ } } | | f S( Nt PASVt EPSV( R R RU t parse227RJ t parse229R t getpeername( R R R ( ( s /usr/lib64/python2.6/ftplib.pyt makepasv2 s 'c
C s d } | i o | i \ } } t i | | f | i } | d j o | i d | n | i | } | d d j o | i } n | d d j o
t | qcn | i } | d j o | i d | n | i | } | d d j o | i } n | d d j o
t | n | i
\ } } | i t j o | i | i n | d d j o t
| } n | | f S( s 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 REST command. This is essentially a server
marker used to tell the server to skip over any data up to the
given marker.
s REST %si R; R: i t 150N( RY R% Ro R R R RJ R R Ri t acceptR Rb t parse150(
R RI t restt sizeR R t connR@ R t sockaddr( ( s /usr/lib64/python2.6/ftplib.pyt ntransfercmd9 s2
c C s | i | | d S( s0 Like ntransfercmd() but returns only the socket.i ( Rw ( R RI Rs ( ( s /usr/lib64/python2.6/ftplib.pyt transfercmdk s c C s | p
d } n | p
d } n | p
d } n | d j o | d j o | d } n | i d | } | d d j o | i d | } n | d d j o | i d | } n | d d
j o
t | n | S( s Login, default anonymous.t anonymousR R6 s
anonymous@s USER i R< s PASS s ACCT R; ( R R6 ( RJ R ( R R R R R@ ( ( s /usr/lib64/python2.6/ftplib.pyR o s
i c C s^ | i d | i | | } x( | i | } | p Pn | | q" | i | i S( s Retrieve data in binary mode. A new port is created for you.
Args:
cmd: A RETR command.
callback: A single parameter callable to be called on each
block of data read.
blocksize: The maximum number of bytes to read from the
socket at one time. [default: 8192]
rest: Passed to transfercmd(). [default: None]
Returns:
The response code.
s TYPE I( RK Rx t recvR_ RB ( R RI t callbackt blocksizeRs Ru t data( ( s /usr/lib64/python2.6/ftplib.pyt
retrbinary s
c C s" | d
j o
t } n | i d } | i | } | i d } x | i | i d } t | | i j o t d | i n | i d j o d Gt
| GHn | p Pn | d t j o | d } n | d d j o | d } n | | qG | i | i | i
S( sn Retrieve data in line mode. A new port is created for you.
Args:
cmd: A RETR, LIST, NLST, or MLSD command.
callback: An optional single parameter callable that is called
for each line with the trailing CRLF stripped.
[default: print_line()]
Returns:
The response code.
s TYPE AR i s got more than %d bytesi s *retr*iis
N( RY t
print_lineRJ Rx R R2 R3 R) R R R* R- R_ RB ( R RI R{ R@ Ru t fpR/ ( ( s /usr/lib64/python2.6/ftplib.pyt retrlines s*
c C ss | i d | i | } x@ | i | } | p Pn | i | | o | | q q | i | i S( s Store a file in binary mode. A new port is created for you.
Args:
cmd: A STOR command.
fp: A file-like object with a read(num_bytes) method.
blocksize: The maximum data size to read from fp and send over
the connection at once. [default: 8192]
callback: An optional single parameter callable that is called on
on each block of data after it is sent. [default: None]
Returns:
The response code.
s TYPE I( RK Rx t readR. R_ RB ( R RI R R| R{ Ru t buf( ( s /usr/lib64/python2.6/ftplib.pyt
storbinary s
c C s | i d | i | } x | i | i d } t | | i j o t d | i n | p Pn | d t j o- | d t j o | d } n | t } n | i | | o | | q q | i | i S( sk Store a file in line mode. A new port is created for you.
Args:
cmd: A STOR command.
fp: A file-like object with a readline() method.
callback: An optional single parameter callable that is called on
on each line after it is sent. [default: None]
Returns:
The response code.
s TYPE Ai s got more than %d bytesii(
RK Rx R2 R3 R) R R- R. R_ RB ( R RI R R{ Ru R ( ( s /usr/lib64/python2.6/ftplib.pyt storlines s"
c C s d | } | i | S( s Send new account name.s ACCT ( RK ( R t passwordRI ( ( s /usr/lib64/python2.6/ftplib.pyR s
c G sB d } x | D] } | d | } q
Wg } | i | | i | S( sB Return a list of files in a given directory (default the current).t NLSTt ( R t append( R t argsRI t argt files( ( s /usr/lib64/python2.6/ftplib.pyt nlst s c G s d } d } | d o6 t | d t d j o | d | d } } n x' | D] } | o | d | } qT qT W| i | | d S( s 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.)t LISTiR R N( RY t typeR ( R R RI t funcR ( ( s /usr/lib64/python2.6/ftplib.pyt dir s ( c C sB | i d | } | d d j o
t | n | i d | S( s Rename a file.s RNFR i R< s RNTO ( RJ R RK ( R t fromnamet tonameR@ ( ( s /usr/lib64/python2.6/ftplib.pyt rename s
c C s6 | i d | } | d d j o | St | d S( s Delete a file.s DELE i t 250t 200N( R R ( RJ R ( R t filenameR@ ( ( s /usr/lib64/python2.6/ftplib.pyt delete s c C s | d j oL y | i d SWqp t j
o( } | i d d d j o qU qp Xn | d j o
d } n d | } | i | S( s Change to a directory.s ..t CDUPi i t 500R RL s CWD ( RK R R ( R t dirnameRc RI ( ( s /usr/lib64/python2.6/ftplib.pyt cwd s
c C sm | i d | } | d d j oE | d i } y t | SWqi t t f j
o t | SXn d S( s Retrieve the size of a file.s SIZE i t 213N( RJ t stript intt
OverflowErrort
ValueErrort long( R R R@ R+ ( ( s /usr/lib64/python2.6/ftplib.pyRt ( s c C s | i d | } t | S( s+ Make a directory, return its full pathname.s MKD ( RJ t parse257( R R R@ ( ( s /usr/lib64/python2.6/ftplib.pyt mkd3 s c C s | i d | S( s Remove a directory.s RMD ( RK ( R R ( ( s /usr/lib64/python2.6/ftplib.pyt rmd8 s c C s | i d } t | S( s! Return current working directory.t PWD( RJ R ( R R@ ( ( s /usr/lib64/python2.6/ftplib.pyt pwd< s c C s | i d } | i | S( s Quit, and close the connection.t QUIT( RK R_ ( R R@ ( ( s /usr/lib64/python2.6/ftplib.pyt quitA s
c C s< | i o. | i i | i i d | _ | _ n d S( s8 Close the connection without assuming anything about it.N( R R_ R RY ( R ( ( s /usr/lib64/python2.6/ftplib.pyR_ G s
N(6 R R t __doc__R R t FTP_PORTR t MAXLINER3 RY R R R R% R R R
R" R$ t debugR' R! R0 R1 R5 R9 R RB RH RJ RK RS RX Ri Ro Rw Rx R R~ R R R R R R R R R Rt R R R R R_ ( ( ( s /usr/lib64/python2.6/ftplib.pyR N sb
2
c C s | d d j o
t | n t d j o% d d k } | i d | i a n t i | } | p d S| i d } y t | SWn t t
f j
o t | SXd S( s 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.
i Rp iNs 150 .* \((\d+) bytes\)i ( R t _150_reRY t ret compilet
IGNORECASEt matcht groupR R R R ( R@ R t mR+ ( ( s /usr/lib64/python2.6/ftplib.pyRr Q s
c C s | d d j o
t | n t d j o d d k } | i d a n t i | } | p
t | n | i } d i | d } t | d d >t | d } | | f S(
s 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.i t 227iNs# (\d+),(\d+),(\d+),(\d+),(\d+),(\d+)RL i i i (
R t _227_reRY R R t searchR
t groupsRO R ( R@ R R t numbersR R ( ( s /usr/lib64/python2.6/ftplib.pyRl h s
"c C s | d d j o
t | n | i d } | d j o
t | n | i d | d } | d j o
t | n | | d | | d j o
t | n | | d | !i | | d } t | d j o
t | n | d } t | d } | | f S( s Parse the '229' response for a EPSV request.
Raises error_proto if it does not contain '(|||port|)'
Return ('host.addr.as.numbers', port#) tuple.i t 229t (i t )i i ( R t findR
RN R) R ( R@ t peert leftt rightt partsR R ( ( s /usr/lib64/python2.6/ftplib.pyRm | s
"
c C s | d d j o
t | n | d d !d j o d Sd } d } t | } xn | | j o` | | } | d } | d j o1 | | j p | | d j o Pn | d } n | | } qR W| S( s 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.i t 257i s "R i t "( R R) ( R@ R R, t nRA ( ( s /usr/lib64/python2.6/ftplib.pyR s"
c C s | GHd S( s+ Default retrlines callback to print a line.N( ( R/ ( ( s /usr/lib64/python2.6/ftplib.pyR s R t Ic C s | p
| } n d | } | i | | i | t | i d \ } } | i | | | i d | } | d d j o
t n | i d | } | d d
j o
t n | i | i d S( s+ Copy file from one FTP-instance to another.s TYPE Rj s STOR i t 125Rp s RETR N( R s 150( R s 150( RK Rl RJ RS R
RB ( t sourcet
sourcenamet targett
targetnameR t
sourcehostt
sourceportt treplyt sreply( ( s /usr/lib64/python2.6/ftplib.pyt ftpcp s
c B sP e Z d Z d Z d Z d Z d d Z d Z d Z d Z
d Z RS( s 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.
c C s | d j o= d t i j o t i i t i d d } qJ t d n h | _ h | _ t | d } d } x| i } | p Pn | o! | i
o | i | qt n% | o t | | i | Wt i d d d j o t i d d } t i d =n t i d } t | } | i | d } } } y t | } Wn4 t
j
o( | d j o t i i d q_nD Xy | i
| \ } } } Wn# t j
o t i i d n X| i | | | x t i d D] } | d d j o | i | d q| d d j o: d
} | d o | d | d } n | i | }
q| d j o | i | i q| i d
| t i i d qW| i d S( s Test program.
Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
-d dir
-l list
-p password
i i i s -ds -rR s5 Could not open account file -- using anonymous login.s$ No account -- using anonymous login.s -lt CWDR s -ps RETR i N( R) t syst argvt testR t exitRY R R$ R R t stderrt writeR t KeyErrorR R RJ R' R% R~ t stdoutR ( R t rcfileR t ftpt useridR R t netrcR RI R@ ( ( s /usr/lib64/python2.6/ftplib.pyR , sR
t __main__(# R R R t SOCKSR R t ImportErrorR t __all__RG R R t ExceptionR R R R R
R R4 t
all_errorsR- R RY R Rr R Rl Rm R R R R R R ( ( ( s /usr/lib64/python2.6/ftplib.pyt sL k 7