Python技法:用argparse模块解析命令行选项
1. 用argparse模块解析命令行选项
我们在上一篇博客《Linux:可执行程序的Shell传参格式规范》中介绍了Linux系统Shell命令行下可执行程序应该遵守的传参规范(包括了各种选项及其参数)。Python命令行程序做为其中一种,其传参中也包括了位置参数(positional arguments)和可选参数(optional arguments):
(注意,可选参数的选项名称以--
或-
打头,位置参数和可选参数的先后顺序可以任意排布)
那么在Python程序中我们如何解析在命令行中提供的各种选项呢?(选项保存在sys.argv
中)我们可以使用argparse
模块。我们用下面这个search.py
程序做例子:
1.1 创建parser对象
首先我们需要创建parser
对象:
import argparse
parser = argparse.ArgumentParser(description="search some files")
1.2 添加选项声明
然后使用parser.add_argument()
方法添加想要支持的选项声明。add_argument()
的调用参数承担了不同的功能:
dest
指定了用来保存解析结果的属性名称。metavar
用于显示帮助信息,如果不指定则默认为大写的属性名。action
指定了与参数处理相关的行为(store
表示存储单个值,append
表示将多个值存到一个列表中)。
我们尝试依次添加如下选项声明进行测试:
解析位置参数
parser.add_argument(dest="filenames", metavar="filename", nargs="*")
该参数为位置参数,不需要像可选参数的选项一样用-
或--
打头。位置参数一般是必须要提供的(虽然这里你不提供也能保存为[]
)。nargs="*"
表示将所有额外命令行参数保存在一个列表中。
解析可选参数
parser.add_argument("-p", "--pat", metavar="pattern", required=True, dest="patterns", action="append", help="text pattern to search for")
-p
和--pat
两种选项名称都可接收(前者是简写,后者是全称)。我们在上一篇博客说过,在调用Shell命令时规定对于简写的选项名用-p ××
形式传参,对于全称的选项名我们有--pat ××
和--pat=××
两种形式。不过Python脚本时你用-p=××
也能解析,不过一般不建议这样搞。action="append"
意为允许命令行参数重复多次,将所有参数值保存在列表中,require=True
意味着参数必须要提供一次。
parser.add_argument("-v", dest="verbose", action="store_true", help="verbose mode")
store_true
意思为设定为一个布尔标记,标记的值取决于参数是否有提供。
parser.add_argument("-o", dest="outfile", action="store", help="output file")
类似上面,这里store
意思为接收一个单独的值并保存为字符串
parser.add_argument("--speed", dest="speed", action="store", choices={"slow", "fast"}, default="slow", help="search speed")
同上,该参数也是接受一个值,但只能在特定范围中{"slow", "fast"}
中选择,且默认"slow""
。
1.2 解析选项
然后我们就可以解析选项并使用传入的参数了:
args = parser.parse_args()
# 注意在使用参数时,是用的参数的dest名字
print(args.filenames)
print(args.patterns)
print(args.verbose)
print(args.outfile)
print(args.speed)
2. 测试
以上的程序定义了一个命令解析器,我们可以设置-h
选项查看其用法:
(base) orion-orion@MacBook-Pro Python-Lang % python search.py -h
usage: search.py [-h] -p pattern [-v] [-o OUTFILE] [--speed {slow,fast}] [filename ...]
search some files
positional arguments:
filename
optional arguments:
-h, --help show this help message and exit
-p pattern, --pat pattern
text pattern to search for
-v verbose mode
-o OUTFILE output file
--speed {slow,fast} search speed
接下来我们展示数据在程序中的显示方式。比如我们尝试不传入必需的-p/--pat
选项参数:
(base) orion-orion@MacBook-Pro Python-Lang % python search.py foo.txt bar.txt
usage: search.py [-h] -p pattern [-v] [-o OUTFILE] [--speed {slow,fast}] [filename ...]
search.py: error: the following arguments are required: -p/--pat
如上所示,解释器会提醒我们参数没传入。我们注意到usage
中-p pattern
并没有加方括号[]
,说明该参数不是可选的,必须要提供。
接下来我们提供完整参数,大家可以仔细观察print()
语句的输出:
(base) orion-orion@MacBook-Pro Python-Lang % python search.py -v -p spam --pat=eggs foo.txt bar.txt
['foo.txt', 'bar.txt']
['spam', 'eggs']
True
None
slow
可以看到如上所示,因为提供了参数-v
,故args.verbose
为True
。因为没提供-o ×××
参数,故args.outfile
为None
。
(base) orion-orion@MacBook-Pro Python-Lang % python search.py -v -p spam --pat=eggs foo.txt bar.txt -o results
['foo.txt', 'bar.txt']
['spam', 'eggs']
True
results
slow
可以看到如上所示,设置了提供了-o results
,故args.outfile
打印结果为results
。
(base) orion-orion@MacBook-Pro Python-Lang % python search.py -v -p spam --pat=eggs foo.txt bar.txt -o results --speed=fast
['foo.txt', 'bar.txt']
['spam', 'eggs']
True
results
fast
如上所示为提供了可选参数--speed
的情况。
3. 讨论
一旦选项给出后,我们只需要简单地执行parser.parse()
方法。这么做会处理sys.argv
的值,并返回结果实例。如果我们手动处理sys.argv
或者使用getopt
模块(仿照类似的C库打造),就会重复编写许多argparse
已经提供的代码,因此在新项目中应该优先选择argparse
。
参考
- [1] Martelli A, Ravenscroft A, Ascher D. Python cookbook[M]. " O'Reilly Media, Inc.", 2015.
- [2] https://docs.python.org/3/howto/argparse.html#id1
Python技法:用argparse模块解析命令行选项的更多相关文章
- python 解析命令行选项
问题: 程序如何能够解析命令行选项 解决方案 argparse 模块可被用来解析命令行选项 argparse 模块 argparse 模块是标准库中最大的模块之一,拥有大量的配置选项 dest 参数指 ...
- python模块----optparse模块、argparse模块 (命令行解析模块)
简介 optparse module---自版本3.2以来已弃用:optparse模块已弃用,将不再进一步开发:将继续使用argparse模块进行开发.optparse使用一种更具声明性的命令行解析方 ...
- optparse模块解析命令行参数的说明及优化
一.关于解析命令行参数的方法 关于“解析命令行参数”的方法我们一般都会用到sys.argv跟optparse模块.关于sys.argv,网上有一篇非常优秀的博客已经介绍的很详细了,大家可以去这里参考: ...
- python argparse模块解析命令行选项简单使用
argparse模块的解析命令行选项简单使用 util.py #!/usr/bin/env python # coding=utf-8 import argparse parser = argpars ...
- Python内置的一个用于命令项选项与参数解析的模块argparse
一.argparse简单使用 我们先来看一个简单示例.主要有三个步骤: 创建 ArgumentParser() 对象 调用 add_argument() 方法添加参数 使用 parse_args() ...
- python解析命令行参数
常常需要解析命令行参数,经常忘记,好烦,总结下来吧. 1.Python 中也可以所用 sys 的 sys.argv 来获取命令行参数: sys.argv 是命令行参数列表 参数个数:len(sys.a ...
- python学习之argparse模块
python学习之argparse模块 一.简介: argparse是python用于解析命令行参数和选项的标准模块,用于代替已经过时的optparse模块.argparse模块的作用是用于解析命令行 ...
- python学习之argparse模块的使用
以下内容主要来自:http://wiki.jikexueyuan.com/project/explore-python/Standard-Modules/argparse.html argparse ...
- 使用ACE_Get_Opt解析命令行
当我们用C++开发一些C++控制台小工具时,会需要一些用户输入的参数来决定程序如何工作和执行,而用户输入参数的方式大部分都是采用命令行参数的方式. 比如上一篇文章 玩转Windows服务系列--命令行 ...
随机推荐
- 面试题目:手写一个LRU算法实现
一.常见的内存淘汰算法 FIFO 先进先出 在这种淘汰算法中,先进⼊缓存的会先被淘汰 命中率很低 LRU Least recently used,最近最少使⽤get 根据数据的历史访问记录来进⾏淘汰 ...
- Redis报错:DENIED Redis is running in protected mode
转:Redis使用认证密码登录 Redis默认配置是不需要密码认证的,也就是说只要连接的Redis服务器的host和port正确,就可以连接使用.这在安全性上会有一定的问题,所以需要启用Redis ...
- Javascript--function的name属性
1.非标准的name属性 function sayHi(){ console.log("Hi");} console.log(sayHi.name);
- JavaScript & 6小时了解ES6基本语法
一步一步似爪牙. 前言 学习es6之前我们可能并不知道es6相比es5差距在哪, 但是这并不妨碍我们站在巨人的肩膀上; 程序员就是要乐于尝鲜; 学习es6最终目的是结合es5 一起进行工程项目开发, ...
- 用Canvas画一棵二叉树
笔墨伺候 var canvas = document.getElementById('canvas'); var ctx = canvas.getContext('2d'); // 然后便可以挥毫泼墨 ...
- 前端面试题整理——webpack相关考点
webpack是开发工具,面试考点重点在配置和使用,原理理解不需要太深. 一.基本配置 1.拆分配置和merge 将公共配置跟dev和prod的配置拆分,然后通过webpack-merge对配置进行整 ...
- css使div居中
每次想要使div居中都会设置position:absolute;,发现设置其他控件位置时会出现问题,所以采用以下办法: margin:0 auto;
- 高频重要前端API手写整理(call,apply,bind,instanceof,flat,filter,new,防抖,节流,深浅拷贝,数组乱序,数组去重,继承, lazyman,jsonp的实现,函数的柯里化 )
Function.prototype.call = function(context,...args){ var context = context || window; context.fn = t ...
- 在create-react-app使用less与antd按需加载
使用antd按需加载 使用react-app-rewired对 create-react-app 的默认配置进行自定义 yarn add react-app-rewired --dev /* pack ...
- mongodb安装错误以及原理
安装mongodb,默认是安装到"C:\Program Files\MongoDB\"这里的,我在注册表里没有找到mongodb的信息,所以猜测它只是将其解压到那个位置而已,它只是 ...