当前位置：首页 > news >正文

Python命令行参数解析argparse实战：从入门到精通

news 2026/6/30 1:34:51

argparse 基础入门

1.1 最简单的示例

让我们从一个最简单的例子开始：

1	`importargparse<br><br># 创建解析器<br>parser = argparse.ArgumentParser(description='这是一个示例程序')<br><br># 添加位置参数<br>parser.add_argument('name', help='你的名字')<br><br># 解析参数<br>args = parser.parse_args()<br><br>print(f'你好，{args.name}！')`

运行效果：

1	`$ python hello.py Alice<br>你好，Alice！`

1.2 核心概念

ArgumentParser：参数解析器，所有参数的容器
add_argument()：添加参数的方法
parse_args()：解析命令行输入，返回命名空间对象

二、参数类型详解

2.1 位置参数与可选参数

importargparse parser=argparse.ArgumentParser() # 位置参数（必须提供） parser.add_argument('filename', help='要处理的文件名') # 可选参数（以 - 或 -- 开头） parser.add_argument('-v', '--verbose', action='store_true', help='启用详细输出') parser.add_argument('-n', '--number', type=int, default=1, help='重复次数') args = parser.parse_args() print(f'处理文件: {args.filename}') print(f'详细模式: {args.verbose}') print(f'重复次数: {args.number}')

2.2 参数类型转换

argparse支持自动类型转换：

1	`parser.add_argument('--port',type=int, default=8080,help='端口号')<br>parser.add_argument('--rate',type=float, default=1.0,help='比率')<br>parser.add_argument('--tags', nargs='+',help='标签列表')# 接收多个值`

三、高级用法

3.1 互斥参数组

有时你需要让某些参数互斥（不能同时使用）：

parser=argparse.ArgumentParser(description='文件处理工具') group=parser.add_mutually_exclusive_group() group.add_argument('--json', action='store_true',help='以JSON格式输出') group.add_argument('--csv', action='store_true',help='以CSV格式输出') group.add_argument('--xml', action='store_true',help='以XML格式输出')

3.2 子命令（Sub-Commands）

像 Git 那样的子命令实现：

parser=argparse.ArgumentParser(description='项目管理工具') subparsers=parser.add_subparsers(dest='command',help='可用命令') # 创建 init 子命令 init_parser = subparsers.add_parser('init', help='初始化项目') init_parser.add_argument('--template', default='basic', help='项目模板') # 创建 build 子命令 build_parser = subparsers.add_parser('build', help='构建项目') build_parser.add_argument('--release', action='store_true', help='发布模式') args = parser.parse_args() if args.command == 'init': print(f'初始化项目，使用模板: {args.template}') elif args.command == 'build': print(f'构建项目，发布模式: {args.release}')

3.3 自定义动作（Action）

1	`classCustomAction(argparse.Action):<br>def__call__(self, parser, namespace, values, option_string=None):<br>print(f'自定义处理: {values}')<br>setattr(namespace,self.dest, values.upper())<br><br>parser.add_argument('--name', action=CustomAction,help='名称（自动转为大写）')`

四、实用技巧

4.1 参数验证

1	`defcheck_port(value):<br> ivalue=int(value)<br>ifnot(1<=ivalue <=65535):<br>raiseargparse.ArgumentTypeError(f"{value} 不是有效的端口号")<br>returnivalue<br><br>parser.add_argument('--port',type=check_port, default=8080)`

4.2 从文件读取参数

1	`parser.add_argument('--config',type=argparse.FileType('r'),help='配置文件')<br><br># 或使用 fromfile_prefix_chars<br>parser = argparse.ArgumentParser(fromfile_prefix_chars='@')<br># 然后可以: python script.py @args.txt`

4.3 美化帮助信息

1	`parser=argparse.ArgumentParser(<br> prog='mytool',<br> usage='%(prog)s [options] filename',<br> description='%(prog)s 是一个强大的文件处理工具',<br> epilog='示例: mytool data.txt --verbose --output result.txt',<br> formatter_class=argparse.RawDescriptionHelpFormatter<br>)`

五、完整实战示例

下面是一个完整的日志分析工具：

#!/usr/bin/env python3 # log_analyzer.py - 日志分析工具 import argparse import re from collections import Counter def analyze_log(filename, pattern=None, top_n=10, output=None): """分析日志文件""" with open(filename, 'r', encoding='utf-8') as f: lines = f.readlines() # 过滤匹配的行 if pattern: regex = re.compile(pattern) lines = [line for line in lines if regex.search(line)] # 统计IP地址 ip_pattern = re.compile(r'\b(?:[0-9]{1,3}\.){3}[0-9]{1,3}\b') ips = [] for line in lines: ips.extend(ip_pattern.findall(line)) ip_counts = Counter(ips).most_common(top_n) # 输出结果 result = f"\n分析结果 ({len(lines)} 行匹配):\n" result += "="*40 + "\n" result += "Top {} IP 地址:\n".format(top_n) for ip, count in ip_counts: result += f" {ip}: {count} 次\n" if output: with open(output, 'w') as f: f.write(result) print(f"结果已保存到: {output}") else: print(result) def main(): parser = argparse.ArgumentParser( prog='log_analyzer', description='Web日志分析工具 - 统计访问IP和请求', epilog='示例: log_analyzer access.log --pattern "404" --top 5' ) parser.add_argument('logfile', help='日志文件路径') parser.add_argument('-p', '--pattern', help='过滤正则表达式') parser.add_argument('-t', '--top', type=int, default=10, help='显示前N个IP (默认: 10)') parser.add_argument('-o', '--output', help='输出结果到文件') parser.add_argument('-v', '--verbose', action='store_true', help='详细模式') args = parser.parse_args() if args.verbose: print(f"开始分析: {args.logfile}") analyze_log(args.logfile, args.pattern, args.top, args.output) if __name__ == '__main__': main()