欢迎访问宙启技术站
智能推送

Python编程实现SCP远程文件传输进度监控

发布时间:2023-12-15 17:43:54

SCP(Secure Copy)是一种通过加密的方式在本地系统和远程系统之间进行文件传输的协议。在Python中,我们可以使用paramiko库来实现SCP远程文件传输,并且监控传输进度。

首先,我们需要安装paramiko库。在命令行中输入以下命令进行安装:

pip install paramiko

然后,我们可以使用如下的Python代码来实现SCP远程文件传输并监控传输进度:

import os
import paramiko
import sys
import threading

class SCPMonitor(paramiko.SFTPProgressMonitor):
    def __init__(self, filename):
        self._filename = filename
        self._size = 0
        self._lock = threading.Lock()

    def __call__(self, bytes_transferred, total_bytes):
        with self._lock:
            if self._size == 0:
                self._size = total_bytes
                print('Transferring file: {} ({} bytes)'.format(self._filename, self._size))
            
            percentage = int(bytes_transferred / self._size * 100)
            sys.stdout.write('\r')
            sys.stdout.write('[{}{}] {}%'.format('=' * int(percentage / 5), ' ' * (20 - int(percentage / 5)), percentage))
            sys.stdout.flush()

def scp_transfer(remote_host, remote_path, local_path, username, password):
    ssh = paramiko.Transport(remote_host)
    ssh.connect(username=username, password=password)
    sftp = paramiko.SFTPClient.from_transport(ssh)

    try:
        sftp.stat(remote_path)  # Check if remote file exists
    except FileNotFoundError:
        print('Remote file does not exist')
        return

    filename = os.path.basename(remote_path)
    monitor = SCPMonitor(filename)
    sftp.get(remote_path, local_path, callback=monitor)

    ssh.close()

if __name__=='__main__':
    remote_host = 'remote_server_ip'
    remote_path = 'remote_file_path'
    local_path = 'local_file_path'
    username = 'username'
    password = 'password'

    scp_transfer(remote_host, remote_path, local_path, username, password)

上述的代码定义了一个名为SCPMonitor的类,该类继承自paramiko.SFTPProgressMonitor,用于监控传输进度。在该类中,我们定义了一个私有变量self._size来保存文件的总字节数,并使用一个锁self._lock来确保多线程安全。

然后,我们定义了__call__函数,它会在传输过程中被调用。在这个函数中,我们首先检查是否已经获取了文件的总字节数,如果没有的话,就获取并打印文件的名称和大小。然后,我们计算已传输字节数占文件总字节数的百分比,并在命令行中显示传输进度。

接下来,我们定义了一个名为scp_transfer的函数,在该函数中,我们首先创建一个Transport对象并连接远程主机。然后,我们使用该对象创建一个sftp对象来进行文件传输,最后通过sftp.get方法来实现从远程主机下载文件,并在该方法中传入SCPMonitor对象以监控传输进度。

在主函数中,我们定义了一些需要设置的变量,比如远程主机的IP地址、远程文件的路径、本地文件的路径、用户名和密码。然后,我们调用scp_transfer函数来执行文件传输操作。

需要注意的是,上述的代码仅仅实现了从远程主机下载文件的功能,如果需要实现上传文件的功能,可以修改scp_transfer函数中的sftp.getsftp.put

通过上述的代码,我们可以实现SCP远程文件传输并监控传输进度。这对于需要进行大文件传输或者希望能够清楚地了解文件传输进度的情况下非常有用。