详解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中的cookielib模拟登录网站
Apr 09 Python
Python使用迭代器打印螺旋矩阵的思路及代码示例
Jul 02 Python
Python模拟三级菜单效果
Sep 11 Python
Python使用Matplotlib实现Logos设计代码
Dec 25 Python
Django项目中添加ldap登陆认证功能的实现
Apr 04 Python
python中的数组赋值与拷贝的区别详解
Nov 26 Python
python进程池实现的多进程文件夹copy器完整示例
Nov 27 Python
利用django model save方法对未更改的字段依然进行了保存
Mar 28 Python
Python语言编写智力问答小游戏功能
Oct 13 Python
Python实现冒泡排序算法的完整实例
Nov 04 Python
Python结合百度语音识别实现实时翻译软件的实现
Jan 18 Python
Python 数据可视化之Seaborn详解
Nov 02 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
LAMP环境使用Composer安装Laravel的方法
2017/03/25 PHP
php实现用户注册密码的crypt加密
2017/06/08 PHP
javascript 仿QQ滑动菜单效果代码
2010/09/03 Javascript
js+css 实现遮罩居中弹出层(随浏览器窗口滚动条滚动)
2013/12/11 Javascript
jQuery插件slides实现无缝轮播图特效
2015/04/17 Javascript
图解JavaScript中的this关键字
2020/05/28 Javascript
js从外部获取图片的实现方法
2016/08/05 Javascript
jQuery实现页面滚动时智能浮动定位
2017/01/08 Javascript
JavaScript表单验证完美代码
2017/03/02 Javascript
template.js前端模板引擎使用详解
2017/10/10 Javascript
JS实现的计数排序与基数排序算法示例
2017/12/04 Javascript
js实现图片放大并跟随鼠标移动特效
2019/01/18 Javascript
详解vue-cli+es6引入es5写的js(两种方法)
2019/04/19 Javascript
js常见遍历操作小结
2019/06/06 Javascript
angularjs1.X 重构controller 的方法小结
2019/08/15 Javascript
[01:10:58]Spirit vs NB Supermajor小组赛 A组败者组决赛 BO3 第二场 6.2
2018/06/03 DOTA
简单介绍Python中用于求最小值的min()方法
2015/05/15 Python
基于python元祖与字典与集合的粗浅认识
2017/08/23 Python
python 画三维图像 曲面图和散点图的示例
2018/12/29 Python
python Tkinter的图片刷新实例
2019/06/14 Python
python爬虫中多线程的使用详解
2019/09/23 Python
Python中Flask-RESTful编写API接口(小白入门)
2019/12/11 Python
Python命令行click参数用法解析
2019/12/19 Python
利用python3 的pygame模块实现塔防游戏
2019/12/30 Python
python自动点赞功能的实现思路
2020/02/26 Python
中药专业大学生医药工作求职信
2013/10/25 职场文书
大学生毕业自我评价范文分享
2013/11/11 职场文书
《鸟岛》教学反思
2014/04/26 职场文书
爱与责任演讲稿
2014/05/20 职场文书
档案保密承诺书
2014/06/03 职场文书
欢迎领导检查标语
2014/06/27 职场文书
2014年村官工作总结
2014/11/24 职场文书
本科毕业论文导师评语
2014/12/31 职场文书
2015年安全月活动总结
2015/03/26 职场文书
pytorch 中autograd.grad()函数的用法说明
2021/05/12 Python
MySQL中InnoDB存储引擎的锁的基本使用教程
2021/05/26 MySQL