详解Python命令行解析工具Argparse


Posted in Python onApril 20, 2016

最近在研究pathon的命令行解析工具,argparse,它是Python标准库中推荐使用的编写命令行程序的工具。

以前老是做UI程序,今天试了下命令行程序,感觉相当好,不用再花大把时间去研究界面问题,尤其是vc++中尤其繁琐。

现在用python来实现命令行,核心计算模块可以用c自己写扩展库,效果挺好。

学习了argparse,在官方文档中找到一篇toturial,简单翻译了下。

http://docs.python.org/2/howto/argparse.html#id1

Argparse Tutorial
这篇教程简明地介绍了Python标准库推荐使用的命令行参数解析模块——Argparse的使用。

1、基本概念

 在这篇教程中我们通过一个常见的ls命令来展示argparse的功能。

$ ls
cpython devguide prog.py pypy rm-unused-function.patch
$ ls pypy
ctypes_configure demo dotviewer include lib_pypy lib-python ...
$ ls -l
total 20
drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython
drwxr-xr-x 4 wena wena 4096 Feb 8 12:04 devguide
-rwxr-xr-x 1 wena wena 535 Feb 19 00:05 prog.py
drwxr-xr-x 14 wena wena 4096 Feb 7 00:59 pypy
-rw-r--r-- 1 wena wena 741 Feb 18 01:01 rm-unused-function.patch
$ ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.

从以上的四个命令中,我们能够了解以下几个基本概念:

1)、ls命令在没有参数的情况下也是可以运行的,默认打印出当前目录下的所有内容。
2)、如果我们想让它展示更多内容,那么我们需要给它多一点参数。在这种情况下,我们想显示一个不同的目录,pypy。我们所做的就是明确了常见的定位参数(positional argument),这样命名是因为需要程序根据参数在命令行中的位置而决定做什么。这个概念与命令cp更为接近,它的用法是cp src dest,src表示的是你想要拷贝的文件,dest表示你想要将文件拷贝到哪里。
3)、现在,我想要改变程序的行为。在我们的例子中,我想显示文件的向西信息而不仅仅是文件名,参数-l 则是我们所知道的可选参数(optinal argument)
4)、最后一句是显示帮助的文档的一个片段,当你遇到你从未使用过的命令时,你可以通过它学习怎么使用。

2、基本认识

我们从一个基本的程序开始(它什么也不做)

import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

运行结果:

$ python prog.py
$ python prog.py --help
usage: prog.py [-h]

optional arguments:
 -h, --help show this help message and exit
$ python prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo

结果分析:

1)、若不给参数而运行这个程序,将不会得到任何结果。
2)、第二条命名显示了使用的argparse的好处,你什么也没做,却得到了一个很好的帮助信息。
3)、我们无需人为设置--help参数,就能得到一个良好的帮助信息。但是若给其他参数(比如foo)就会产生一个错误。

3、位置参数

首先,给一个例子:

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print args.echo

运行结果:

$ python prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo
$ python prog.py --help
usage: prog.py [-h] echo

positional arguments:
 echo

optional arguments:
 -h, --help show this help message and exit
$ python prog.py foo
foo

结果分析:

这次,我们增加了一个add_argument()方法,用来设置程序可接受的命令行参数。
现在要运行程序,就必须设置一个参数。
parse_args()方法实际上从我们的命令行参数中返回了一些数据,在上面的例子中是echo
这个像“魔法”一样的过程,是argparse自动完成的。
尽管自动产生的帮助信息展示地很美观,但是我们仍然无法只根据echo这个参数知道它是做什么的。所以,我们增加了一些东西,使得它变得更有用。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here")
args = parser.parse_args()
print args.echo

运行结果:

$ python prog.py -h
usage: prog.py [-h] echo

positional arguments:
 echo    echo the string you use here

optional arguments:
 -h, --help show this help message and exit

在此基础上,我们再多改变一点:(计算输入参数square的平方)

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number")
args = parser.parse_args()
print args.square**2

下面是运行结果:

$ python prog.py 4
Traceback (most recent call last):
 File "prog.py", line 5, in <module>
  print args.square**2
TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'

这个程序并不能正确运行,因为argparse会将输入当作字符串处理,所以我们需要设置它的类型:(type=int)

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number",
          type=int)
args = parser.parse_args()
print args.square**2

下面是运行结果:

