Python SFTP 科普文章

介绍

SFTP（Secure File Transfer Protocol，安全文件传输协议）是一种安全的文件传输协议，可以通过加密的方式在网络上传输文件。在Python中，我们可以使用paramiko库来实现SFTP功能。本文将介绍如何使用Python进行SFTP操作，并提供代码示例。

安装依赖库

在开始之前，我们需要安装paramiko库。可以使用以下命令来安装：

pip install paramiko

连接到SFTP服务器

要连接到SFTP服务器，我们需要提供服务器的地址、用户名和密码。下面是一个示例代码：

import paramiko

# 创建SSH client
client = paramiko.SSHClient()

# 自动添加服务器的SSH密钥
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())

# 连接到服务器
client.connect('sftp.example.com', username='your_username', password='your_password')

创建SFTP会话

连接成功后，我们可以通过SSH client的open_sftp()方法来创建SFTP会话：

# 打开SFTP会话
sftp = client.open_sftp()

上传文件

要上传文件，我们可以使用SFTP会话的put()方法。下面是一个示例代码：

local_path = 'path/to/local/file.txt'  # 本地文件路径
remote_path = 'path/to/remote/file.txt'  # 远程文件路径

# 上传文件
sftp.put(local_path, remote_path)

下载文件

要下载文件，我们可以使用SFTP会话的get()方法。下面是一个示例代码：

remote_path = 'path/to/remote/file.txt'  # 远程文件路径
local_path = 'path/to/local/file.txt'  # 本地文件路径

# 下载文件
sftp.get(remote_path, local_path)

列出目录内容

要列出目录中的文件和子目录，我们可以使用SFTP会话的listdir()方法。下面是一个示例代码：

remote_path = 'path/to/remote/directory'  # 远程目录路径

# 列出目录内容
contents = sftp.listdir(remote_path)

# 打印列表
for item in contents:
    print(item)

删除文件

要删除文件，我们可以使用SFTP会话的remove()方法。下面是一个示例代码：

remote_path = 'path/to/remote/file.txt'  # 远程文件路径

# 删除文件
sftp.remove(remote_path)

关闭会话和连接

在完成SFTP操作后，我们应该关闭SFTP会话和SSH连接：

# 关闭SFTP会话
sftp.close()

# 关闭SSH连接
client.close()

示例代码

下面是一个完整的示例代码，演示了如何上传文件到SFTP服务器，并从服务器下载文件：

import paramiko

# 创建SSH client
client = paramiko.SSHClient()

# 自动添加服务器的SSH密钥
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())

# 连接到服务器
client.connect('sftp.example.com', username='your_username', password='your_password')

# 打开SFTP会话
sftp = client.open_sftp()

# 上传文件
local_path = 'path/to/local/file.txt'  # 本地文件路径
remote_path = 'path/to/remote/file.txt'  # 远程文件路径
sftp.put(local_path, remote_path)

# 下载文件
remote_path = 'path/to/remote/file.txt'  # 远程文件路径
local_path = 'path/to/local/file.txt'  # 本地文件路径
sftp.get(remote_path, local_path)

# 关闭SFTP会话
sftp.close()

# 关闭SSH连接
client.close()

状态图

下面是一个使用mermaid语法标识的状态图，描述了SFTP操作的状态流转：

stateDiagram
    [*] --> Connected
    Connected --> [*]

    Connected --> UploadingFile
    UploadingFile --> FileUploaded
    UploadingFile --> UploadFailed
    FileUploaded --> Connected
    UploadFailed --> Connected

    Connected --> DownloadingFile
    DownloadingFile --> FileDownloaded
    DownloadingFile --> DownloadFailed
    FileDownloaded --> Connected
    DownloadFailed --> Connected

    Connected --> ListingDirectory
    ListingDirectory --> DirectoryListed
    ListingDirectory --> ListFailed
    DirectoryListed --> Connected
    ListFailed --> Connected

    Connected --> RemovingFile
    RemovingFile --> FileRemoved
    RemovingFile