Python argparse命令行工具 - 参数解析与子命令完整指南

import argparse

# 1. 创建解析器
parser = argparse.ArgumentParser(
    description="这是一个示例命令行工具",
    epilog="更多帮助请访问: https://example.com",
    formatter_class=argparse.RawDescriptionHelpFormatter
)

# 2. 添加参数
parser.add_argument("filename", help="要处理的文件名")
parser.add_argument("-v", "--verbose", action="store_true", help="显示详细输出")
parser.add_argument("-o", "--output", type=str, default="output.txt", help="输出文件路径")

# 3. 解析参数
args = parser.parse_args()

# 4. 使用解析结果
print(f"处理文件: {args.filename}")
print(f"详细模式: {args.verbose}")
print(f"输出路径: {args.output}")

# 运行示例
$ python script.py data.csv -v -o result.csv
处理文件: data.csv
详细模式: True
输出路径: result.csv

# 查看帮助
$ python script.py --help
usage: script.py [-h] [-v] [-o OUTPUT] filename

这是一个示例命令行工具

positional arguments:
  filename              要处理的文件名

options:
  -h, --help            show this help message and exit
  -v, --verbose         显示详细输出
  -o OUTPUT, --output OUTPUT
                        输出文件路径

更多帮助请访问: https://example.com

# 基本位置参数
parser.add_argument("input_file", help="输入文件路径")

# 多个位置参数
parser.add_argument("source", help="源文件")
parser.add_argument("destination", help="目标文件")

# 可选的位置参数（使用?表示0或1个，*表示0或多个，+表示1或多个）
parser.add_argument("files", nargs="*", help="要处理的文件列表")
parser.add_argument("tags", nargs="+", help="至少一个标签")

# 示例：nargs="*" 可以接收0个或多个值
# python script.py file1.txt file2.txt file3.txt
# args.files = ['file1.txt', 'file2.txt', 'file3.txt']

# 示例：nargs="+" 至少需要一个值
# python script.py tag1 tag2
# args.tags = ['tag1', 'tag2']

import argparse

parser = argparse.ArgumentParser()

# 布尔标志参数
parser.add_argument("-v", "--verbose", action="store_true", help="详细模式")
parser.add_argument("-q", "--quiet", action="store_false", dest="verbose", help="安静模式")

# 带值的参数
parser.add_argument("-c", "--count", type=int, default=1, help="处理次数")
parser.add_argument("-f", "--format", choices=["json", "csv", "xml"], default="json", help="输出格式")

# 必需参数（虽然是可选形式但必须提供）
parser.add_argument("--api-key", required=True, help="API密钥")

# 多个值
parser.add_argument("--tags", nargs="*", help="标签列表")

# 追加模式（可多次使用）
parser.add_argument("--include", action="append", help="包含路径（可多次指定）")

# 使用示例
# python script.py -v --count 5 --format json --api-key abc123 --include /path1 --include /path2

import argparse

def cmd_create(args):
    """创建新项目"""
    print(f"创建项目: {args.name}")
    print(f"模板: {args.template}")

def cmd_delete(args):
    """删除项目"""
    print(f"删除项目: {args.project_id}")
    if args.force:
        print("强制删除模式")

def cmd_list(args):
    """列出所有项目"""
    print(f"显示格式: {args.format}")
    if args.verbose:
        print("详细信息模式")

def main():
    parser = argparse.ArgumentParser(description="项目管理工具")
    parser.add_argument("--config", default="config.yaml", help="配置文件路径")
    
    # 创建子命令解析器
    subparsers = parser.add_subparsers(dest="command", help="可用命令")
    
    # create子命令
    create_parser = subparsers.add_parser("create", help="创建新项目")
    create_parser.add_argument("name", help="项目名称")
    create_parser.add_argument("-t", "--template", choices=["web", "api", "cli"], default="web", help="项目模板")
    create_parser.set_defaults(func=cmd_create)
    
    # delete子命令
    delete_parser = subparsers.add_parser("delete", help="删除项目")
    delete_parser.add_argument("project_id", help="项目ID")
    delete_parser.add_argument("-f", "--force", action="store_true", help="强制删除")
    delete_parser.set_defaults(func=cmd_delete)
    
    # list子命令
    list_parser = subparsers.add_parser("list", help="列出项目")
    list_parser.add_argument("-f", "--format", choices=["table", "json"], default="table", help="输出格式")
    list_parser.add_argument("-v", "--verbose", action="store_true", help="显示详细信息")
    list_parser.set_defaults(func=cmd_list)
    
    args = parser.parse_args()
    
    if args.command is None:
        parser.print_help()
        return
    
    # 执行对应命令
    args.func(args)

