Python argparse如何使用,argparse常见用法说明。

本文介绍了Python的argparse模块,用于解析命令行参数。文章详细阐述了argparse的创建对象、添加参数和解析参数三个步骤,并通过实例演示了其用法,帮助读者理解argparse的功能和操作流程。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

argparse 是什么

首先,argparse是python的一个常用模块。是python自带的命令行参数解析包,可以用来方便地读取命令行参数。argparse模块使编写用户友好的命令行界面变得容易。
使用步骤主要有三个步骤:

  1. 创建 ArgumentParser() 对象
  2. 调用 add_argument() 方法添加参数
  3. 使用 parse_args() 解析添加的参数

这样看可能你还不太明白,我们通过一个实例来学习一下他吧~

# _author_ lavinia
import argparse

parser = argparse.ArgumentParser() 
parser.add_argument('float', type=float, help='display an float')
args = parser.parse_args()

print args.float
首先第一步创建对象。

ArgumentParser () 包含将命令行解析成 Python 数据类型所需的全部信息。他的参数有:

  1. prog - 程序的名称(默认:sys.argv[0])
  2. usage - 描述程序用途的字符串(默认值:从添加到解析器的参数生成)
  3. description - 在参数帮助文档之前显示的文本(默认值:无)
  4. epilog - 在参数帮助文档之后显示的文本(默认值:无)
  5. parents - 一个 ArgumentParser 对象的列表,它们的参数也应包含在内
  6. formatter_class - 用于自定义帮助文档输出格式的类
  7. prefix_chars - 可选参数的前缀字符集合(默认值:’-’)
  8. fromfile_prefix_chars - 当需要从文件中读取其他参数时,用于标识文件名的前缀字符集合(默认值:None)
  9. argument_default - 参数的全局默认值(默认值: None)
  10. conflict_handler - 解决冲突选项的策略(通常是不必要的)
  11. add_help - 为解析器添加一个 -h/–help 选项(默认值: True)
  12. allow_abbrev - 如果缩写是无歧义的,则允许缩写长选项 (默认值:True)
第二步给解析器添加参数
ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

每个参数的意义如下:

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

实例

"test.py"
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 test.py 7

我们将得到上面栗子中的print 49.

参考:
https://wiki.jikexueyuan.com/project/explore-python/Standard-Modules/argparse.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值