argparse

argparse 是 Python 内置的一个用于命令项选项与参数解析的模块,通过在程序中定义好我们需要的参数,argparse 将会从 sys.argv 中解析出这些参数,并自动生成帮助和使用信息。当然,Python 也有第三方的库可用于命令行解析,而且功能也更加强大,比如 docopt,Click。

argparse 使用

简单示例

我们先来看一个简单示例。主要有三个步骤:

  • 创建 ArgumentParser() 对象
  • 调用 add_argument() 方法添加参数
  • 使用 parse_args() 解析添加的参数
# -*- coding: utf-8 -*-import argparseparser = argparse.ArgumentParser()
parser.add_argument('integer', type=int, help='display an integer')
args = parser.parse_args()print args.integer

将上面的代码保存为文件 argparse_usage.py,在终端运行,结果如下:

$ python argparse_usage.py
usage: argparse_usage.py [-h] integer
argparse_usage.py: error: too few arguments$ python argparse_usage.py abcd
usage: argparse_usage.py [-h] integer
argparse_usage.py: error: argument integer: invalid int value: 'abcd'$ python argparse_usage.py -h
usage: argparse_usage.py [-h] integerpositional arguments:integer     display an integeroptional arguments:-h, --help  show this help message and exit$ python argparse_usage.py 10
10

定位参数

上面的示例,其实就展示了定位参数的使用,我们再来看一个例子 - 计算一个数的平方:

# -*- coding: utf-8 -*-import argparseparser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number", type=int)
args = parser.parse_args()
print args.square**2

将上面的代码保存为文件 argparse_usage.py,在终端运行,结果如下:

$ python argparse_usage.py 9
81

可选参数

现在看下可选参数的用法,所谓可选参数,也就是命令行参数是可选的,废话少说,看下面例子:

# -*- coding: utf-8 -*-import argparseparser = argparse.ArgumentParser()parser.add_argument("--square", help="display a square of a given number", type=int)
parser.add_argument("--cubic", help="display a cubic of a given number", type=int)args = parser.parse_args()if args.square:print args.square**2if args.cubic:print args.cubic**3

将上面的代码保存为文件 argparse_usage.py,在终端运行,结果如下:

$ python argparse_usage.py --h
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]optional arguments:-h, --help       show this help message and exit--square SQUARE  display a square of a given number--cubic CUBIC    display a cubic of a given number$ python argparse_usage.py --square 8
64$ python argparse_usage.py --cubic 8
512$ python argparse_usage.py 8
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]
argparse_usage.py: error: unrecognized arguments: 8$ python argparse_usage.py  # 没有输出

混合使用

定位参数和选项参数可以混合使用,看下面一个例子,给一个整数序列,输出它们的和或最大值(默认):

import argparseparser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',const=sum, default=max,help='sum the integers (default: find the max)')args = parser.parse_args()
print args.accumulate(args.integers)

结果:

$ python argparse_usage.py
usage: argparse_usage.py [-h] [--sum] N [N ...]
argparse_usage.py: error: too few arguments
$ python argparse_usage.py 1 2 3 4
4
$ python argparse_usage.py 1 2 3 4 --sum
10

add_argument() 方法

add_argument() 方法定义如何解析命令行参数:

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

每个参数解释如下:

  • name or flags - 选项字符串的名字或者列表,例如 foo 或者 -f, --foo。
  • action - 命令行遇到参数时的动作,默认值是 store。
    • store_const,表示赋值为const;
    • append,将遇到的值存储成列表,也就是如果参数重复则会保存多个值;
    • append_const,将参数规范中定义的一个值保存到一个列表;
    • count,存储遇到的次数;此外,也可以继承 argparse.Action 自定义参数解析;
  • nargs - 应该读取的命令行参数个数,可以是具体的数字,或者是?号,当不指定值时对于 Positional argument 使用 default,对于 Optional argument 使用 const;或者是 * 号,表示 0 或多个参数;或者是 + 号表示 1 或多个参数。
  • const - action 和 nargs 所需要的常量值。
  • default - 不指定参数时的默认值。
  • type - 命令行参数应该被转换成的类型。
  • choices - 参数可允许的值的一个容器。
  • required - 可选参数是否可以省略 (仅针对可选参数)。
  • help - 参数的帮助信息,当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
  • metavar - 在 usage 说明中的参数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写的参数名称.
  • dest - 解析后的参数名称,默认情况下,对于可选参数选取最长的名称,中划线转换为下划线.

