Python 中使用 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 命令秉承了“一次只做一件事，并做到极致”，但现代的趋势把“几个密切相关的操作”放在一起。

git、podman 和 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 内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com！

黄山市民网：https://www.huangshanshimin.com/

目录

1、python 中的参数解析

2、类型

3、子命令

4、程序架构

相关文章