详解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中查看文件名和文件路径
Mar 31 Python
由浅入深讲解python中的yield与generator
Apr 05 Python
python leetcode 字符串相乘实例详解
Sep 03 Python
使用python 打开文件并做匹配处理的实例
Jan 02 Python
python__name__原理及用法详解
Nov 02 Python
解决IDEA 的 plugins 搜不到任何的插件问题
May 04 Python
JupyterNotebook 输出窗口的显示效果调整实现
Sep 22 Python
Python在线和离线安装第三方库的方法
Oct 31 Python
利用Python实现学生信息管理系统的完整实例
Dec 30 Python
Python中对象的比较操作==和is区别详析
Feb 12 Python
详解python第三方库的安装、PyInstaller库、random库
Mar 03 Python
浅谈Python数学建模之固定费用问题
Jun 23 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
解析阿里云ubuntu12.04环境下配置Apache+PHP+PHPmyadmin+MYsql
2013/06/26 PHP
smarty中js的调用方法示例
2014/10/27 PHP
PHP获取某个月最大天数(最后一天)的方法
2015/07/29 PHP
thinkphp制作404跳转页的简单实现方法
2016/09/22 PHP
PHP实现文件上传后台处理脚本
2020/03/04 PHP
用js实现键盘方向键翻页功能的代码
2007/06/03 Javascript
jQuery遍历Table应用示例
2014/04/09 Javascript
构造函数+原型模式构造js自定义对象(最通用)
2014/05/12 Javascript
jquery动态添加元素事件失效问题解决方法
2014/05/23 Javascript
jquery.idTabs 选项卡使用示例代码
2014/09/03 Javascript
jQuery过滤选择器用法分析
2015/02/10 Javascript
在小程序中集成redux/immutable/thunk第三方库的方法
2018/08/12 Javascript
微信小程序显示倒计时功能示例【测试可用】
2018/12/03 Javascript
微信小程序实现随机验证码功能
2018/12/20 Javascript
Vue开发之封装分页组件与使用示例
2019/04/25 Javascript
JS实现判断数组是否包含某个元素示例
2019/05/24 Javascript
ES6 Object.assign()的用法及其使用
2020/01/18 Javascript
在Vue 中获取下拉框的文本及选项值操作
2020/08/13 Javascript
[01:28:43]2014 DOTA2华西杯精英邀请赛5 24 DK VS CIS
2014/05/25 DOTA
Python二维码生成库qrcode安装和使用示例
2014/12/16 Python
python计算时间差的方法
2015/05/20 Python
初步认识Python中的列表与位运算符
2015/10/12 Python
python通过zabbix api获取主机
2018/09/17 Python
Python3日期与时间戳转换的几种方法详解
2019/06/04 Python
python五子棋游戏的设计与实现
2019/06/18 Python
Python for循环及基础用法详解
2019/11/08 Python
菲律宾旅游网站:Expedia菲律宾
2017/10/11 全球购物
如何判断计算机可能已经中马
2013/03/22 面试题
计算机毕业大学生推荐信
2013/12/01 职场文书
个人现实表现材料
2014/02/04 职场文书
社区禁毒工作方案
2014/06/02 职场文书
父亲节活动策划方案
2014/08/24 职场文书
检察机关个人对照检查材料
2014/09/15 职场文书
应届生简历自我评价
2015/03/11 职场文书
Python中threading库实现线程锁与释放锁
2021/05/17 Python
MySQL中dd::columns表结构转table过程及应用详解
2022/09/23 MySQL