如何在传入正确数量命令行参数时调试Python代码

调试一段检查命令行参数数量的Python代码时，执行Step Over操作后程序直接跳转到参数不足的分支。以下是针对传入正确数量参数时的调试方案，附原代码及修正说明：

原代码 #

import sys
import csv

# check for two command-line arguments
if len(sys.argv) == 3:
    try:
    # creat a buffer csv file
        buffer = []
        #open input file for reading
        with open(sys.argv[1]) as file:
            # read input file
            reader = csv.reader(file)
            for row in reader:
                # append each line into a csv buffer
                buffer.append(row)

        # open output file for writing
        with open(sys.argv[2], "w") as file_output:
            writer = csv.DictWriter(file_output, fieldnames= ["first", "last", "house"])
            # ignore the first row of csv buffer
            for line in buffer[1:]:
                # split contents of csv buffer
                line[0] = "first"
                line[1] = "last"
                line[2] = "house"
                # write into the output file
                writer.writerow({"first": first, "last": last, "house": house})

    except OSError:
        sys.exit(f"Couldn't read {sys.argv[1]}")

# check for fewer command-line arguments
elif len(sys.argv) < 3:
    sys.exit("Too few comman-line arguments")

# check for more command-line argument
else:
    sys.exit("Too many command-line arguments")

调试步骤 #

1. 确认调试时的参数传入 #

调试时默认可能未传入任何参数，此时len(sys.argv)仅为1（只有脚本本身），程序会直接进入参数不足分支。解决方法：

• 在IDE调试配置中找到「程序参数」选项，填入两个文件名（比如input.csv output.csv，确保input.csv存在）。
• 可在代码最开头添加print(sys.argv)，运行后查看实际参数列表，正常情况下应输出['脚本名.py', 'input.csv', 'output.csv']，长度为3。

2. 修复代码中的语法与逻辑错误 #

原代码存在多处问题，会导致程序提前崩溃或逻辑异常：

• try块缩进错误：try下方的代码未正确缩进，会触发语法错误，需将buffer = []及后续代码缩进4个空格。
• 变量未定义：writer.writerow中的first、last、house从未赋值，会抛出NameError，且该异常不在except OSError捕获范围内，导致程序直接终止。
• 错误修改原数据：line[0] = "first"等语句将csv行内容改为固定字符串，不符合需求，应改为从行中提取值（比如first = line[0]）。
• 缺失表头写入：DictWriter需调用writeheader()方法，否则输出的csv文件没有表头行。

3. 断点调试关键节点 #

• 在if len(sys.argv) == 3:行设置断点，启动调试后查看len(sys.argv)的实际值，确认是否等于3。
• 进入try块后，在读取文件、数据处理、写入文件等步骤设置断点，查看buffer、line等变量的内容，验证数据处理逻辑是否正确。

修正后的代码示例 #

import sys
import csv

# 检查命令行参数数量
if len(sys.argv) == 3:
    try:
        buffer = []
        # 读取输入csv文件
        with open(sys.argv[1]) as file:
            reader = csv.reader(file)
            for row in reader:
                buffer.append(row)

        # 写入输出csv文件
        with open(sys.argv[2], "w") as file_output:
            writer = csv.DictWriter(file_output, fieldnames=["first", "last", "house"])
            writer.writeheader()  # 写入表头
            # 跳过原csv表头行，处理数据行
            for line in buffer[1:]:
                first = line[0]
                last = line[1]
                house = line[2]
                writer.writerow({"first": first, "last": last, "house": house})

    except OSError:
        sys.exit(f"无法读取文件: {sys.argv[1]}")
    except Exception as e:
        sys.exit(f"程序出错: {str(e)}")  # 捕获其他异常，便于调试

elif len(sys.argv) < 3:
    sys.exit("命令行参数过少")
else:
    sys.exit("命令行参数过多")

内容的提问来源于stack exchange，提问作者Balup