Python argparse.ArgumentParser用法

最新推荐文章于 2026-04-26 20:49:16 发布

原创最新推荐文章于 2026-04-26 20:49:16 发布 · 792 阅读

3 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#python

Python 专栏收录该内容

6 篇文章

订阅专栏

Python的argparse模块用于解析命令行选项和参数，简化了程序与命令行交互的过程。它支持创建帮助和使用说明，提供默认值，并能优雅地处理错误。通过创建ArgumentParser对象，添加optional和positional arguments，可以构建灵活的命令行接口。例如，使用add_argument方法定义参数，并设置description、help和default属性。当运行程序并使用--help选项时，将显示详细的使用信息。

argparse 是Python一个模块。是作为程序的命令行选项、参数和子命令解析器。

主要作用：

1、可以让程序定义需要的参数，然后从 sys.argv 解析出对应的参数。

2、生成帮助说明，在用户传入无效参数时提示异常信息。

使用方式如下：

    # 创建一个 ArgumentParser 对象
    parser = argparse.ArgumentParser(description='test argparse')

    # 添加程序参数：可选参数（optional arguments）/必选参数（positional arguments）
    # optional arguments 写法
    parser.add_argument('-args1',
                        dest='int',
                        help='args1. 第一个参数填写数字1',
                        default='1')

    # positional arguments 写法有两种，如下，实际意义一样：
    # 写法一
    parser.add_argument(dest='args2',
                        help='args2. 第二个参数填写数字2',
                        default='2')
    # 写法二
    parser.add_argument('args3',
                        help='args3. 第三个参数填写数字3',
                        default='3')

optional arguments 和 positional arguments 区别：optional 是可以省略，而 positional 不可省略

description 对程序的简介

help 参数提示

default 表示默认值

执行程序的 --help 可以看到提示如下：

E:\pythonDemo\test>test.exe --help
usage: test.exe [-h] [-args1 int] args2 args3

test argparse

positional arguments:
  args2              args2. 第二个参数填写数字2
  args3              args3. 第三个参数填写数字3

optional arguments:
  -h, --help        show this help message and exit
  -args1 int        args1. 第一个参数填写数字1