利用Click和argparse给你Python程序构建一个优雅的命令行界面

我们知道在Linux下有优雅的shell终端命令行界面，shell脚本都可以优雅用命令行的方式来运行。而且shell也再带优化命令行参数解析的bash内部命令getopts和大多数发行版附带的外部命令getops。Perl语言也有Getopt：：XX系列模块来实现类似功能;Golang也有flag标准库以及更加强大的第三库cobra。

说了这么多你肯定要问，那么Python呢?Python不像shell，perl一样有便捷强大的oneline脚本，虽然Python有强大的web界面下的脚本执行环境Jupyter Note，但是对终端命令行下的执行也是我们要追求的目标。本文虫虫就给大家介绍如何在Python下实现优雅的终端命令行界面CLI，涉及的模块有Click和argparse。

Click

Python开始的时候也模仿bansh和其他语言有getopt，optparse等模块来做CLI，后来推出argparser模块后getopt，optparse等都已经被废弃。在介绍argparser模块之前我们先来介绍click。

首先最简单的方式是使用click。我们先来看下python 3中的print()函数，注意该print()强制必须以带括号方式， 这是和python2比较大的区别。其定义如下：

print(*objects, sep=' ', end='\n', file=sys.stdout, flush=False) 

可以看到该函数可以支持各种规范格式的输出，而不单单一个打印输出了。

比如，通过可以自定义打印的结束字符，默认是"\n"。

print('hello，chongchong! ', end='\r') 

可以通过sep自定义分割符，而不是默认的空格。

print('hello', ' chongchong!', sep=',') 

通过file来重定向输出到文件，而不是stdout的默认标准输出。

print(' hello，chongchong!', file=open('chongchong.out', 'w')) 

我们可以利用click在命令行中实现对这些参数的输入和解析，实现一个简单的打印命令行界面。废话少说直接上代码：

#!/usr/bin/env python3 
import click 
import sys 
@click.command() 
@click.argument('args', nargs=-1) 
@click.option('-s', '--sep', default=' ', help='分隔符，默认为空') 
@click.option('-e', '--end', default='\n', help='结尾字符，默认为 "\\n"') 
@click.option('-o', '--out', default=None, help='输出文件，默认为stdout)') 
def print_prog(args, sep, end, out): 
'''打印输出结果。 
''' 
print(*args, sep=sep, end=end, file=open(out, 'w') if out else sys.stdout) 
if __name__ == '__main__': 
print_prog() 

脚本很简单，就是获取输入的参数，并将其传递给print()函数执行。执行如下：

打印文本

python print.py hello,chongchong! 

显示帮助

python print.py –help 

设置风格符号

python print.py -s %% hello chongchong! 

重定向到文件

python print.py -o chongchong.out -s %% hello chongchong! 

通过几行代码就实现了一个很棒的交互界面!

当然你可以依次为基础增加更多的内容，让它更实用这是一个演示，向您展示创建自己的CLI是多么容易。你不再需要编写普通的python脚本文件了。更多功能和高级特性可以参考click官方文档：

更多的基于click的项目和模块也可以通过其github仓clone和fork使用，你也可以给该项目添加自己的贡献。

具体地址为：github：/click-contrib/。

argparse

我们首先从官方的数字计算程序小例子来开始：

import argparse 
parser = argparse.ArgumentParser(description='Process some integers.') 
parser.add_argument('integers', metavar='N', type=int, nargs='+', 
help='an integer for the accumulator') 
parser.add_argument('--sum', dest='accumulate', action='store_const', 
const=sum, default=max, 
help='sum the integers (default: find the max)') 
args = parser.parse_args() 
print args.accumulate(args.integers) 

代码解释：

首先，通过argparse.ArgumentParser()创建一个解析对象;

接着，给对象添加两个参数，用add_argument()方法。比如本例中是一个type为一个或者一列整数;还有一个目标为accumulate属性用来选择两个函数sum()和max()求和和求最大值，默认为求最大值。

然后，通过parse_args()函数解析对象的参数，并把各个参数解析为合适的类型(int，accumulate)，触发对应的行为(sum，max)。

最后通过print打印结果。

ArgumentParser.add_argument()

使用方法如下：

ArgumentParser构造对象

（编辑：ASP站长网）