最近接到一个产品需求是给指定的 sftp 服务器的指定目录定时推送文件数据。

因为项目组已有现成的组件可以轻松实现 sftp 服务器文件的快速上传，本来是一件很容易的事情，但是问题出现在这个指定的 sftp 服务器所指定的密码带有系统关键字和一些特殊字符，导致现在的组件在解析过程中会失败。

因此重新开发了下面的这套脚本来满足这个特殊的需求。

Python代码

sftp配置文件代码

(1). yaml 模块

导入 yaml 模块前可以使用以下命令进行模块的安装

yaml 模块在这里的作用是读取 sftp 配置文件代码，将指定key: test_file_upload 下的 key:value 的值转换为字典。

例如：load_config_from_param_conf 函数中的返回值就是使用 yaml 读取到 sftp 配置文件代码后，返回 key: test_file_upload 下配置选项值。

格式如下：

最后将返回值传给 upload 函数作为参数。

(2). OptionParser 模块

按照 yaml 模块的安装方法，先安装 optparse 模块后，然后在文件中从optparse 中导入 OptionParser 模块

在这里我使用了 OptionParser 这个类实例化了一个对象：opt_parser，通过对象来调用 add_option 方法添加了2个参数，分别是：node, local_file

1). 形参：--node，实参：node

所代表的业务含义是：指定要上传的 sftp 的节点，具体参数值对应 sftp配置文件代码中的 test_file_upload

2). 形参：--local_file，实参：local_file

所代表的业务含义是：指定本地需要被上传到 sftp 服务器的具体文件路径

3). 调用命令

4). add_option()方法

add_option()参数说明：

• action: 存储方式，分别为:store,store_false,store_true
• type: 类型
• dest: 存储的变量
• default: 默认值
• help: 帮助信息

参数：action的枚举

• store: 参数列表中带有--node, 那么就会将下一个元素即：test_file_upload 作为其 dest 实参 node 的值; 如果没有--node,那么对应的node的值就为 None;
• store_true: 参数列表中有--local_file, 那么其 dest 实参 local_file 的值就为 True; 否者就为 default 定义的默认值，这里没有给定 default 的默认值;
• store_false: 参数列表中有--local_file, 那么其 dest 实参 local_file 的值就为 False; 否者就为 default 定义的默认值，这里没有给定 default 的默认值;

参数：type

type是指定传入参数的类型，这里的参数类型为 string 类型。

参数：dest

dest是参数传入后由哪个变量来存储的，后面代码对该参数的引用也是使用这里定义的变量名来引用的。

参数：default

default 是与 action 的值结合使用的。

• 当action=store_true时，default=123时，如果有传入形参--local_file，则实参local_file的值为：True
• 当action=store_true时，default=123时，如果没有传入形参--local_file，则实参local_file的值为：123
• 当action=store_false时，default=123时，如果有传入形参--local_file，则实参local_file的值为：False
• 当action=store_false时，default=123时，如果没有传入形参--local_file，则实参local_file的值为：123

参数：help

help相当于帮助说明文档，用于描述这个参数的含义。