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.verboseTrue。因为没提供-o ×××参数,故args.outfileNone

(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

参考

Python技法:用argparse模块解析命令行选项的更多相关文章

  1. python 解析命令行选项

    问题: 程序如何能够解析命令行选项 解决方案 argparse 模块可被用来解析命令行选项 argparse 模块 argparse 模块是标准库中最大的模块之一,拥有大量的配置选项 dest 参数指 ...

  2. python模块----optparse模块、argparse模块 (命令行解析模块)

    简介 optparse module---自版本3.2以来已弃用:optparse模块已弃用,将不再进一步开发:将继续使用argparse模块进行开发.optparse使用一种更具声明性的命令行解析方 ...

  3. optparse模块解析命令行参数的说明及优化

    一.关于解析命令行参数的方法 关于“解析命令行参数”的方法我们一般都会用到sys.argv跟optparse模块.关于sys.argv,网上有一篇非常优秀的博客已经介绍的很详细了,大家可以去这里参考: ...

  4. python argparse模块解析命令行选项简单使用

    argparse模块的解析命令行选项简单使用 util.py #!/usr/bin/env python # coding=utf-8 import argparse parser = argpars ...

  5. Python内置的一个用于命令项选项与参数解析的模块argparse

    一.argparse简单使用 我们先来看一个简单示例.主要有三个步骤: 创建 ArgumentParser() 对象 调用 add_argument() 方法添加参数 使用 parse_args() ...

  6. python解析命令行参数

    常常需要解析命令行参数,经常忘记,好烦,总结下来吧. 1.Python 中也可以所用 sys 的 sys.argv 来获取命令行参数: sys.argv 是命令行参数列表 参数个数:len(sys.a ...

  7. python学习之argparse模块

    python学习之argparse模块 一.简介: argparse是python用于解析命令行参数和选项的标准模块,用于代替已经过时的optparse模块.argparse模块的作用是用于解析命令行 ...

  8. python学习之argparse模块的使用

    以下内容主要来自:http://wiki.jikexueyuan.com/project/explore-python/Standard-Modules/argparse.html argparse ...

  9. 使用ACE_Get_Opt解析命令行

    当我们用C++开发一些C++控制台小工具时,会需要一些用户输入的参数来决定程序如何工作和执行,而用户输入参数的方式大部分都是采用命令行参数的方式. 比如上一篇文章 玩转Windows服务系列--命令行 ...

随机推荐

  1. pandas数据读取

    02. Pandas读取数据 本代码演示: pandas读取纯文本文件 读取csv文件 读取txt文件 pandas读取xlsx格式excel文件 pandas读取mysql数据表 1.读取纯文本文件 ...

  2. 如何解决Visual Studio 2017 运行后控制台窗口一闪就消失了

    出现这种情况的原因 安装使用Visual Studio 2017 后,用Ctrl+F5运行程序,结果控制台窗口一闪就没了,也没有出现"press any key to continue-&q ...

  3. poj_1852_Ants(复杂问题简单化)

    原题传送门 描述 一群蚂蚁走在长度为l cm的水平细杆上,以1cm/s的匀速.当一只行走的蚂蚁到达杆的一端,它就会掉下去.当两只蚂蚁相遇,它们会掉头像反方向走去.我们知道一只蚂蚁在杆上的初始位置,然而 ...

  4. 小程序wx.createInnerAudioContext()获取不到时长问题

    最近在开发小程序中,需要用到音频播放功能.但在初始化时,使用InnerAudioContext.duration获取不到音频的时长. Page({ /** * 生命周期函数--监听页面初次渲染完成 * ...

  5. vuex基础详解

    vuex入门 安装 vuex为我们提供了两种使用方法 直接引入 vuex下载地址:https://unpkg.com/vuex@2.0.0 下载之后用< script >标签包裹引入即可 ...

  6. 安卓性能测试之Lint测试

    pre { direction: ltr; color: rgba(0, 0, 10, 1); text-align: left } pre.western { font-family: " ...

  7. FastAPI(七十一)实战开发《在线课程学习系统》接口开发-- 查看留言

    之前FastAPI(七十)实战开发<在线课程学习系统>接口开发--留言功能开发分享了留言开发,这次我们分享查看留言 梳理这里的逻辑,这个接口要依赖登录. 1.判断用户是否登录 2.判断对应 ...

  8. SpringBoot2.x修改Redis序列化方式

    添加一个配置类即可: /** * @Author FengZeng * @Date 2022-03-22 13:43 * @Description TODO */ @Configuration pub ...

  9. oracle执行sql查询语句出现错误ORA-00942:表或视图不存在

    情况是这样,A库的用户名和表空间分别为SH , SH 把业务表SH所有数据从A库,导入到B库, 表空间为SH,用户名为SP 在B库里面执行sql查询语句出现错误ORA-00942:表或视图不存在 语句 ...

  10. 【二进制枚举】【CF Div2 C】

    2022.3.4  https://codeforces.com/contest/1646/problem/C 题意: 给一个数, 问可以最少有几个以下的数构成: 1.x! 2.2^x(x在每次都是任 ...