if __name__ == "__main__":
    main()

# 使用子命令
$ python tool.py create myapp --template api
创建项目: myapp
模板: api

$ python tool.py delete 123 --force
删除项目: 123
强制删除模式

$ python tool.py list --format json -v
显示格式: json
详细信息模式

# 将相关参数分组显示，使帮助信息更清晰
parser = argparse.ArgumentParser()

# 输入输出分组
io_group = parser.add_argument_group("输入输出选项")
io_group.add_argument("-i", "--input", required=True, help="输入文件")
io_group.add_argument("-o", "--output", default="out.txt", help="输出文件")
io_group.add_argument("--encoding", default="utf-8", help="文件编码")

# 性能分组
perf_group = parser.add_argument_group("性能选项")
perf_group.add_argument("-j", "--jobs", type=int, default=1, help="并行任务数")
perf_group.add_argument("--buffer-size", type=int, default=4096, help="缓冲区大小")

#!/usr/bin/env python3
"""data_tool.py - 数据处理命令行工具"""

import argparse
import sys
import json
import csv
from pathlib import Path


def process_csv(input_file: Path, output_file: Path, delimiter: str = ","):
    """处理CSV文件"""
    print(f"处理CSV: {input_file} -> {output_file}")
    with open(input_file, "r", encoding="utf-8") as f:
        reader = csv.reader(f, delimiter=delimiter)
        rows = list(reader)
    print(f"读取 {len(rows)} 行数据")
    with open(output_file, "w", encoding="utf-8", newline="") as f:
        writer = csv.writer(f)
        writer.writerows(rows)
    print("处理完成")


def process_json(input_file: Path, output_file: Path, pretty: bool = False):
    """处理JSON文件"""
    print(f"处理JSON: {input_file} -> {output_file}")
    with open(input_file, "r", encoding="utf-8") as f:
        data = json.load(f)
    print(f"读取 {len(data) if isinstance(data, list) else 1} 条数据")
    with open(output_file, "w", encoding="utf-8") as f:
        if pretty:
            json.dump(data, f, indent=2, ensure_ascii=False)
        else:
            json.dump(data, f, ensure_ascii=False)
    print("处理完成")


def main():
    parser = argparse.ArgumentParser(
        description="数据处理命令行工具",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
示例用法:
  %(prog)s convert input.csv output.json --from csv --to json
  %(prog)s convert input.json output.csv --pretty
        """
    )
    
    parser.add_argument("-v", "--verbose", action="store_true", help="详细输出")
    parser.add_argument("--version", action="version", version="data_tool 1.0.0")
    
    subparsers = parser.add_subparsers(dest="command", required=True, help="可用命令")
    
    # convert命令
    convert_parser = subparsers.add_parser("convert", help="转换文件格式")
    convert_parser.add_argument("input", type=Path, help="输入文件")
    convert_parser.add_argument("output", type=Path, help="输出文件")
    convert_parser.add_argument("--from", dest="input_format", choices=["csv", "json"], required=True, help="输入格式")
    convert_parser.add_argument("--to", dest="output_format", choices=["csv", "json"], required=True, help="输出格式")
    convert_parser.add_argument("--delimiter", default=",", help="CSV分隔符")
    convert_parser.add_argument("--pretty", action="store_true", help="格式化JSON输出")
    convert_parser.set_defaults(func=lambda args: handle_convert(args))
    
    args = parser.parse_args()
    
    if args.verbose:
        print(f"参数: {vars(args)}")
    
    args.func(args)


def handle_convert(args):
    """处理convert命令"""
    if args.input_format == "csv" and args.output_format == "json":
        # CSV转JSON
        import csv
        with open(args.input, "r", encoding="utf-8") as f:
            reader = csv.DictReader(f, delimiter=args.delimiter)
            data = list(reader)
        with open(args.output, "w", encoding="utf-8") as f:
            json.dump(data, f, indent=2 if args.pretty else None, ensure_ascii=False)
    elif args.input_format == "json" and args.output_format == "csv":
        # JSON转CSV
        with open(args.input, "r", encoding="utf-8") as f:
            data = json.load(f)
        if data:
            with open(args.output, "w", encoding="utf-8", newline="") as f:
                writer = csv.DictWriter(f, fieldnames=data[0].keys())
                writer.writeheader()
                writer.writerows(data)
    print(f"转换完成: {args.input} -> {args.output}")


if __name__ == "__main__":
    main()

# 运行示例
$ python data_tool.py --help
$ python data_tool.py convert data.csv output.json --from csv --to json
$ python data_tool.py convert data.json output.csv --from json --to csv --pretty
$ python data_tool.py --version