ftplib --- FTP 協定用戶端¶
原始碼：Lib/ftplib.py
這個模組定義了 FTP 類別和一些相關的項目。FTP 類別實作了 FTP 協定的用戶端。你可以使用它來編寫能夠執行各種 FTP 自動作業的 Python 程式，例如鏡像 (mirror) 其他 FTP 伺服器。urllib.request 模組也使用它來處理使用 FTP 的 URL。有關 FTP（檔案傳輸協定）的更多資訊，請參閱 RFC 959。
預設編碼是 UTF-8，遵循 RFC 2640。
Availability：非 Emscripten、非 WASI。
此模組在 WebAssembly 平台 wasm32-emscripten 和 wasm32-wasi 上不起作用或無法使用。有關更多資訊，請參閱 WebAssembly 平台。
這是一個使用 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.'
此模組定義了以下項目：
- class ftplib.FTP(host='', user='', passwd='', acct='', timeout=None, source_address=None, *, encoding='utf-8')¶
回傳
FTP類別的新實例。當給定 host 時，會呼叫方法connect(host)。當給定 user 時，還會再呼叫方法login(user, passwd, acct)（其中 passwd 和 acct 在未給定時預設為空字串）。可選的 timeout 參數以秒為單位來為如連線嘗試等阻塞操作指定超時（如果未指定，將使用全域預設超時設定）。 source_address 是一個含兩元素的元組(host, port)，供 socket 在連線之前綁定到它的來源地址。 encoding 參數指定目錄和檔案名的編碼。>>> 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 參數設定為零，它將引發
ValueError以防止建立非阻塞 socket。新增了 encoding 參數，預設值從 Latin-1 更改為 UTF-8 以遵循 RFC 2640。
- FTP_TLS(host='', user='', passwd='', acct='', *, context=None,
- timeout=None, source_address=None, encoding='utf-8')
一個
FTP子類別，它如 RFC 4217 中所述地向 FTP 新增 TLS 支援。像往常一樣連線到連接埠 21，在身份驗證之前隱式保護 FTP 控制連線。保護資料連線需要使用者通過呼叫prot_p()方法明確請求。 context 是一個ssl.SSLContext物件，它允許將 SSL 配置選項、證書和私鑰捆綁到一個（可能長期存在的）結構中。最佳實踐請參閱 Security considerations。在 3.2 版新加入.
在 3.3 版的變更: 新增 source_address 參數。
在 3.4 版的變更: 該類別現在支援使用
ssl.SSLContext.check_hostname和 Server Name Indication 進行主機名 (hostname) 檢查（參見ssl.HAS_SNI）。在 3.9 版的變更: 如果 timeout 參數設定為零，它將引發
ValueError以防止建立非阻塞 socket。新增了 encoding 參數，預設值從 Latin-1 更改為 UTF-8 以遵循 RFC 2640。在 3.12 版的變更: The deprecated keyfile and certfile parameters have been removed.
這是一個使用
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']
- exception ftplib.error_reply¶
伺服器收到意外回覆時所引發的例外。
- exception ftplib.error_temp¶
當收到表示暫時錯誤的錯誤碼（400--499 範圍內的回應狀態碼）時引發的例外。
- exception ftplib.error_perm¶
當收到表示永久錯誤的錯誤碼（500--599 範圍內的回應狀態碼）時引發的例外。
- exception ftplib.error_proto¶
當從伺服器收到不符合檔案傳輸協定回應規範的回覆時引發例外，即 1--5 範圍內的數字開頭。
- ftplib.all_errors¶
FTP實例方法由於 FTP 連線問題（相對於呼叫者的程式錯誤）而可能引發的所有例外集合（元組形式）。該集合包括上面列出的四個例外以及OSError和EOFError。
也參考
netrc模組.netrc檔案格式的剖析器。.netrc檔案通常被 FTP 用戶端用來在提示使用者之前載入使用者身份驗證資訊。
FTP 物件¶
有大致分為兩個方向的多個可用方法：一種用於處理文本檔案 (text files)，另一種用於二進位檔案 (binary files)。這些以在文本檔案的 lines 或二進位檔案的 binary 前使用的命令命名。
FTP 實例具有以下方法：
- FTP.set_debuglevel(level)¶
設定實例的偵錯級別。這控制印出的偵錯訊息輸出量。預設值
0不產生偵錯輸出。1會產生適量的偵錯輸出，通常是每個請求輸出一行。2或更高的值會產生最大量的偵錯輸出，記錄發送和接收控制連線的每個步驟。
- FTP.connect(host='', port=0, timeout=None, source_address=None)¶
連線到給定的主機 (host) 和連接埠 (port)。預設連接埠號為由 FTP 協定規範指定的
21。通常不會需要指定不同的連接埠。每個實例只應呼叫此函式一次；如果在建立實例時有給定主機，則不應呼叫它。所有其他方法只能在建立連線後使用。可選的 timeout 參數指定連線嘗試的超時時間（以秒為單位）。如果沒有給定 timeout，將使用全域預設的超時設定。 source_address 是一個 2 元組(host, port)，供 socket 在連線之前綁定到它的來源地址。引發一個附帶引數
self、host、port的稽核事件ftplib.connect。在 3.3 版的變更: 新增 source_address 參數。
- FTP.getwelcome()¶
回傳伺服器為回應初始連線而發送的歡迎訊息。（此訊息有時會包含與使用者相關的免責聲明或幫助資訊。）
- FTP.login(user='anonymous', passwd='', acct='')¶
以給定的 user 身份登錄。passwd 和 acct 為可選參數，皆預設為空字串。如果未指定 user，則預設為
'anonymous'。如果 user 是'anonymous'，則預設的 passwd 會是'anonymous@'。在建立連接後，每個實例只應呼叫此函式一次；如果在建立實例時有給定主機和使用者，則根本不應呼叫它。大多數 FTP 命令僅在用戶端登錄後才允許使用。 acct 參數提供「帳戶資訊」，但很少有系統實作這一部分。
- FTP.abort()¶
中止正在進行的檔案傳輸。使用它並不是都會成功，但值得一試。
- FTP.voidcmd(cmd)¶
向伺服器發送一個簡單的命令字串並處理回應。如果收到代表成功的回應狀態碼（範圍為 200--299 的狀態碼），則不回傳任何內容，否則引發
error_reply。引發一個附帶引數
self、cmd的稽核事件ftplib.sendcmd。
- FTP.retrbinary(cmd, callback, blocksize=8192, rest=None)¶
以二進位傳輸模式取得檔案。 cmd 應是一個正確的
RETR命令：'RETR filename'。為接收到的每個資料區塊 (block) 呼叫 callback 函式，使用一個位元組引數代表資料區塊。可選的 blocksize 引數指定要在為執行實際傳輸而建立的低階 socket 物件上讀取的最大區塊的大小（這也是傳遞給 callback 的資料區塊中的最大大小）。會自動選擇一個合理的預設值。rest 與transfercmd()方法中的含義相同。
- FTP.retrlines(cmd, callback=None)¶
在初始化時以 encoding 參數指定的編碼來取得檔案或目錄列表。 cmd 要是一個正確的
RETR命令（見retrbinary()）或者一個像LIST或NLST的命令（通常只是字串'LIST')。LIST會取得檔案列表和這些檔案的相關資訊。NLST取得檔案名稱列表。會為每一行以一個字串引數呼叫 callback 函式，其引數包含已經刪除尾隨 CRLF 的一行。預設的 callback 會將各行印出到sys.stdout。
- FTP.set_pasv(val)¶
如果 val 為真，則啟用「被動」模式，否則禁用被動模式。被動模式預設開啟。
- FTP.storbinary(cmd, fp, blocksize=8192, callback=None, rest=None)¶
以二進位傳輸模式 (binary transfer mode) 儲存檔案。cmd 應該要是一個正確的
STOR命令："STOR filename"。 fp 是一個檔案物件 (file object) （以二進位模式打開），使用其read()方法以讀取資料為 blocksize 大小的資料區塊直到 EOF，以供儲存。 blocksize 引數預設為 8192。 callback 是一個可選的單參數可呼叫物件，會在每個區塊發送後呼叫。 rest 與transfercmd()方法中的含義相同。在 3.2 版的變更: 新增 rest 參數。
- FTP.storlines(cmd, fp, callback=None)¶
以行模式 (line mode) 儲存檔案。 cmd 應是一個正確的
STOR命令（參見storbinary()）。使用其readline()方法從檔案物件 fp （以二進位模式打開）讀取各行、直到 EOF，以提供要儲存的資料。 callback 是可選的單參數可呼叫物件，於發送後以各行進行呼叫。
- FTP.transfercmd(cmd, rest=None)¶
通過資料連線啟動傳輸。如果傳輸為主動 (active) 模式，則發送
EPRT或PORT命令和 cmd 指定的傳輸命令，並接受連線。如果伺服器是被動 (passive) 模式，則發送EPSV或PASV命令、連線、並啟動傳輸命令。無論哪種方式，都是回傳連線的 socket。如果有給定可選的 rest，一個
REST命令會被發送到伺服器，並以 rest 作為引數。rest 通常是請求檔案的一個位元組偏移量 (byte offset)，告訴伺服器以請求的偏移量重新開始發送檔案的位元組，並跳過初始位元組。但是請注意，transfercmd()方法將 rest 轉換為帶有初始化時指定的 encoding 參數的字串，但不會對字串的內容執行檢查。如果伺服器無法識別REST命令，則會引發error_reply例外。如果發生這種情況，只需在沒有 rest 引數的情況下呼叫transfercmd()。
- FTP.ntransfercmd(cmd, rest=None)¶
類似於
transfercmd()，但回傳一個帶有資料連線和資料預期大小的元組。如果無法計算預期大小，則回傳None。 cmd 和 rest 與transfercmd()中的含義相同。
- FTP.mlsd(path='', facts=[])¶
使用
MLSD命令 (RFC 3659) 列出標準格式的目錄。如果省略 path 則假定為作用於當前目錄。facts 是表示所需資訊類型的字串列表（例如["type", "size", "perm"]）。會回傳一個產生器物件，為每個在路徑中找到的檔案生成一個包含兩個元素的元組，第一個元素是檔案名稱，第二個元素是包含有關檔案名稱 facts的字典。該字典的內容可能受 facts 引數限制，但不保證伺服器會回傳所有請求的 facts。在 3.3 版新加入.
- FTP.nlst(argument[, ...])¶
回傳由
NLST命令回傳的檔案名稱列表。可選的 argument 是要列出的目錄（預設為當前伺服器目錄）。多個引數可用於將非標準選項傳遞給NLST命令。備註
如果你的伺服器支援該命令，
mlsd()會提供更好的 API。
- FTP.dir(argument[, ...])¶
生成由
LIST命令回傳的目錄列表，並將其印出到標準輸出 (standard output)。可選的 argument 是要列出的目錄（預設為當前伺服器目錄）。有多個引數可用於將非標準選項傳遞給LIST命令。如果最後一個引數是一個函式，它被用作retrlines()的 callback 函式；預設印出到sys.stdout。此方法回傳None。備註
如果你的伺服器支援該命令，
mlsd()會提供更好的 API。
- FTP.rename(fromname, toname)¶
將伺服器上的檔案 fromname 重新命名為 toname。
- FTP.delete(filename)¶
從伺服器中刪除名為 filename 的檔案。如果成功，回傳回應的文字，否則引發
error_perm權限錯誤或在其他錯誤發生時引發error_reply。
- FTP.cwd(pathname)¶
設定伺服器上的當前目錄。
- FTP.mkd(pathname)¶
在伺服器上建立一個新目錄。
- FTP.pwd()¶
回傳伺服器上當前目錄的路徑名。
- FTP.rmd(dirname)¶
刪除伺服器上名為 dirname 的目錄。
- FTP.size(filename)¶
請求伺服器上名為 filename 的檔案的大小。成功時，檔案的大小作為整數回傳，否則回傳
None。請注意，SIZE命令不是標準化的，但被許多常見的伺服器實作支援。
FTP_TLS 物件¶
FTP_TLS 類別繼承自 FTP，並另外定義了這些的物件：
- FTP_TLS.ssl_version¶
要使用的 SSL 版本（預設為
ssl.PROTOCOL_SSLv23）。
- FTP_TLS.auth()¶
根據
ssl_version屬性中指定的內容，使用 TLS 或 SSL 設定安全控制連線。在 3.4 版的變更: 該方法現在支援使用
ssl.SSLContext.check_hostname和 Server Name Indication 進行主機名檢查（參見ssl.HAS_SNI）。
- FTP_TLS.ccc()¶
將控制通道恢復為純文本。這對於利用知道如何在不打開固定連接埠的情況下使用非安全 (non-secure) FTP 以處理 NAT 的防火牆很有用。
在 3.3 版新加入.
- FTP_TLS.prot_p()¶
設定安全資料連線。
- FTP_TLS.prot_c()¶
設定明文資料 (clear text data) 連線。