Python 基础(二十一):argparse 模块

本文涉及的产品
云解析DNS,个人版 1个月
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介: Python argparse 模块

1. 简介

argparse 模块主要用于处理 Python 命令行参数和选项,程序定义好所需参数后,该模块会通过 sys.argv 解析出那些参数;除此之外,argparse 模块还会自动生成帮助和使用手册,并在用户给程序传入无效参数时报出错误信息。使用 argparse 模块,我们可以轻松的编写出用户友好的命令行接口。

2. 使用

我们先来看一个简单示例:

import argparse

# 创建解析对象
parser = argparse.ArgumentParser()
# 解析
parser.parse_args()

文件名为 test.py,在控制输入命令:python test.py --help,执行结果:

usage: test.py [-h]

optional arguments:
  -h, --help  show this help message and exit

通过上面的执行结果,我们可以看出 Python 的可选参数包括:--help 和其简写 -h,Python 使用 - 来指定短参数,使用 -- 来指定长参数 ,我们执行一下 python test.py -h,执行结果:

usage: test.py [-h]

optional arguments:
  -h, --help  show this help message and exit

如果使用未定义的参数会报错,如:执行命令 python test.py -a,执行结果:

usage: test.py [-h]
test.py: error: unrecognized arguments: -a

接下来我们看一下如何自定义参数,因为上面示例中 ArgumentParser()parse_args() 函数,我们还没有详细说,所以这里我们也具体看一下:

ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True)

这个方法是用来创建解析器对象的,看一下方法中每一个参数的含义:

  • prog:程序的名称(默认:sys.argv[0])

  • usage:描述程序用途的字符串(默认值:从添加到解析器的参数生成)

  • description:在参数帮助文档之前显示的文本(默认值:无)

  • epilog:在参数帮助文档之后显示的文本(默认值:无)

  • parents:一个 ArgumentParser 对象的列表,它们的参数也应包含在内

  • formatter_class:用于自定义帮助文档输出格式的类

  • prefix_chars:可选参数的前缀字符集合(默认值:'-')

  • fromfile_prefix_chars:当需要从文件中读取其他参数时,用于标识文件名的前缀字符集合(默认值:None)

  • argument_default:参数的全局默认值(默认值: None)

  • conflict_handler:解决冲突选项的策略(通常是不必要的)

  • add_help:为解析器添加一个 -h/--help 选项(默认值: True)

  • allow_abbrev:如果缩写是无歧义的,则允许缩写长选项 (默认值:True)

parse_args(args=None, namespace=None)

用来解析参数,看一下参数说明:

  • args:要分析的字符串列表,默认取自 sys.argv

  • namespace:命名空间

add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

定义单个的命令行参数应当如何解析,看一下参数说明:

  • name or flags:一个命名或者一个选项字符串的列表,例如:-f,--foo

  • action:当参数在命令行中出现时使用的动作基本类型

  • nargs:命令行参数应当消耗的数目

  • const:被一些 action 和 nargs 选择所需求的常数

  • default:当参数未在命令行中出现时使用的值

  • type:命令行参数应当被转换成的类型

  • choices:可用的参数的容器

  • required:此命令行选项是否可省略

  • help:一个选项作用的简单描述

  • metavar:在使用方法消息中使用的参数值示例

  • dest:被添加到 parse_args() 所返回对象上的属性名

下面我们通过具体示例看一下:

import argparse

parser = argparse.ArgumentParser()
parser.add_argument(
        '-n', '--name', dest='rname', required=True,
        help='increase output name'
    )
args = parser.parse_args()
name = args.rname
print('Hello', name)

先在控制台执行命令 python test.py -h,执行结果:

usage: test.py [-h] -n RNAME

optional arguments:
  -h, --help            show this help message and exit
  -n RNAME, --name RNAME
                        increase output name

我们可以看到参数已经添加进来了,接着执行命令 python test.py -n Jhonpython test.py --name Jhon,执行结果:

Hello Jhon

从结果可以看出我们已经获取了控制台中输入的参数值了。

相关文章
|
4天前
|
XML 数据格式 Python
Python的`import`用于加载模块,基础形式是`import module`,全量导入
【6月更文挑战第23天】Python的`import`用于加载模块,基础形式是`import module`,全量导入;`from module import name`选择性导入部分,减少命名空间污染;`from module import *`导入所有(不推荐),易引发冲突。别名导入如`from math import sqrt as square_root`可避免冲突。包导入用`.`,如`import xml.etree.ElementTree as ET`。
24 8
|
4天前
|
XML 数据格式 Python
在Python中,导入其他模块是通过使用import语句完成的
在Python中导入模块涉及`import`语句的不同用法:1) `import math`导入整个标准库;2) `from math import sqrt`导入单个函数;3) `import numpy as np`使用别名;4) `from random import *`导入所有(不推荐);5) `import xml.etree.ElementTree as ET`导入子模块;6) 使用`importlib.import_module()`延迟导入;7) `from .module import func`导入相对路径模块,需管理`sys.path`。
26 6
|
1天前
|
Python
python--os模块
python--os模块
8 2
|
1天前
|
Python
python-time模块
python-time模块
5 1
|
3天前
|
算法 数据安全/隐私保护 开发者
Python logger模块详细讲解
Python logger模块详细讲解
13 3
|
4天前
|
Python
Python的`os`模块核心功能概述:通过`os.getcwd()`获取
【6月更文挑战第23天】Python的`os`模块核心功能概述:通过`os.getcwd()`获取、`os.chdir()`改变工作目录;使用`os.mkdir()`, `os.makedirs()`创建目录,`os.rmdir()`, `os.removedirs()`删除;`os.rename()`, `os.renames()`重命名文件或目录;`os.remove()`删除文件;`os.listdir()`列出目录内容;`os.path.exists()`, `os.path.isfile()`, `os.path.isdir()`检查路径;`os.stat()`获取文件属性。
17 4
|
4天前
|
XML 数据格式 Python
Python模块导入包括:`import math`导入标准库
【6月更文挑战第23天】Python模块导入包括:`import math`导入标准库,`from math import sqrt`导入单个函数,`import numpy as np`给模块取别名,`from random import *`导入所有(不推荐),`import xml.etree.ElementTree as ET`导入子模块,`import_module('pandas')`按需导入,和使用相对路径如`from .module import func`处理项目结构。记得调整`sys.path`以包含自定义模块路径。
16 4
|
3天前
|
Linux Python
Python- jinja2模块详解
Python- jinja2模块详解
|
8天前
|
JSON Java API
Python教程:一文了解Python requests模块
Python 中的 requests 模块是一个简洁而强大的 HTTP 库,用于向 Web 服务器发送 HTTP 请求和处理响应。它让开发者能够更轻松地与网络资源进行交互,包括发送 GET、POST、PUT、DELETE 等类型的请求,并处理返回的数据。
42 6
|
8天前
|
Python
Python中的模块对象__package__
【6月更文挑战第13天】
14 5

热门文章

最新文章