Python3: ftplib 模块 - FTP 客户端

深碍√TFBOYSˉ_ 2021-09-21 23:02 486阅读 0赞

本文链接: [https://blog.csdn.net/xietansheng/article/details/115558082][https_blog.csdn.net_xietansheng_article_details_115558082]

[Python3 学习笔记（目录）][Python3]

FTP 传输协议命令参考:

*  FTP 传输协议 RFC959: [https://tools.ietf.org/html/rfc959.html][https_tools.ietf.org_html_rfc959.html]
 *  FTP 命令: [http://www.nsftools.com/tips/RawFTP.htm][http_www.nsftools.com_tips_RawFTP.htm]
 *  FTP 命令: [https://en.wikipedia.org/wiki/List\_of\_FTP\_commands][https_en.wikipedia.org_wiki_List_of_FTP_commands]

FTP 协议客户端 Python Docs: [ftplib — FTP protocol client][ftplib _ FTP protocol client]

# 1. FTP #

ftplib.FTP 对象 Python Docs: [ftp-objects][]

`ftplib`模块实现了 FTP 协议相关的类和访问 FTP 的相关功能。

`ftplib.FTP`类:

# FTP 对象实例构造方法
    # 
    # host: 主机名, 如果提供, 则会使用默认端口自动连接 self.connect(host)
    # user: 用户名, 如果提供, 则会自动登录(连接成功后) self.login(user, passwd, acct)
    # passwd: 密码
    # timeout: 超时时间, 单位: 秒
    class ftplib.FTP(host="", user="", passwd="", 
                     acct="", timeout=None, source_address=None)
    
    
    # 连接 FTP 服务器
    FTP.connect(host="", port=0, timeout=None, source_address=None)
    
    # 连接成功后获取欢迎信息
    FTP.getwelcome()
    
    # 用户登录（连接成功后才能登录）, 默认为匿名登录
    FTP.login(user="anonymous", passwd="", acct="")
    
    # 退出 并 关闭连接（优雅的关闭）
    FTP.quit()
    
    # 关闭连接
    FTP.close()
    
    # 终止文件传输
    FTP.abort()
    
    # 设置调试级别, 值为 0/1/2
    # 0: 没有debug信息输出（默认）
    # 1: 打印命令和响应, 但不打印正文
    # 2: 打印原始的读取和发送信息
    FTP.set_debuglevel(level)
    
    
    
    # 发送简单的 FTP 协议命令, 并返回响应字符串, 例如: sendcmd("CWD /path")
    FTP.sendcmd(cmd)
    
    # 发送简单的 FTP 协议命令, 并返回响应, 如果非2开头的响应, 则抛出异常 error_reply
    FTP.voidcmd(cmd)
    
    # 是否启用「被动模式」, True 表示启用（默认）, False 表示禁用 
    FTP.set_pasv(val)
    
    
    
    # 以 ASCII 传输模式检索文件或目录列表。
    #
    # cmd 应为适当的 RETR 命令, 或类似 LIST / NLST 之类的命令,
    # LIST 检索文件列表以及有关这些文件的信息, NLST 检索文件名列表。
    # 对每一行的输出结果调用回调函数（将该行文本作为参数传递给函数）, 默认回调将行打印到 sys.stdout, 
    # 例如: ls = []; ftp.retrlines("LIST /path", ls.append) 检索目录内容, 每行均添加到列表。
    FTP.retrlines(cmd, callback=None)
    
    # 以二进制传输模式检索文件。 
    #
    # cmd 应为适当的 RETR 命令, 例如: "RETR filename"。
    # 将接收到的每个 bytes 数据块调用回调函数（将 bytes 作为参数传递给函数）, 并使用单个字节参数指定数据块。
    # blocksize 参数指定在为进行实际传输而创建的低级套接字对象上读取的最大块大小（即传递给回调的数据块的最大大小）。
    # 例如: 
    # f = open("aa.jpg", "wb")
    # ftp.retrbinary("RETR /aa.jpg", f.write)
    # f.close()
    FTP.retrbinary(cmd, callback, blocksize=8192, rest=None)
    
    
    # 以 ASCII 传输模式存储文件。 
    #
    # cmd 应为适当的 STOR 命令, 例如: "STOR filename"。
    # fp 是一个文件对象（以二进制模式打开）, 通过其 readline() 方法不断读取数据直到 EOF, 以提供要存储的数据。
    # callback 是一个可调用的单个参数的函数, 它在发送后在每一行中被调用（可用于计算进度）。
    #
    # 例如:
    # fp = open("aa.txt", "rb")
    # ftp.storlines("STOR /aa.txt", fp)
    # fp.close()
    FTP.storlines(cmd, fp, callback=None)
    
    # 以二进制传输模式存储文件。
    #
    # cmd 应为适当的 STOR 命令, 例如: "STOR filename"。
    # fp 是一个文件对象（以二进制模式打开）, 通过其 read() 方法不断读取数据直到 EOF, 以提供要存储的数据。
    # blocksize 表示每次读取的最大字节数量。
    # callback 是一个可调用的单个参数的函数, 它在发送后在每个数据快中被调用（可用于计算进度）。
    #
    # 例如:
    # fp = open("aa.jpg", "rb")
    # ftp.storbinary("STOR /aa.jpg", fp)
    # fp.close()
    FTP.storbinary(cmd, fp, blocksize=8192, callback=None, rest=None)
    
    
    
    # 改变当前工作目录
    FTP.cwd(pathname)
    
    # 返回当前工作目录
    FTP.pwd()
    
    # 打印出指定目录下的文件信息（默认为当前目录）。
    # 最后参数如果是函数, 则将作为 retrlines() 的回调函数, 例如:
    # ls = []; ftp.dir(ls.append) 则将目录信息输出到 ls（默认输出到控制台）
    FTP.dir(argument[, ...])
    
    # 使用 NLST 命令, 返回文件名列表, 可以指定多个目录（默认为当前目录）
    FTP.nlst(argument[, ...])
    
    # 使用 MLSD 命令, 以标准格式列出目录, 可以指定目录（默认为当前目录）。
    #
    # facts 表示所需文件信息类型的字符串列表, 例如: ["type", "size", "modify"]。
    #
    # 返回一个生成器对象, 为 path 中找到的每个文件生成的一个由两个元素组成的元组,
    # 第一个元素为文件名, 第二个元素为包含文件信息的字典, 
    # 例如: ("filename", {"type": "file", "size": "451", "modify": "20200701161338", ...})
    FTP.mlsd(path="", facts=[])
    
    # 返回指定文件的大小, 单位: 字节
    # PS: SIZE 为非标准化命令, 但许多常见服务器都支持它
    FTP.size(filename)
    
    # 创建目录（逐级创建）
    FTP.mkd(pathname)
    
    # 删除目录（逐级删除）
    FTP.rmd(dirname)
    
    # 删除文件
    FTP.delete(filename)
    
    # 重命名文件
    FTP.rename(fromname, toname)

FTP 代码示例:

import ftplib
    
    
    def upload_file(ftp: ftplib.FTP, local_filename, ftp_filename: str):
        """ 上传文件, LOCAL -> FTP :param ftp: FTP实例 :param local_filename: 本地上传的文件路径 :param ftp_filename: FTP服务器的文件路径 :return: """
        with open(local_filename, "rb") as fp:
            cmd = "STOR " + ftp_filename    # 使用 STOR 命令保存文件
            ftp.storbinary(cmd=cmd, fp=fp)
    
    
    def download_file(ftp: ftplib.FTP, ftp_filename: str, local_filename: str):
        """ 下载文件, FTP -> LOCAL :param ftp: FTP实例 :param ftp_filename: FTP服务器的文件路径 :param local_filename: 本地保存的文件路径 """
        with open(local_filename, "wb") as fp:
            cmd = "RETR " + ftp_filename    # 使用 RETR 命令下载文件
            ftp.retrbinary(cmd=cmd, callback=fp.write)
    
    
    def main():
        # 创建 FTP 客户端实例, 使用默认端口连接主机
        ftp = ftplib.FTP("ftp.example.com")
    
        # 获取连接成功的欢迎信息
        print(ftp.getwelcome())
    
        # 用户登录
        ftp.login(user="user", passwd="passwd")
    
        # 改变工作目录
        ftp.cwd("/exists-path")
    
        # 输出当前目录的文件和目录
        ftp.dir()
    
        # 遍历当前目录下的文件名
        for name in ftp.nlst():
            print(name)
    
        # 遍历当前目录下的文件信息
        for fileinfo in ftp.mlsd():
            print(fileinfo)
    
        # 创建文件夹
        ftp.mkd("hello/")
        # 删除文件夹
        ftp.rmd("hello/")
    
        # 上传文件
        upload_file(ftp, local_filename="aa.jpg", ftp_filename="ftp_aa.jpg")
    
        # 下载文件
        download_file(ftp, ftp_filename="ftp_aa.jpg", local_filename="bb.jpg")
    
        # 删除文件
        ftp.delete("ftp_aa.jpg")
    
        # 退出 FTP
        ftp.quit()
    
    
    if __name__ == "__main__":
        main()

中文文件名乱码处理:

# 乱码原因: 
    # FTP 客户端拿到服务端传来的二进制的文件名后, 默认使用 ISO-8859-1 格式去解码为字符串,
    # FTP 服务端的文件名的编码格式可能不是 ISO-8859-1 格式, 编码和解码格式不一致导致乱码。
    #
    # 解决乱码:
    # 确认 FTP 服务端文件名使用的编码格式, 例如 GBK。
    # FTP 客户端获取的文件名为 ISO-8859-1 解码后的字符串,
    # 使用 ISO-8859-1 格式将该字符串编码为原 bytes, 
    # 再用正确的 GBK 格式解码 bytes 为字符串。
    #
    # 或者
    #
    # 直接改变 FTP 客户端的默认编码格式, ftplib.FTP 类有个 encoding 属性, 
    # 其值默认为 "latin-1", 即 "iso-8859-1"。
    # 手动改变 FTP 实例的默认编码: ftp.encoding = "gbk"
    
    
    # 遍历当前目录下的文件名（处理中文文件名乱码问题）
    for name in ftp.nlst():
        print(name.encode("iso-8859-1").decode("gbk"))
    
    
    # 发送命令时, 也需要对文件路径进行防乱码处理（发送 iso-8859-1 编码的字符串）
    ftp.dir("/hello/世界".encode("gbk").decode("iso-8859-1"))
    
    
    # 或者直接先改变 FTP 实例的默认编码格式再操作
    ftp.encoding = "gbk"
    # 遍历当前目录下的文件信息
    for fileinfo in ftp.mlsd():
        print(fileinfo)

# 2. FTP over TLS #

如果 FTP 服务器支持 TLS 安全连接, 可以使用 FTP over TLS 连接 FTP 服务器进行安全数据传输。

ftplib.FTP\_TLS 对象 Python Docs: [ftp-tls-objects][]

FTP over TLS 连接 FTP 代码示例:

import ftplib
    
    
    # 需要实例化子类, 否则会报错
    # From: https://stackoverflow.com/questions/14659154/ftpes-session-reuse-required/43301750
    class MyFTP_TLS(ftplib.FTP_TLS):
        """Explicit FTPS, with shared TLS session"""
        def ntransfercmd(self, cmd, rest=None):
            conn, size = ftplib.FTP.ntransfercmd(self, cmd, rest)
            if self._prot_p:
                conn = self.context.wrap_socket(conn,
                                                server_hostname=self.host,
                                                session=self.sock.session)  # this is the fix
            return conn, size
    
    
    def main():
        # 创建 FTP TLS 客户端实例, 使用默认端口连接主机
        ftps = MyFTP_TLS("ftp.example.com")
    
        # 获取连接成功的欢迎信息
        print(ftps.getwelcome())
    
        # 认证
        ftps.auth()
        # 切换到安全数据连接
        ftps.prot_p()
    
        # 用户登录
        ftps.login(user="user", passwd="passwd")
    
        # 输出当前目录的文件和目录
        ftps.dir()
    
        # 退出 FTP
        ftps.quit()
    
    
    if __name__ == "__main__":
        main()

[https_blog.csdn.net_xietansheng_article_details_115558082]: https://blog.csdn.net/xietansheng/article/details/115558082
[Python3]: https://blog.csdn.net/xietansheng/article/details/109266600
[https_tools.ietf.org_html_rfc959.html]: https://tools.ietf.org/html/rfc959.html
[http_www.nsftools.com_tips_RawFTP.htm]: http://www.nsftools.com/tips/RawFTP.htm
[https_en.wikipedia.org_wiki_List_of_FTP_commands]: https://en.wikipedia.org/wiki/List_of_FTP_commands
[ftplib _ FTP protocol client]: https://docs.python.org/zh-cn/3/library/ftplib.html
[ftp-objects]: https://docs.python.org/zh-cn/3/library/ftplib.html#ftp-objects
[ftp-tls-objects]: https://docs.python.org/zh-cn/3/library/ftplib.html#ftp-tls-objects