ftplib
http.client — HTTP 协议客户端
http.client
源代码： Lib/ftplib.py
此模块定义类 FTP 和一些相关项。 FTP 类实现 FTP 协议的客户端侧。可以使用这编写 Python 程序履行各种自动 FTP 作业 (譬如：镜像其它 FTP 服务器)。它还可用于模块 urllib.request to handle URLs that use FTP. For more information on FTP (File Transfer Protocol), see internet RFC 959 .
FTP
urllib.request
默认编码为 UTF-8，遵循 RFC 2640 .
可用性 ：非 Emscripten，非 WASI。
本模块不工作 (或不可用) 于 WebAssembly 平台 wasm32-emscripten and wasm32-wasi 。见 WebAssembly 平台 了解更多信息。
wasm32-emscripten
wasm32-wasi
这里的样本会话使用 ftplib 模块：
>>> from ftplib import FTP >>> ftp = FTP('ftp.us.debian.org') # connect to host, default port >>> ftp.login() # user anonymous, passwd anonymous@ '230 Login successful.' >>> ftp.cwd('debian') # change into "debian" directory '250 Directory successfully changed.' >>> ftp.retrlines('LIST') # list directory contents -rw-rw-r-- 1 1176 1176 1063 Jun 15 10:18 README ... drwxr-sr-x 5 1176 1176 4096 Dec 19 2000 pool drwxr-sr-x 4 1176 1176 4096 Nov 17 2008 project drwxr-xr-x 3 1176 1176 4096 Oct 10 2012 tools '226 Directory send OK.' >>> with open('README', 'wb') as fp: >>> ftp.retrbinary('RETR README', fp.write) '226 Transfer complete.' >>> ftp.quit() '221 Goodbye.'
返回新的实例化 FTP 类。
host ( str ) – The hostname to connect to. If given, connect(host) is implicitly called by the constructor.
connect(host)
user ( str ) – The username to log in with (default: 'anonymous' ). If given, login(host, passwd, acct) is implicitly called by the constructor.
'anonymous'
login(host, passwd, acct)
passwd ( str ) – The password to use when logging in. If not given, and if passwd is the empty string or "-" , a password will be automatically generated.
"-"
acct ( str ) – Account information to be used for the ACCT FTP command. Few systems implement this. See RFC-959 了解更多细节。
ACCT
timeout ( float | None ) – A timeout in seconds for blocking operations like connect() (default: the global default timeout setting).
connect()
source_address ( tuple | None ) – A 2-tuple (host, port) for the socket to bind to as its source address before connecting.
(host, port)
encoding ( str ) – The encoding for directories and filenames (default: 'utf-8' ).
'utf-8'
The FTP 类支持 with 语句，如：
with
>>> from ftplib import FTP >>> with FTP("ftp1.at.proftpd.org") as ftp: ... ftp.login() ... ftp.dir() ... '230 Anonymous login ok, restrictions apply.' dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 . dr-xr-xr-x 9 ftp ftp 154 May 6 10:43 .. dr-xr-xr-x 5 ftp ftp 4096 May 6 10:43 CentOS dr-xr-xr-x 3 ftp ftp 18 Jul 10 2008 Fedora >>>
3.2 版改变： 支持 with 语句被添加。
3.3 版改变： source_address 参数被添加。
3.9 版改变： 若 timeout 参数被设为 0，它将引发 ValueError to prevent the creation of a non-blocking socket. The encoding 参数被添加，且默认从 Latin-1 改为 UTF-8 遵循 RFC 2640 .
ValueError
几个 FTP methods are available in two flavors: one for handling text files and another for binary files. The methods are named for the command which is used followed by lines for the text version or binary 对于二进制版本。
lines
binary
FTP 实例具有下列方法：
Set the instance’s debugging level as an int . This controls the amount of debugging output printed. The debug levels are:
int
0 (default): No debug output.
0
1 : Produce a moderate amount of debug output, generally a single line per request.
1
2 or higher: Produce the maximum amount of debugging output, logging each line sent and received on the control connection.
2
Connect to the given host and port. This function should be called only once for each instance; it should not be called if a host argument was given when the FTP instance was created. All other FTP methods can only be called after a connection has successfully been made.
host ( str ) – The host to connect to.
port ( int ) – The TCP port to connect to (default: 21 , as specified by the FTP protocol specification). It is rarely needed to specify a different port number.
21
timeout ( float | None ) – A timeout in seconds for the connection attempt (default: the global default timeout setting).
引发 审计事件 ftplib.connect 采用自变量 self , host , port .
ftplib.connect
self
host
port
Return the welcome message sent by the server in reply to the initial connection. (This message sometimes contains disclaimers or help information that may be relevant to the user.)
Log on to the connected FTP server. This function should be called only once for each instance, after a connection has been established; it should not be called if the host and user arguments were given when the FTP instance was created. Most FTP commands are only allowed after the client has logged in.
user ( str ) – The username to log in with (default: 'anonymous' ).
Abort a file transfer that is in progress. Using this does not always work, but it’s worth a try.
Send a simple command string to the server and return the response string.
引发 审计事件 ftplib.sendcmd 采用自变量 self , cmd .
ftplib.sendcmd
cmd
Send a simple command string to the server and handle the response. Return the response string if the response code corresponds to success (codes in the range 200–299). Raise error_reply 否则。
error_reply
以二进制传输模式检索文件。
cmd ( str ) – An appropriate STOR 命令： "STOR filename" .
STOR
"STOR filename"
callback ( callable ) – A single parameter callable that is called for each block of data received, with its single argument being the data as bytes .
bytes
blocksize ( int ) – The maximum chunk size to read on the low-level socket object created to do the actual transfer. This also corresponds to the largest size of data that will be passed to callback 。默认为 8192 .
socket
8192
rest ( int ) – A REST command to be sent to the server. See the documentation for the rest 参数为 transfercmd() 方法。
REST
transfercmd()
Retrieve a file or directory listing in the encoding specified by the encoding parameter at initialization. cmd should be an appropriate RETR 命令 (见 retrbinary() ) or a command such as LIST or NLST (usually just the string 'LIST' ). LIST retrieves a list of files and information about those files. NLST retrieves a list of file names. The callback function is called for each line with a string argument containing the line with the trailing CRLF stripped. The default callback prints the line to sys.stdout .
RETR
retrbinary()
LIST
NLST
'LIST'
sys.stdout
Enable “passive” mode if val is true, otherwise disable passive mode. Passive mode is on by default.
以二进制传输模式存储文件。
fp ( 文件对象 ) – A file object (opened in binary mode) which is read until EOF, using its read() method in blocks of size blocksize to provide the data to be stored.
read()
blocksize ( int ) – The read block size. Defaults to 8192 .
callback ( callable ) – A single parameter callable that is called for each block of data sent, with its single argument being the data as bytes .
3.2 版改变： The rest 参数被添加。
以行模式存储文件。 cmd should be an appropriate STOR 命令 (见 storbinary() ). Lines are read until EOF from the 文件对象 fp (opened in binary mode) using its readline() method to provide the data to be stored. callback is an optional single parameter callable that is called on each line after it is sent.
storbinary()
readline()
Initiate a transfer over the data connection. If the transfer is active, send an EPRT or PORT command and the transfer command specified by cmd , and accept the connection. If the server is passive, send an EPSV or PASV command, connect to it, and start the transfer command. Either way, return the socket for the connection.
EPRT
PORT
EPSV
PASV
若可选 rest is given, a REST command is sent to the server, passing rest 作为自变量。 rest is usually a byte offset into the requested file, telling the server to restart sending the file’s bytes at the requested offset, skipping over the initial bytes. Note however that the transfercmd() method converts rest to a string with the encoding parameter specified at initialization, but no check is performed on the string’s contents. If the server does not recognize the REST 命令， error_reply exception will be raised. If this happens, simply call transfercmd() without a rest 自变量。
像 transfercmd() , but returns a tuple of the data connection and the expected size of the data. If the expected size could not be computed, None will be returned as the expected size. cmd and rest means the same thing as in transfercmd() .
None
以标准化格式列表目录通过使用 MLSD 命令 ( RFC 3659 )。若 path 被省略，假定当前目录。 facts is a list of strings representing the type of information desired (e.g. ["type", "size", "perm"] ). Return a generator object yielding a tuple of two elements for every file found in path. First element is the file name, the second one is a dictionary containing facts about the file name. Content of this dictionary might be limited by the facts argument but server is not guaranteed to return all requested facts.
MLSD
["type", "size", "perm"]
Added in version 3.3.
Return a list of file names as returned by the NLST 命令。可选 argument is a directory to list (default is the current server directory). Multiple arguments can be used to pass non-standard options to the NLST 命令。
注意
若服务器支持命令， mlsd() 提供了更好的 API。
mlsd()
Produce a directory listing as returned by the LIST command, printing it to standard output. The optional argument is a directory to list (default is the current server directory). Multiple arguments can be used to pass non-standard options to the LIST command. If the last argument is a function, it is used as a callback function as for retrlines() ；默认打印到 sys.stdout 。此方法返回 None .
retrlines()
重命名文件 fromname 在服务器到 toname .
Remove the file named filename from the server. If successful, returns the text of the response, otherwise raises error_perm on permission errors or error_reply on other errors.
error_perm
设置服务器中的当前目录。
在服务器中创建新的目录。
Return the pathname of the current directory on the server.
Remove the directory named dirname on the server.
Request the size of the file named filename on the server. On success, the size of the file is returned as an integer, otherwise None is returned. Note that the SIZE command is not standardized, but is supported by many common server implementations.
SIZE
发送 QUIT command to the server and close the connection. This is the “polite” way to close a connection, but it may raise an exception if the server responds with an error to the QUIT command. This implies a call to the close() method which renders the FTP instance useless for subsequent calls (see below).
QUIT
close()
Close the connection unilaterally. This should not be applied to an already closed connection such as after a successful call to quit() . After this call the FTP instance should not be used any more (after a call to close() or quit() you cannot reopen the connection by issuing another login() 方法)。
quit()
login()
An FTP 子类添加 TLS 支持到 FTP 作为描述在 RFC 4217 . Connect to port 21 implicitly securing the FTP control connection before authenticating.
The user must explicitly secure the data connection by calling the prot_p() 方法。
prot_p()
context ( ssl.SSLContext ) – An SSL context object which allows bundling SSL configuration options, certificates and private keys into a single, potentially long-lived, structure. Please read 安全注意事项 了解最佳实践。
ssl.SSLContext
Added in version 3.2.
3.3 版改变： 添加 source_address 参数。
3.4 版改变： 类现在支持主机名校验采用 ssl.SSLContext.check_hostname and SNI (服务器名称指示) (见 ssl.HAS_SNI ).
ssl.SSLContext.check_hostname
ssl.HAS_SNI
Changed in version 3.12: The deprecated keyfile and certfile parameters have been removed.
这里的样本会话使用 FTP_TLS 类：
FTP_TLS
>>> ftps = FTP_TLS('ftp.pureftpd.org') >>> ftps.login() '230 Anonymous user logged in' >>> ftps.prot_p() '200 Data protection level set to "private"' >>> ftps.nlst() ['6jack', 'OpenBSD', 'antilink', 'blogbench', 'bsdcam', 'clockspeed', 'djbdns-jedi', 'docs', 'eaccelerator-jedi', 'favicon.ico', 'francotone', 'fugu', 'ignore', 'libpuzzle', 'metalog', 'minidentd', 'misc', 'mysql-udf-global-user-variables', 'php-jenkins-hash', 'php-skein-hash', 'php-webdav', 'phpaudit', 'phpbench', 'pincaster', 'ping', 'posto', 'pub', 'public', 'public_keys', 'pure-ftpd', 'qscan', 'qtc', 'sharedance', 'skycache', 'sound', 'tmp', 'ucarp']
FTP_TLS 类继承自 FTP , defining these additional methods and attributes:
要使用的 SSL 版本 (默认为 ssl.PROTOCOL_SSLv23 ).
ssl.PROTOCOL_SSLv23
Set up a secure control connection by using TLS or SSL, depending on what is specified in the ssl_version 属性。
ssl_version
3.4 版改变： 方法现在支持主机名校验采用 ssl.SSLContext.check_hostname and SNI (服务器名称指示) (见 ssl.HAS_SNI ).
Revert control channel back to plaintext. This can be useful to take advantage of firewalls that know how to handle NAT with non-secure FTP without opening fixed ports.
建立安全数据连接。
建立明文数据连接。
Exception raised when an unexpected reply is received from the server.
Exception raised when an error code signifying a temporary error (response codes in the range 400–499) is received.
Exception raised when an error code signifying a permanent error (response codes in the range 500–599) is received.
Exception raised when a reply is received from the server that does not fit the response specifications of the File Transfer Protocol, i.e. begin with a digit in the range 1–5.
The set of all exceptions (as a tuple) that methods of FTP instances may raise as a result of problems with the FTP connection (as opposed to programming errors made by the caller). This set includes the four exceptions listed above as well as OSError and EOFError .
OSError
EOFError
另请参阅
netrc
Parser for the .netrc 文件格式。文件 .netrc is typically used by FTP clients to load user authentication information before prompting the user.
.netrc
poplib — POP3 协议客户端
poplib
键入搜索术语或模块、类、函数名称。