如何在VS Code中带命令行参数运行Jupyter Notebook单元格并保留上下文

已尝试的方案 #

• 参考Stack Overflow相关讨论，在脚本前添加前缀%%python - --option1 value1 --option2 value2，但此方式仅将代码作为普通Python脚本运行，无法访问Notebook内的变量，也失去交互性。
• 使用papermill工具，虽能解决问题，但依赖VS Code不支持的标签。
• 导出为普通Python脚本，可行但开发流程繁琐。
• 在argparse中硬编码默认值，调试时需频繁修改代码，方式不雅。

简洁通用的解决方案 #

方案1：直接修改sys.argv #

手动在单元格开头设置sys.argv的内容，让argparse可以读取到模拟的命令行参数，同时完全保留Notebook的变量可见性：

import sys
# 模拟命令行参数，第一个元素为脚本名（可任意填写）
sys.argv = ["current_cell", "--option1", "value1", "--option2", "value2"]

# 正常编写argparse逻辑
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--option1")
parser.add_argument("--option2")
args = parser.parse_args()

# 可直接访问Notebook中已定义的变量
print(args.option1)
print(existing_notebook_variable)  # 假设该变量已在之前的单元格定义

方案2：封装参数传递函数 #

编写一个轻量函数，直接传入参数列表给argparse解析，避免修改sys.argv，同样保留变量访问权限：

import argparse

def execute_with_args(param_list):
    parser = argparse.ArgumentParser()
    parser.add_argument("--option1")
    parser.add_argument("--option2")
    args = parser.parse_args(param_list)
    
    # 在这里执行业务逻辑，可直接调用Notebook内的变量和函数
    print(f"Option1 value: {args.option1}")
    process_data(existing_dataset)  # 假设existing_dataset是Notebook中已有的变量
    return args

# 调用时传入参数列表
execute_with_args(["--option1", "value1", "--option2", "value2"])

方案3：使用IPython魔法命令%run（进阶） #

如果需要将某段代码单独作为“可传参模块”，可以把代码写在一个单元格的函数里，然后用%run结合参数调用，本质是直接复用函数逻辑并传参：

# 先定义一个可接受参数的函数（比如在Cell A）
def process_task(option1, option2):
    print(f"Processing with {option1} and {option2}")
    print(shared_variable)  # 访问Notebook全局变量

# 在另一个单元格调用
%run -i -c "process_task('value1', 'value2')"

以上方案均无需额外依赖，完全兼容Jupyter Notebook（包括VS Code中的Notebook环境），既能模拟命令行参数传递，又能保留所有Notebook变量的可见性。

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