Python argparse 模块
实例
定义一个简单的命令行界面,它接受一个名称参数:
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("name")
args = parser.parse_args(["Tobias"])
print(args.name)
亲自试一试 »
定义和用法
argparse 模块让构建用户友好的命令行界面变得轻松便捷。
它可以解析参数和选项,自动生成帮助和用法信息,并在用户提供无效参数时报错。
成员
| 成员 | 描述 |
|---|---|
| Action | <|
| 参数处理方式的基类(存储、追加、计数等)。 | |
| add_argument() | ArgumentParser 方法: 定义一个新的位置参数或可选参数。 |
| add_subparsers() | ArgumentParser 方法: 创建子命令(例如:git commit、git push)。 |
| ArgumentDefaultsHelpFormatter | 帮助格式化程序,在选项旁边显示默认值。 |
| ArgumentError | 无效参数或参数组合引发错误。 |
| ArgumentParser() | 创建解析器;添加选项/参数并解析命令行。 |
| ArgumentTypeError | 将值转换为所需类型失败时引发错误。 |
| BooleanOptionalAction | 创建 --foo / --no-foo 样式布尔标志的操作。 |
| error() | ArgumentParser 方法: 抛出错误信息并退出。 |
| exit() | ArgumentParser 方法: 以状态码退出程序。 |
| FileType() | 用于从参数值(例如,"-" 表示标准输入)打开文件的辅助函数。 |
| FileType() | 用于根据参数值打开文件的辅助函数(例如,"-" 表示从标准输入读取文件)。 |
| format_help() | ArgumentParser 方法: 返回完整的帮助文本(字符串)。 |
| format_usage() | ArgumentParser 方法: 返回简短的用法信息(字符串)。 |
| HelpFormatter | 用于帮助文本格式化的基类。 |
| MetavarTypeHelpFormatter | 用于添加参数类型信息的格式化器。 |
| Namespace | 用于存储已解析值的简单对象(通过点属性访问)。 |
| ONE_OR_MORE | 用于帮助/用法中的标记,指示需要一个或多个值。 |
| OPTIONAL | 用于帮助/用法中的标记,指示可选参数。 |
| PARSER | 内部用于用法字符串中子解析器的标记。 |
| parse_args() | ArgumentParser 方法: 解析命令行并返回一个 命名空间。 |
| parse_known_args() | ArgumentParser 方法: 解析已知选项并返回(命名空间,剩余参数)。 |
| PARSER | 内部用于用法字符串中子解析器的标记。 |
| print_help() | ArgumentParser 方法: 将完整的帮助文本输出到标准输出。 |
| print_usage() | ArgumentParser 方法: 将简短的用法信息输出到标准输出。 |
| RawDescriptionHelpFormatter | 保留描述中空格的格式化程序。 |
| RawTextHelpFormatter | 格式化程序,保留描述和结尾中的空格。 |
| REMAINDER | 将所有剩余的命令行部分收集到一个列表中。 |
| SUPPRESS | 特殊值,用于在帮助/用法输出中隐藏某个值。 |
| ZERO_OR_MORE | 帮助/用法中用于指示接受零个或多个值的标记。 |

