Python 模块的命令行argparse

本文详细介绍Python的argparse模块,解析如何定义和解析命令行参数,包括位置参数和可选参数,通过实例展示如何使用argparse模块增强脚本的灵活性。

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

argparse模块https://docs.python.org/3/library/argparse.html

命令行参数的类型分为以下两种:

positional argument:位置参数,顾名思义,在命令行输入时,必须按照定义的顺序

optional argument:可选参数,在命令行中可以定义该参数的值,也可以不定义

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#输入argparse模块
import argparse
#定义一个类ArgumentParser的对象
parser=argparse.ArgumentParser(description='test_argparse')
#print(type(parser))#<class 'argparse.ArgumentParser'>
#开始定义自己需要的参数
#定义一个参数,该参数的前缀是'-'或者'--',代表是可选参数(optional argument)
parser.add_argument('-i','--integers',default=66000,type=int,
                    help='an integer default %(default)s')
#
parser.add_argument('-x1','--x111',help='x1',default=10)
parser.add_argument('-x2',help='x2',default=100)
#定义一个参数,该参数前缀没有'-'或者'--',该参数的类型是positional argument
parser.add_argument('x3',default='name')#print(args.x2)
#这一行很重要代表分析出,从命令行输出的对应参数的值
args =parser.parse_args()
#
if __name__=='__main__':
    print(args)
    #print(args.i)#这一行是错的,如果后面有对应的'--',必须采用以下代码
    print(args.integers)
    #
    print(args.x111)
    print(args.x2)
    #
    print(args.x3)

 从终端以上代码,假设以上程序代码保存在一个名称为untitled0.py的文件中。

在终端输入:

python untitled0.py -h

或者

 

python untitled0.py --help

 会打印出如何使用该脚本文件的帮助说明,如下所示:

usage: untitled0.py [-h] [-i INTEGERS] [-x1 X111] [-x2 X2] x3

test_argparse

positional arguments:
  x3

optional arguments:
  -h, --help            show this help message and exit
  -i INTEGERS, --integers INTEGERS
                        an integer default 66000
  -x1 X111, --x111 X111
                        x1
  -x2 X2                x2

 运行该脚本文件:

python untitled0.py -i 20 -x1 200 -x2 2000 'num'

打印结果如下:

Namespace(integers=20, x111='200', x2='2000', x3='num')
20
200
2000
num

 

### 使用 `argparse` 解析命令行参数 在 Python 中,`argparse` 模块是一个强大的工具,专门用于解析命令行参数和选项。这使得编写用户友好型命令行接口变得容易得多[^1]。 #### 创建 ArgumentParser 对象 要开始使用 `argparse`,首先需要创建一个 `ArgumentParser` 实例来描述程序的功能以及其接受的命令行参数: ```python import argparse parser = argparse.ArgumentParser(description="这是一个测试解析器") ``` 这段代码初始化了一个新的解析器实例,并提供了一条简短的帮助信息给最终用户[^4]。 #### 添加参数 接下来,可以向这个解析器添加期望接收的位置参数或可选参数。对于必需的位置参数来说,只需指定参数名即可: ```python parser.add_argument('test', help='这是必填项') ``` 上述语句定义了一个名为 `test` 的位置参数,当运行脚本时不带此参数将会触发错误提示并显示帮助消息[^2]。 除了位置参数外,还可以轻松地增加带有前缀 `-` 或者 `--` 的可选参数。例如,下面的例子展示了如何添加两个不同类型的开关参数: ```python parser.add_argument('-v', '--verbose', action='store_true', help='启用详细模式') parser.add_argument('--count', type=int, default=1, help='设置计数次数,默认为1次') ``` 这里定义了两个额外的参数:一个是布尔标志 (`-v`, `--verbose`) ,另一个是指定整数值(`--count`) 。如果提供了这些参数,则会按照设定的方式存储它们;如果没有给出具体值的话则采用默认配置[^3]。 #### 执行解析过程 完成所有必要的参数声明后,就可以调用 `.parse_args()` 方法来进行实际的数据收集工作: ```python args = parser.parse_args() print(f"Test argument is {args.test}") if args.verbose: print("Verbose mode enabled.") for _ in range(args.count): print("Counting...") ``` 以上片段完成了整个流程的最后一部分—获取传递过来的实际参数并将之赋值给了变量 `args`. 接下来可以根据需求访问各个属性以执行相应的逻辑操作.
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值