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

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

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

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

Python中的参数解析

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

importargparsePARSER=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("-tsome-thing".split)

Namespace(value=None,thing='some-thing')

或者长选项：

PARSER.parse_args("--thingsome-thing".split)

Namespace(value=None,thing='some-thing')

类型

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

PARSER.add_argument("--value")1

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

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

PARSER.add_argument("--value")2

PARSER.add_argument("--value")3

默认值则比较单一：

PARSER.add_argument("--value")4

PARSER.add_argument("--value")5

子命令

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

git、podman和kubectl充分说明了这种范式的流行。argparse库也可以做到：

PARSER.add_argument("--value")6

PARSER.add_argument("--value")7

PARSER.add_argument("--value")8

PARSER.add_argument("--value")9

PARSER.parse_args(["--value","some-value"])0

程序架构

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

PARSER.parse_args(["--value","some-value"])1

PARSER.parse_args(["--value","some-value"])2

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

总结

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