如何在 Paramiko SFTP 文件写入过程中实时显示进度

酷晨吖_3908

酷晨吖_3908

2026-10-03

706人浏览

原创

如何在 Paramiko SFTP 文件写入过程中实时显示进度

Paramiko 的 SFTPFile.write() 是同步阻塞操作,无法直接监听“进行中”状态;正确做法是分块读写数据,并在每块写入后更新进度提示,从而实现可控、可观察的上传过程。

paramiko 的 `sftpfile.write()` 是同步阻塞操作,无法直接监听“进行中”状态;正确做法是分块读写数据,并在每块写入后更新进度提示,从而实现可控、可观察的上传过程。

在使用 Paramiko 进行大文件 SFTP 上传时,若直接调用 remote_file.write(my_data),整个写入过程会阻塞主线程,且无内置回调或状态反馈机制——这使得实时进度展示(如终端打印、进度条)无法通过“轮询 write() 返回值”实现(因其不返回中间状态)。根本解法是主动控制写入节奏:将数据切分为小块,逐块写入并手动更新进度。

以下是一个专业、健壮的实现方案:

✅ 核心思路:流式分块写入 + 手动进度追踪

import paramiko
import contextlib
import time

def upload_with_progress(sftp_client, local_path, remote_path, chunk_size=8192):
    """带进度提示的 SFTP 文件上传(基于分块写入)"""
    with open(local_path, "rb") as f_in:
        # 获取总大小用于进度计算
        f_in.seek(0, 2)
        total_size = f_in.tell()
        f_in.seek(0)  # 重置读取位置

        with sftp_client.file(remote_path, "wb") as f_out:
            uploaded = 0
            start_time = time.time()

            while True:
                chunk = f_in.read(chunk_size)
                if not chunk:
                    break
                f_out.write(chunk)
                uploaded += len(chunk)

                # 实时进度输出(可替换为 tqdm 或自定义格式)
                elapsed = time.time() - start_time
                speed = uploaded / elapsed if elapsed > 0 else 0
                percent = (uploaded / total_size * 100) if total_size > 0 else 0
                print(f"\rProgress: {uploaded}/{total_size} bytes ({percent:.1f}%) "
                      f"| Speed: {speed/1024/1024:.2f} MB/s", end="", flush=True)

            print("\n✅ Upload completed.")

# 使用示例
ssh = paramiko.SSHClient()
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
ssh.connect("example.com", username="user", password="pass")
sftp = ssh.open_sftp()

upload_with_progress(sftp, "/local/large.zip", "/remote/large.zip", chunk_size=1024*1024)  # 1MB chunks

sftp.close()
ssh.close()

⚠️ 关键注意事项

  • chunk_size 需权衡:过小(如 4KB)会增加网络往返和系统调用开销;过大(如 100MB)可能占用过多内存且响应延迟。推荐 64KB–4MB 范围,根据网络延迟与内存限制实测调整。
  • write() 仍可能部分写入:Paramiko 不保证单次 write() 写入全部字节(尤其在网络拥塞时),但 SFTPFile.write() 在 Paramiko 中实际已做内部缓冲与重试,通常可视为原子写入。如需强保障,应检查返回值(len(chunk))并循环补写。
  • 避免 while remote_file.write(...) == IN_PROGRESS 类误用:write() 返回写入字节数(int),成功即返回 len(data),失败抛异常——它没有 IN_PROGRESS 状态,该设计不符合 Python I/O 模型。
  • 资源安全:务必使用 with 语句或 contextlib.ExitStack 管理 SSHClient、SFTPClient、文件句柄,防止连接泄漏。

? 总结

Paramiko 的 SFTPFile 不提供异步写入或进度回调接口,但通过用户态分块 + 显式进度计算,即可轻松实现专业级上传监控。该方法轻量、可靠、无需额外依赖(如 tqdm),且完全兼容 Paramiko 原生 API。对于调试与用户体验,这是最直接、最可控的解决方案。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1651

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4044

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1649

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

23337

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2867

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2907

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1143

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2243

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习