Python脚本argparse使用

Python的脚本可以自然而然写成可运行脚本,在文件头加入

#!/usr/bin/env python

或者

#!/usr/bin/python

即可。当然也可以通过执行python target.py来运行脚本。实际编写Python脚本的时候,需要考虑编写参数,当可选参数比较多的时候,通过sys.argv是非常麻烦的。幸好Python自带argparse工具帮助我们快速实现各种参数,而且自动生成帮助文档,这里介绍其基本使用方法。

最基本配置

如果一个脚本没有参数,只有帮助文档,Python脚本可以写作

#!/usr/bin/env python
import argparse
parser = argparse.ArgumentParser() # 生成参数分析器
parser.parse_args()

此时,该脚本为无参数脚本,一系列运行结果为

./prog_base.py -h
usage: prog_base.py [-h]

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

如果添加错误的参数信息,会自动输出错误提示,例如我们添加可选参数--verbose

> ./prog_base.py --verbose
usage: prog_base.py [-h]
prog_base.py: error: unrecognized arguments: --verbose

会自动告诉用户未识别该参数。

添加位置参数

位置参数一般是命令的主要参数,一般在命令最尾端,例如我们希望编写一个简单的脚本,将一个位置参数的值输出,Python代码写作

import argparse
parser = argparse.ArgumentParser() # 生成参数分析器
parser.add_argument("echo") # 添加位置参数
args = parser.parse_args()
print args.echo

此时,python脚本会将参数值输出

> python prog_pos.py haha
haha

如果没有添加参数则会报错

> python prog_pos.py 
usage: prog_pos.py [-h] echo
prog_pos.py: error: too few arguments

并且可以使用-h或者--help参数查看脚本帮助文档

> python prog_pos.py haha -h
usage: prog_pos.py [-h] echo

positional arguments:
  echo

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

可以发现现在echo没有任何帮助说明,要启用非常简单,在添加这个参数的时候加入help可选参数即可,如

parser.add_argument("echo", help = "echo the string you use here")

同时Python的 argparse可以给定输入类型,比如我们想写一个计算输入平方数的程序,假定调用方法为

prog_square.py [-h] number

我们可以这样编写脚本

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

add_argument的时候指定其可选参数typeint类型,则在分析输入命令的时候会自动解析为整数型,此时调用结果为

> python prog_square.py 4
16

可以发现使用Python的argparse非常方便易用。

可选参数添加

比如我们想给一个脚本添加一个打印详细程度的指标,当verbose开启的时候会打印出相应的信息。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="increase output verbosity")
args = parser.parse_args()
if args.verbose: 
     print "verbosity turned on"

当直接运行脚本的时候没有任何输出,当加入verbose之后会打印出多出来的内容

> python prog_verbose.py
> python prog_verbose.py --verbose
verbosity turned on

小结

有了这些基本功能,可以使用Python写出功能很强的执行脚本,个人觉得比bash好用一些。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,829评论 1 331
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,603评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,846评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,600评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,780评论 3 272
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,695评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,136评论 2 293
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,862评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,453评论 0 229
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,942评论 2 233
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,347评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,790评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,293评论 3 221
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,839评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,448评论 0 181
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,564评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,623评论 2 249

推荐阅读更多精彩内容