Python的argparse库使用详解

  • Z时代
  • 2024-01-10
  • 分类：综合

argparse是python标准库里面用来处理命令行参数的库

命令行参数分为位置参数和选项参数：

位置参数就是程序根据该参数出现的位置来确定的

如：[root@openstack_1 /]# ls root/    #其中root/是位置参数

选项参数是应用程序已经提前定义好的参数，不是随意指定的

如：[root@openstack_1 /]# ls -l    # -l 就是ls命令里的一个选项参数、

基本使用

import argparse
# 创建解析器
parser = argparse.ArgumentParser(description = 'This is a test')
parser.parse_args()

可以在shell中测试：

$ python test.py --help
...

添加参数

import argparse
parser = argparse.ArgumentParser(description = 'This is a test')
parser.add_argument("-p","--port",help='increase output port') # 定义了可选参数-p和--port，赋值后，其值保存在args.port中(其值都是保存在最后一个定义的参数中)
args = parser.parse_args()
print(args.echo)

argparse.ArgumentParser（）方法参数须知：一般我们只选择用description

          prog=None     - 程序名

          description=None,    - help时显示的开始文字

           epilog=None,     - help时显示的结尾文字

          parents=[],        -若与其他参数的一些内容一样，可以继承

          formatter_class=argparse.HelpFormatter,     - 自定义帮助信息的格式

          prefix_chars='-',    - 命令的前缀，默认是‘-'

          fromfile_prefix_chars=None,     - 命令行参数从文件中读取

          argument_default=None,    - 设置一个全局的选项缺省值，一般每个选项单独设置

          conflict_handler='error',     - 定义两个add_argument中添加的选项名字发生冲突时怎么处理，默认处理是抛出异常

          add_help=True    - 是否增加-h/--help选项，默认是True)

add_argument()方法参数须知：

    name or flags...    - 必选，指定参数的形式，一般写两个，一个短参数，一个长参数

使用时候：

$ python test.py -p 50
或
$ python test.py --port 50

指定类型

我们也可以在添加参数的时候指定其类型。

import argparse
parser = argparse.ArgumentParser(description = 'This is a test')
parser.add_argument("square",help="display a given number",type=int) # 指定给square的参数为int类型

可选参数

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

使用：

$ python test.py -v any

文档

更多应用请百度或者查文档：https://docs.python.org/3/library/argparse.html#module-argparse

以上是 Python的argparse库使用详解 的全部内容， 来源链接： utcz.com/z/348158.html

回到顶部