【Python】ftplib的使用

仅描述基础要点，备忘。

python自带ftplib库，可实现ftp读写。

1 要点

• ftp未使用默认端口21时，需显示指定端口。
• ftp路径带有中文，可能需要设置ftp的encoding属性为 gbk。
• ftplib不支持递归创建目录，需手动创建层级目录。

2 代码

2.1 下载文件

import os
from ftplib import FTP

ftp_server = '192.168.162.128'
ftp_port = 31  # FTP默认端口是21
uname = 'test'
upwd= 'test'
# 匿名访问是 用户名是anonymous， 密码随便填写

remote_file_path = '/haha/hi.txt'
local_file_path = os.path.join(os.getcwd(), 'hi.txt')  # 与脚本同目录

ftp = FTP()
try:
    ftp.connect(host=ftp_server, port=ftp_port)
    ftp.encoding = 'gbk'  # 国内可能需要 若ftp路径有中文
    ftp.login(user=uname, passwd=upwd)
    ftp.set_pasv(True)  # 切换到被动模式（大多数情况下需要）

    with open(local_file_path, 'wb') as file:
        ftp.retrbinary(f'RETR {remote_file_path}', file.write)
    print(f"文件已成功下载到 {local_file_path}")
except Exception as e:
    print(f"发生错误: {e}")

finally:
    ftp.quit()  # 断开连接

2.2 上传文件

    remote_file = '/202406/hk/hi.txt'
    local_file= os.path.join(os.getcwd(), 'hi.txt')

    with open(local_file, 'rb') as file:
        ftp.storbinary(f'STOR {remote_file }', file)

2.3 逐级创建目录

因ftplib不支持递归创建目录，需手动创建层级目录。

# 注意此函数只传入 目录，不能传入文件的全路径
# 若传入如 /path/my.txt 其会创建 path 及子目录 my.txt
# 即其将 my.txt 也认为是目录名
def ensure_dir(ftp, path):
    parts = path.strip('/').split('/')  # 去除首尾的/，再将路径分隔
    current_path = '/'  # 记录当前路径
    
    for part in parts:
        # 构建下一个目录路径
        current_path = current_path + part + '/'
        try:
            # 尝试列出目录的内容
            ftp.dir(current_path)
        except error_perm as e:
            try:
                ftp.mkd(current_path)
                print(f"目录 '{current_path}' 创建成功。")
            except error_perm as e:
                print(f"创建目录 '{current_path}' 失败：{e}")

3 整合成独立类

# -*- coding: utf-8 -*-
import os
from ftplib import FTP, error_perm

class FtpTool():
    def __init__(self):
        self.ftp = FTP()

    def conn(self, ftp_server, ftp_port, uname, upwd, encoding):
        try:
            self.ftp.encoding = encoding
            self.ftp.connect(host=ftp_server, port=ftp_port)
            print(self.ftp.getwelcome())
            self.ftp.login(user=uname, passwd=upwd)
            self.ftp.set_pasv(True)  # 切换到被动模式（大多数情况下需要）
        except Exception as e:
            print(f"发生错误: {e}")
            if self.ftp: self.ftp.quit()  # 断开连接

    def getFtpObj(self):
        return self.ftp

    def close(self):
        if self.ftp:
            self.ftp.quit()

    # 这里也可以扩展为将 wb 作为参数
    def download(self, remote_file_path, local_file_path):
        # 下载文件
        try:
            with open(local_file_path, 'wb') as file:
                self.ftp.retrbinary(f'RETR {remote_file_path}', file.write)
            print(f"文件已成功下载到 {local_file_path}")
        except Exception as e:
            print(f"下载发生错误: {e}")
        # 根据需要解开注释，我这里是最后统一断开连接
        # finally:
        #     if self.ftp: self.ftp.quit()

    def uploadAndMkdir(self, upload_file_path, local_file_path):
        # 上传文件并创建所需目录
        # 注意：ftplib不会自动递归创建目录，需手动创建
        dir_path = os.path.dirname(upload_file_path)
        self.ensure_dir(dir_path)
        try:
            with open(local_file_path, 'rb') as file:
                self.ftp.storbinary(f'STOR {upload_file_path}', file)
        except Exception as e:
            print(f"发生错误: {e}")
        # 根据需要解开注释，我这里是最后统一断开连接
        # finally:
        #     if self.ftp: self.ftp.quit()  # 断开连接

    def ensure_dir(self, path):
        """ 检测ftp目录是否存在并创建 """
        # path: ftp.hi.com/haha/hehe/enen -> dir:haha,hehe,enen
        # path: ftp.hi.com/haha/hehe.txt  -> dir:haha,hehe.txt  错误用法

        parts = path.strip('/').split('/')  # 去除首尾的/，再将路径分隔
        current_path = '/'  # 记录当前路径
        
        for part in parts:
            # 构建下一个目录路径
            current_path = current_path + part + '/'
            try:
                # 尝试列出目录的内容
                self.ftp.dir(current_path)
            except error_perm as e:
                try:
                    self.ftp.mkd(current_path)
                    print(f"目录 '{current_path}' 创建成功。")
                except error_perm as e:
                    print(f"创建目录 '{current_path}' 失败：{e}")

if __name__ == '__main__':
    # 在这里测试
    print('hello')
    ftp_server = '192.168.162.128'
    ftp_port = 31  # FTP默认端口是21
    uname = 'qtest'
    upwd= 'qtest'
    encoding = 'GBK'

    remote_file_path = '/202406/yes/ok/123.xlsb'
    local_file_path = 'd:\\haha.xlsb'

    ftool = FtpTool()
    ftool.conn(ftp_server, ftp_port, uname, upwd, encoding)

    # 1 打印当前目录下全部文件
    files = ftool.getFtpObj().retrlines('LIST')  # 使用原始ftp对象的retrlines函数
    print("Files in directory:")
    for file in files:
        print(file)

    # 2 下载文件
    ftool.download(remote_file_path, local_file_path)

    # 3 上传到新目录
    upload_file_path = 'sa/ku/la/1235.txt'
    local_file_path = 'D:\\456.txt'
    ftool.uploadAndMkdir(upload_file_path, local_file_path)

    # 最后所有任务结束后，手动统一断开连接
    ftool.close()