Python Fire：自动生成命令行接口

命令行程序是平时写一些小工具时最常用的方式。

为了让命令行程序更加灵活，我们常常会设置一些参数，根据参数让程序执行不同的功能。
这样就不用频繁的修改代码来执行不同的功能。

随着命令行程序功能的丰富，也就是参数多了以后，解析和管理参数之间的关系会变得越来越繁重。
而本次介绍的 Fire 库，正好可以解决这个问题。
使用 Fire 库，我们只要关心具体功能的实现，最后Fire会帮助我们自动把所有功能组织成一个命令行程序。

Fire库在github上的地址：https://github.com/google/python-fire

1. 一般命令

一般的命令，也就是带有几个参数的一段程序，比如：

# -*- coding:utf-8 -*-

def import_file(fp):
    print("import file from: {}".format(fp))

def export_file(fp):
    print("EXPORT file to: {}".format(fp))

这是模拟文件导出功能的两个函数。

使用 Fire 转换成命令行程序非常简单，下面介绍几种常用的方式。

1.1. 默认方式

# -*- coding:utf-8 -*-

import fire

def import_file(fp):
    print("IMPORT file from: {}".format(fp))

def export_file(fp):
    print("EXPORT file to: {}".format(fp))

if __name__ == "__main__":
    # fire默认会将所有函数转换成子命令
    fire.Fire()

然后，就可以通过子命令的方式执行导入导出功能。

$ python main.py import_file --fp ./path/xxx.csv
IMPORT file from: ./path/xxx.csv

$ python main.py export_file --fp ./path/xxx.csv
EXPORT file to: ./path/xxx.csv

函数的名称自动变为子命令的名称，函数的参数自动变成子命令的参数。

1.2. Fire

Fire库的默认方式会把所有的函数都转换为子命令，
如果只想导出一个函数的话，可以用 Fire的方式。

if __name__ == "__main__":
    # 只导出 import_file 函数作为子命令
    fire.Fire(import_file)

只导出一个函数的时候，执行命令的时候不需要输入子命令的名称。

$ python main.py --fp ./path/xxx.csv
IMPORT file from: ./path/xxx.csv

1.3. Fire

导出多个函数作为子命令时，默认是使用函数名作为子命令名称的，函数名称有时候会非常长，输入很麻烦。
这时，可以用 Fire 方式。

if __name__ == "__main__":
    # 子命令的名称分别是：import 和 export
    fire.Fire({
        "import": import_file,
        "export": export_file,
    })

执行时，使用简化的子命令名称。

$ python main.py import --fp ./path/xxx.csv
IMPORT file from: ./path/xxx.csv

$ python main.py export --fp ./path/xxx.csv
EXPORT file to: ./path/xxx.csv

这种方式非常灵活，不仅可以设置子命令名称，还可以控制需要导出哪些函数。

1.4. Fire