Python 中使用 argparse 解析命令行参数

 更新时间:2021年11月15日 15:47:06   作者:Moshe Zadka  
这篇文章主要介绍了Python 中使用 argparse 解析命令行参数,argparse 模块是一个强大的命令行参数解析器,还有很多功能没能在这里介绍。下面文化在哪个详细介绍该内容,需要的朋友可以参考一下

使用 argparse 模块为应用程序设置命令行选项。

有一些第三方库用于命令行解析,但标准库 argparse 与之相比也毫不逊色。

无需添加很多依赖,你就可以编写带有实用参数解析功能的漂亮命令行工具。

1、Python 中的参数解析

使用 argparse 解析命令行参数时,第一步是配置一个 ArgumentParser 对象。这通常在全局模块内完成,因为单单_配置_一个解析器没有副作用。

import argparse
 
PARSER = argparse.ArgumentParser()


ArgumentParser 中最重要的方法是 .add_argument() ,它有几个变体。默认情况下,它会添加一个参数,并期望一个值。

PARSER.add_argument("--value")


查看实际效果,调用 .parse_args():

PARSER.parse_args(["--value", "some-value"])
Namespace(value='some-value')


也可以使用 = 语法:

PARSER.parse_args(["--value=some-value"])
Namespace(value='some-value')


为了缩短在命令行输入的命令,你还可以为选项指定一个短“别名”:

PARSER.add_argument("--thing", "-t")


可以传入短选项:

PARSER.parse_args("-t some-thing".split())
Namespace(value=None, thing='some-thing')


或者长选项:

PARSER.parse_args("--thing some-thing".split())
Namespace(value=None, thing='some-thing')

2、类型

有很多类型的参数可供你使用。除了默认类型,最流行的两个是布尔类型和计数器。布尔类型有一个默认为 True 的变体和一个默认为 False 的变体。

PARSER.add_argument("--active", action="store_true")
PARSER.add_argument("--no-dry-run", action="store_false", dest="dry_run")
PARSER.add_argument("--verbose", "-v", action="count")


除非显式传入 --active,否则 active 就是 False。dry-run 默认是 True,除非传入 --no-dry-run。无值的短选项可以并列。

传递所有参数会导致非默认状态:

PARSER.parse_args("--active --no-dry-run -vvvv".split())
Namespace(value=None, thing=None, active=True, dry_run=False, verbose=4)


默认值则比较单一:

PARSER.parse_args("".split())
Namespace(value=None, thing=None, active=False, dry_run=True, verbose=None)

3、子命令

经典的 Unix 命令秉承了“一次只做一件事,并做到极致”,但现代的趋势把“几个密切相关的操作”放在一起。

gitpodman kubectl 充分说明了这种范式的流行。

argparse 库也可以做到:

MULTI_PARSER = argparse.ArgumentParser()
subparsers = MULTI_PARSER.add_subparsers()
get = subparsers.add_parser("get")
get.add_argument("--name")
get.set_defaults(command="get")
search = subparsers.add_parser("search")
search.add_argument("--query")
search.set_defaults(command="search")


MULTI_PARSER.parse_args("get --name awesome-name".split())


Namespace(name='awesome-name', command='get')


MULTI_PARSER.parse_args("search --query name~awesome".split())


Namespace(query='name~awesome', command='search')`

4、程序架构

使用 argparse 的一种方法是使用下面的结构:

## my_package/__main__.py
import argparse
import sys
 
from my_package import toplevel
 
parsed_arguments = toplevel.PARSER.parse_args(sys.argv[1:])
toplevel.main(parsed_arguments)


## my_package/toplevel.py
 
PARSER = argparse.ArgumentParser()
## .add_argument, etc.
 
def main(parsed_args):
 
    ...
 
    # do stuff with parsed_args

在这种情况下,使用 python -m my_package 运行。或者,你可以在包安装时使用 console_scprits 入口点。

总结:

argparse 模块是一个强大的命令行参数解析器,还有很多功能没能在这里介绍。它能实现你想象的一切。

到此这篇关于Python 中使用 argparse 解析命令行参数的文章就介绍到这了,更多相关Python 中使用 argparse 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Python实现字典(dict)的迭代操作示例

    Python实现字典(dict)的迭代操作示例

    这篇文章主要介绍了Python实现字典(dict)的迭代操作,结合实例形式分析了Python针对字典键、值以及键值对等迭代操作实现技巧,需要的朋友可以参考下
    2018-06-06
  • Python使用Paramiko模块编写脚本进行远程服务器操作

    Python使用Paramiko模块编写脚本进行远程服务器操作

    这篇文章主要介绍了Python使用Paramiko模块编写脚本进行远程服务器操作的实例,通过Paramiko能够方便地使用SSH服务,需要的朋友可以参考下
    2016-05-05
  • Linux环境下安装python3

    Linux环境下安装python3

    这篇文章介绍了Linux环境下安装python3的方法,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07
  • 使用python脚本自动生成K8S-YAML的方法示例

    使用python脚本自动生成K8S-YAML的方法示例

    这篇文章主要介绍了使用python脚本自动生成K8S-YAML的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • 如何使用Python抓取网页tag操作

    如何使用Python抓取网页tag操作

    这篇文章主要介绍了如何使用Python抓取网页tag操作,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02
  • python 3.8.3 安装配置图文教程

    python 3.8.3 安装配置图文教程

    这篇文章主要为大家详细介绍了python 3.8.3 安装配置图文教程,文中安装步骤介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-05-05
  • Python求最小公倍数4种方法总结

    Python求最小公倍数4种方法总结

    这篇文章主要给大家介绍了关于Python求最小公倍数4种方法的相关资料,最小公倍数不可以像最大公约数那样直接利用辗转相除法求出,但可以借助辗转相除法求得的最大公约数来求最小公倍数,需要的朋友可以参考下
    2023-10-10
  • import的本质解析

    import的本质解析

    import是我们经常使用的功能,方法大家也都会。虽然用的多,但它的本质我们似乎没有好好的了解过。本文就import的本质解析,向大家作了介绍,需要的朋友可以参考下。
    2017-10-10
  • Python与MongoDB交互的代码实现

    Python与MongoDB交互的代码实现

    Python与MongoDB的交互通常通过pymongo库来实现,pymongo是一个官方的Python驱动程序,用于与MongoDB数据库进行交互,以下是一个简单的示例,具有一定的参考价值,需要的朋友可以参考下
    2024-10-10
  • python3 Scrapy爬虫框架ip代理配置的方法

    python3 Scrapy爬虫框架ip代理配置的方法

    Scrapy是用python实现的一个为了爬取网站数据,提取结构性数据而编写的应用框架。使用Twisted高效异步网络框架来处理网络通信。这篇文章主要介绍了python3 Scrapy爬虫框架ip代理配置,需要的朋友可以参考下
    2020-01-01

最新评论