转载自: http://wiki.jikexueyuan.com/project/explore-python/Standard-Modules/argparse.html

Python 中的解析命令行参数相关推荐

  1. python使用argparse解析命令行参数

    python使用argparse解析命令行参数 你的程序如何能够解析命令行选项(位于sys.argv中) #示意使用sys.argv进行参数解析: #注意,sys.argv中第0个索引是函数本身,所以 ...

  2. 如何在Java中解析命令行参数?

    在Java中解析命令行参数的好方法是什么? #1楼 我不建议使用Apache Common CLI库,因为它是非线程安全的. 它使用带有静态变量和方法的有状态类来进行内部工作(例如OptionBuil ...

  3. python 命令-python解析命令行参数的三种方法详解

    这篇文章主要介绍了python解析命令行参数的三种方法详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 python解析命令行参数主要有三种方法: ...

  4. python getopt使用_Python命令行参数解析模块getopt使用实例

    这篇文章主要介绍了Python命令行参数解析模块getopt使用实例,本文讲解了使用语法格式.短选项参数实例.长选项参数实例等内容,需要的朋友可以参考下 格式 getopt(args, options ...

  5. Python3中使用argparse模块解析命令行参数

    argparse是Python的一个标准模块,用于解析命令行参数,即解析sys.argv中定义的参数.实现在:https://github.com/python/cpython/blob/main/L ...

  6. C语言中使用库函数解析命令行参数

    在编写需要命令行参数的C程序的时候,往往我们需要先解析命令行参数,然后根据这些参数来启动我们的程序. C的库函数中提供了两个函数可以用来帮助我们解析命令行参数:getopt.getopt_long. ...

  7. 在C#中解析命令行参数的最佳方法? [关闭]

    构建带有参数的控制台应用程序时,可以使用传递给Main(string[] args) . 过去,我只是索引/循环该数组,并做了一些正则表达式来提取值. 但是,当命令变得更复杂时,解析可能会变得很丑陋. ...

  8. python输入正方形边长值、计算其面积_尝试修改列6.2编写命令行参数解析的程序,解析命令行参数所输入边长的值,计算并输出正方形的周长和面积。_学小易找答案...

    [简答题] [单选题]ZigBee 中每个协调点最多可连接______个节点,一个ZigBee网络最多可容纳______个节点.( ) [资料题]DWord-Ans.pdf 索引和目录.pdf 完成效 ...

  9. python argparse 解析命令行参数

    argparse包用于解析命令行参数, import argparse # parse parameter parser = argparse.ArgumentParser(description=' ...

最新文章

  1. 总也学不会Linux命令行?这本新书大概率能拯救你!
  2. 记录一个超分辨率算法项目,来自B站
  3. JS动态添加多个事件
  4. linux磁盘分区fdisk命令详解
  5. 【前端】前端笔试题 [1]
  6. 使用VLC转码,在HTML5页面播放实时监控
  7. Github git clone国内mirror加速
  8. 如何为火狐浏览器添加附加组件?火狐浏览器附加组件管理器使用教程
  9. Adobe 2022软件安装错误代码107解决办法
  10. C#内存流示例-----gt;用内存流来读取图片
  11. 【效果图】门户网首页模板一 (类似CSDN)
  12. 远程服务器存储之JSON
  13. 机器学习很难上手和提升?你只差一条学习路径!
  14. c语言设计二级考试程序修改题,全国计算机c语言二级考试试题
  15. w ndows7安不上HP1020,1020打印机驱动
  16. HDU 6318 Swaps and inversions
  17. Java后台埋点统计
  18. 【转】什么是公网安备
  19. Delphi与Windows 7下的用户账户控制(UAC)机制(加小盾牌),注册表没反应
  20. vue使用 element-ui 禁止 DateTimePicker 选择时间

热门文章

  1. JAVA补充-抽象类
  2. 追本溯源 —— 汉语词汇含义的演化
  3. 我的第一个项目(人力资源管理之报表管理)
  4. DOM 节点的创建、删除、替换
  5. C#制作WinForm控件
  6. Eclipse环境下面的配置(转载)
  7. jQuery教程10-表单元素选择器
  8. python如何写一个图片进去_python写个图片爬虫
  9. ubuntupython损坏_修复损坏的Python3.2安装(Ubuntu)
  10. nexus 仓库类型_Maven私服Nexus的搭建