Jupyter中模拟命令行参数测试Python脚本

引言：Jupyter Notebook中测试argparse脚本的挑战

Python的argparse模块是构建命令行接口（CLI）工具的强大工具，它允许脚本接收并解析用户通过命令行传入的参数，如文件路径、配置选项等。然而，在Jupyter Notebook这样的交互式环境中，直接运行一个期望命令行参数的脚本会遇到挑战，因为Notebook单元格本身并不直接模拟命令行环境。这意味着，如果您的Python代码依赖argparse.parse_args()来获取输入，您将无法在Jupyter中直接通过运行单元格的方式传入这些参数，从而难以进行测试和调试。

本教程旨在解决这一问题，提供在Jupyter Notebook中模拟命令行参数的有效方法，使您能够无缝地测试和验证依赖argparse的Python脚本。

核心策略：模拟命令行参数

要在Jupyter Notebook中测试argparse脚本，核心思想是模拟sys.argv（Python脚本接收命令行参数的列表）。有两种主要方法可以实现这一点：

1. 使用%%python魔术命令： 这种方法允许您将整个单元格的内容作为一个独立的Python脚本运行，并像在命令行中一样传递参数。
2. 直接修改sys.argv： 在您的Python代码执行argparse.parse_args()之前，手动修改sys.argv列表，注入您希望模拟的参数。

接下来，我们将详细探讨这两种方法。

方法一：利用%%python魔术命令模拟参数

%%python是一个Jupyter Notebook的“单元格魔术命令”，它允许您将当前单元格的内容作为独立的Python脚本执行。结合其参数传递能力，它成为模拟命令行参数的理想选择。

语法

在单元格的第一行使用%%python - 。-符号告诉Jupyter将后面的字符串作为命令行参数传递给单元格中的Python脚本。

示例代码：测试带文件路径参数的脚本

假设我们有一个Python脚本，它需要两个输入文件路径和一个输出目录路径作为参数。以下是如何在Jupyter Notebook中设置和测试它。

步骤 1：准备测试数据

首先，我们需要创建一些虚拟的CSV文件和输出目录，以便我们的脚本能够找到并处理它们。

# 单元格 1: 准备测试数据
# 创建临时的csv文件和输出目录，用于演示
!mkdir -p temp_data
!echo "col1,col2\n1,a\n2,b" > temp_data/file1.csv
!echo "Campaign Key\nCK1\nCK2" > temp_data/file2.csv
print("测试文件已创建：temp_data/file1.csv, temp_data/file2.csv")
print("测试输出目录已准备：temp_data/output_dir")

步骤 2：在单元格中编写并运行带参数的脚本

在另一个单元格中，我们将编写我们的Python脚本逻辑，并使用%%python魔术命令来传递参数。

# 单元格 2: 使用 %%python 魔术命令运行带参数的脚本
# 请确保此行是单元格的第一行，并且参数值根据您的实际情况修改
%%python - --SP_File temp_data/file1.csv --File2 temp_data/file2.csv temp_data/output_dir

import argparse
from pathlib import Path
import pandas as pd
import sys

# 1. 定义 ArgumentParser
parser = argparse.ArgumentParser(description='Jupyter Notebook中的参数传递演示')
parser.add_argument("--SP_File",
                    help="SP文件路径", type=Path)
parser.add_argument("--File2",
                    help="Datorama文件路径", type=Path)
parser.add_argument("Missing_Campaign_File",
                    help="输出文件保存目录", type=Path)

# 2. 解析参数
# 当使用 %%python 运行此单元格时，sys.argv 会被自动修改以包含传递的参数
args = parser.parse_args()

print(f"--- 接收到的参数 ---")
print(f"SP文件路径: {args.SP_File}")
print(f"Datorama文件路径: {args.File2}")
print(f"输出目录路径: {args.Missing_Campaign_File}")
print(f"--------------------")

# 3. 文件路径验证与读取
sp_file_path = args.SP_File
if not sp_file_path.exists():
    # 注意：在实际脚本中，这会是一个致命错误
    print(f"错误: 未找到SP文件: {sp_file_path}")
    sys.exit(1) # 模拟脚本退出
try:
    #