详解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发送邮件的实例代码(支持html、图片、附件)
Mar 04 Python
Python实现数据库编程方法详解
Jun 09 Python
python网络编程调用recv函数完整接收数据的三种方法
Mar 31 Python
在Python中执行系统命令的方法示例详解
Sep 14 Python
Python实现的人工神经网络算法示例【基于反向传播算法】
Nov 11 Python
解决Pyinstaller 打包exe文件 取消dos窗口(黑框框)的问题
Jun 21 Python
Django中信号signals的简单使用方法
Jul 04 Python
Python搭建代理IP池实现检测IP的方法
Oct 27 Python
TensorFlow实现checkpoint文件转换为pb文件
Feb 10 Python
python实现飞船游戏的纵向移动
Apr 24 Python
python随机模块random的22种函数(小结)
May 15 Python
利用Python实现Picgo图床工具
Nov 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
星际实力自我测试
2020/03/04 星际争霸
解析PHP跨站刷票的实现代码
2013/06/18 PHP
php根据用户语言跳转相应网页
2015/11/04 PHP
php日志函数error_log用法实例分析
2019/09/23 PHP
Javascript中的window.event.keyCode使用介绍
2011/04/26 Javascript
javascript中的事件代理初探
2014/03/08 Javascript
easyui datagrid 键盘上下控制选中行示例
2014/03/31 Javascript
全面解析Bootstrap表单使用方法(表单按钮)
2015/11/24 Javascript
JavaScript的removeChild()函数用法详解
2015/12/27 Javascript
好好了解一下Cookie(强烈推荐)
2016/06/14 Javascript
基于jQuery实现歌词滚动版音乐播放器的代码
2016/09/17 Javascript
Vue.js在使用中的一些注意知识点
2017/04/29 Javascript
JS中Swiper的使用和轮播图效果
2017/08/11 Javascript
vue实现文章内容过长点击阅读全文功能的实例
2017/12/28 Javascript
three.js利用射线Raycaster进行碰撞检测
2020/03/12 Javascript
浅谈vue中$event理解和框架中在包含默认值外传参
2020/08/07 Javascript
python和pyqt实现360的CLable控件
2014/02/21 Python
跟老齐学Python之使用Python操作数据库(1)
2014/11/25 Python
Python实现队列的方法
2015/05/26 Python
Python安装第三方库的3种方法
2015/06/21 Python
python 中random模块的常用方法总结
2017/07/08 Python
python Opencv将图片转为字符画
2021/02/19 Python
python用BeautifulSoup库简单爬虫实例分析
2018/07/30 Python
Python图像处理库PIL的ImageFont模块使用介绍
2020/02/26 Python
美国知名的网上鞋类及相关服装零售商:Shoes.com
2017/05/06 全球购物
美国一家运动专业鞋类零售商:Warehouse Shoe Sale(WSS)
2018/03/28 全球购物
面试求职的个人自我评价
2013/11/16 职场文书
雪山饭庄的创业计划书范文
2014/01/18 职场文书
小学生期末评语
2014/04/21 职场文书
党支部换届选举方案
2014/05/08 职场文书
平安家庭示范户事迹
2014/06/02 职场文书
小学清明节活动总结
2014/07/04 职场文书
2014年高数考试作弊检讨书
2014/12/14 职场文书
教师远程研修感悟
2015/11/18 职场文书
Win11快速关闭所有广告推荐
2022/04/19 数码科技
CentOS7设置ssh服务以及端口修改方式
2022/12/24 Servers