python中argparse使用方法介绍

86 阅读3分钟

argparse 是 Python 标准库中用于解析命令行参数的模块,它可以帮助你编写命令行界面友好的程序,让用户能够轻松地与你的脚本进行交互。以下是一些使用 argparse 的基本步骤:

  1. 导入 argparse 模块:
import argparse
  1. 创建 ArgumentParser 对象,这个对象会保存所有定义的命令行参数:
parser = argparse.ArgumentParser(description='描述你的脚本是做什么的')
  1. 使用 add_argument 方法定义命令行参数。每个参数可以有名称、缩写、帮助信息等。
parser.add_argument('arg_name', type=str, help='参数的帮助信息')

其中 'arg_name' 是参数的名称,type 是参数的类型,help 是参数的帮助信息。

  1. 解析命令行参数:
args = parser.parse_args()
  1. 使用 args 对象来访问解析后的参数值:
print(args.arg_name)

这是一个简单的示例,演示如何使用 argparse 解析一个命令行参数:

import argparse

def main():
    parser = argparse.ArgumentParser(description='一个简单的命令行参数示例')
    parser.add_argument('name', type=str, help='你的名字')
    args = parser.parse_args()
    print(f'你好,{args.name}!')

if __name__ == '__main__':
    main()

在命令行中运行这个脚本,例如:

python my_script.py Alice

将会输出:

你好,Alice!

你提供的信息总结了 argparse 的一些常用参数,让我再次列出它们以供参考:

  1. name or flags:参数的名称或缩写,用于在命令行中标识该参数。可以是单个名称(例如 'foo')或一组选项字符串(例如 '-f', '--foo')。

  2. action:定义参数的处理方式,决定如何处理命令行中的参数值。常见的选项包括 'store''store_const''store_true''store_false''append''count' 等。

  3. nargs:指定参数接受的命令行参数数量。常见的选项包括 '?''*''+' 等,用于表示可选参数值的数量。

  4. const:与某些 actionnargs 选项一起使用,指定参数的常量值。

  5. default:参数的默认值,在命令行中未提供该参数时使用。

  6. type:指定参数值应转换为的数据类型,例如 intfloatstr 等。

  7. choices:定义参数可以接受的合法值的序列,用户输入的值必须在此序列中选择。

  8. required:指示参数是否为必需的,如果为 True,则该参数在命令行中必须提供。

  9. help:为参数提供帮助信息,用于生成帮助文档时显示参数的描述。

  10. metavar:参数在使用消息中的名称,通常用于生成帮助文档。

  11. dest:指定参数值存储在解析后的命名空间对象中的属性的名称。

这些参数允许你定义和自定义命令行参数的各个方面,以便创建更加灵活和用户友好的命令行界面。根据你的需求,你可以选择性地设置这些参数来满足你的脚本的要求。

argparse 还支持许多其他功能,你可以根据你的需求查看官方文档以了解更多详细信息:docs.python.org/3/library/a…