$ python prog.py 4
16
$ python prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'

现在,这个程序能够顺利运行,而且能够处理一些错误输入。

以上就是关于Python命令行解析工具Argparse的简单使用教程,希望对大家有帮助。

Python 相关文章推荐
python 实现堆排序算法代码
Jun 05 Python
python统计日志ip访问数的方法
Jul 06 Python
python实现报表自动化详解
Nov 16 Python
Python实现的插入排序算法原理与用法实例分析
Nov 22 Python
解决python文件双击运行秒退的问题
Jun 24 Python
wxPython实现整点报时
Nov 18 Python
使用TensorFlow-Slim进行图像分类的实现
Dec 31 Python
PyCharm MySQL可视化Database配置过程图解
Jun 09 Python
Python调用OpenCV实现图像平滑代码实例
Jun 19 Python
基于tensorflow for循环 while循环案例
Jun 30 Python
Python如何读取、写入JSON数据
Jul 28 Python
Django权限控制的使用
Jan 07 Python
利用Python如何生成随机密码
Apr 20 #Python
Python自动化部署工具Fabric的简单上手指南
Apr 19 #Python
python实现简单socket通信的方法
Apr 19 #Python
python实现域名系统(DNS)正向查询的方法
Apr 19 #Python
python安装与使用redis的方法
Apr 19 #Python
Python实现文件复制删除
Apr 19 #Python
利用Python获取赶集网招聘信息前篇
Apr 18 #Python
You might like
php.ini-dist 和 php.ini-recommended 的区别介绍(方便开发与安全的朋友)
2012/07/01 PHP
php多种形式发送邮件(mail qmail邮件系统 phpmailer类)
2014/01/22 PHP
PHP实现判断数组是一维、二维或几维的方法
2017/02/06 PHP
PHP两个n位的二进制整数相加问题的解决
2018/08/26 PHP
JS创建优美的页面滑动块效果 - Glider.js
2007/09/27 Javascript
jquery-easyui关闭tab自动切换到前一个tab
2010/07/29 Javascript
jquery序列化form表单使用ajax提交后处理返回的json数据
2014/03/03 Javascript
javasciprt下jquery函数$.post执行无响应的解决方法
2014/03/13 Javascript
jquery+CSS3模拟Path2.0动画菜单效果代码
2015/08/31 Javascript
JavaScript实现的浮动层框架用法实例分析
2015/10/10 Javascript
JavaScript前端开发之实现二进制读写操作
2015/11/04 Javascript
JavaScript将DOM事件处理程序封装为event.js 出现的低级错误问题
2016/08/03 Javascript
vue.js树形组件之删除双击增加分支实例代码
2017/02/28 Javascript
$.browser.msie 为空或不是对象问题的多种解决方法
2017/03/19 Javascript
Javascript操作dom对象之select全面解析
2017/04/24 Javascript
jQuery实现的3D版图片轮播示例【滑动轮播】
2019/01/18 jQuery
JavaScript 链表定义与使用方法示例
2020/04/28 Javascript
[52:52]完美世界DOTA2联赛PWL S3 LBZS vs access 第一场 12.10
2020/12/13 DOTA
Python2.6版本中实现字典推导 PEP 274(Dict Comprehensions)
2015/04/28 Python
python 远程统计文件代码分享
2015/05/14 Python
人工智能最火编程语言 Python大战Java!
2017/11/13 Python
Python数据分析之双色球中蓝红球分析统计示例
2018/02/03 Python
centos 安装python3.6环境并配置虚拟环境的详细教程
2018/02/22 Python
浅谈django orm 优化
2018/08/18 Python
Python中使用遍历在列表中添加字典遇到的坑
2019/02/27 Python
python 求某条线上特定x值或y值的点坐标方法
2019/07/09 Python
python实现从wind导入数据
2019/12/03 Python
在Python 的线程中运行协程的方法
2020/02/24 Python
python 工具 字符串转numpy浮点数组的实现
2020/03/14 Python
python属于解释型语言么
2020/06/15 Python
Python 测试框架unittest和pytest的优劣
2020/09/26 Python
python包的导入方式总结
2021/03/02 Python
30年同学聚会邀请函
2014/01/25 职场文书
海上钢琴师观后感
2015/06/03 职场文书
大学生各类奖学金申请书
2019/06/24 职场文书
关于Javascript闭包与应用的详解
2021/04/22 Javascript