# VSCode Python launch.json 命令行参数配置详解 ## 一、launch.json 配置文件概述 launch.json 是 VSCode 中用于配置调试参数的核心文件，它定义了调试器如何启动和运行程序。对于需要从命令行读取参数的 Python 程序，正确配置 launch.json 至关重要。 ### 基础配置文件结构 ```json { "version": "0.2.0", "configurations": [ { "name": "Python: 当前文件", "type": "python", "request": "launch", "program": "${file}", "console": "integratedTerminal", "args": [] } ] } ``` ## 二、命令行参数配置方法 ### 1. 静态参数配置 在 `args` 数组中直接定义命令行参数： ```json { "name": "Python: 带参数调试", "type": "python", "request": "launch", "program": "${file}", "args": ["--input", "data.txt", "--output", "result.csv", "--verbose"] } ``` 对应的 Python 代码示例： ```python import argparse def main(): parser = argparse.ArgumentParser(description='命令行参数示例') parser.add_argument('--input', type=str, required=True, help='输入文件路径') parser.add_argument('--output', type=str, help='输出文件路径') parser.add_argument('--verbose', action='store_true', help='详细输出模式') args = parser.parse_args() print(f"输入文件: {args.input}") print(f"输出文件: {args.output}") print(f"详细模式: {args.verbose}") if __name__ == "__main__": main() ``` ### 2. 动态参数输入 通过 `${input:variableName}` 实现运行时动态输入参数： ```json { "version": "0.2.0", "configurations": [ { "name": "Python: 动态参数", "type": "python", "request": "launch", "program": "${file}", "args": ["${input:inputFile}", "${input:outputFile}"], "console": "integratedTerminal" } ], "inputs": [ { "id": "inputFile", "type": "promptString", "description": "请输入输入文件路径:", "default": "input.txt" }, { "id": "outputFile", "type": "promptString", "description": "请输入输出文件路径:", "default": "output.txt" } ] } ``` ### 3. 环境变量传递参数 结合环境变量传递敏感或配置参数： ```json { "name": "Python: 环境变量参数", "type": "python", "request": "launch", "program": "${file}", "env": { "CONFIG_PATH": "${workspaceFolder}/config.json", "API_KEY": "your-api-key-here", "DEBUG_MODE": "true" }, "args": ["--config", "${env:CONFIG_PATH}"] } ``` 对应的 Python 代码： ```python import os import argparse def main(): # 从环境变量读取配置 config_path = os.getenv('CONFIG_PATH', 'default.json') api_key = os.getenv('API_KEY') debug_mode = os.getenv('DEBUG_MODE', 'false').lower() == 'true' parser = argparse.ArgumentParser() parser.add_argument('--config', type=str, default=config_path) args = parser.parse_args() print(f"配置文件: {args.config}") print(f"API密钥: {api_key}") print(f"调试模式: {debug_mode}") if __name__ == "__main__": main() ``` ## 三、高级配置技巧 ### 1. 工作目录配置 确保程序在正确的目录下运行： ```json { "name": "Python: 指定工作目录", "type": "python", "request": "launch", "program": "${file}", "cwd": "${workspaceFolder}/src", "args": ["--data", "../data/dataset.csv"] } ``` ### 2. 多配置方案 针对不同场景创建多个调试配置： ```json { "version": "0.2.0", "configurations": [ { "name": "开发调试", "type": "python", "request": "launch", "program": "${file}", "args": ["--mode", "dev", "--log-level", "debug"], "env": {"DEBUG": "true"} }, { "name": "生产测试", "type": "python", "request": "launch", "program": "${file}", "args": ["--mode", "prod", "--log-level", "info"], "env": {"DEBUG": "false"} }, { "name": "性能分析", "type": "python", "request": "launch", "program": "${file}", "args": ["--profile", "--benchmark"], "env": {"PROFILE_MODE": "true"} } ] } ``` ### 3. 条件化参数配置 使用预启动任务动态生成参数： ```json { "version": "0.2.0", "tasks": [ { "label": "生成参数文件", "type": "shell", "command": "python", "args": ["${workspaceFolder}/scripts/generate_args.py"], "group": "build" } ], "configurations": [ { "name": "Python: 预任务参数", "type": "python", "request": "launch", "program": "${file}", "preLaunchTask": "生成参数文件", "args": ["--config", "${workspaceFolder}/generated_config.json"] } ] } ``` ## 四、常见问题与解决方案 ### 1. 参数未生效问题 **问题现象**：配置了 args 但程序运行时未接收到参数。 **解决方案**： - 检查 `program` 路径是否正确 - 验证 `args` 数组格式 - 确保 Python 代码正确使用 `argparse` 解析参数 ```json { "name": "Python: 参数调试验证", "type": "python", "request": "launch", "program": "${workspaceFolder}/main.py", "args": ["--test", "value"], "console": "integratedTerminal" } ``` ### 2. 路径相关问题 处理相对路径和绝对路径： ```json { "name": "Python: 路径处理", "type": "python", "request": "launch", "program": "${file}", "cwd": "${workspaceFolder}", "args": [ "--input", "${workspaceFolder}/data/input.txt", "--output", "./output/result.txt" ] } ``` ### 3. 复杂参数格式 处理包含空格或特殊字符的参数： ```json { "name": "Python: 复杂参数", "type": "python", "request": "launch", "program": "${file}", "args": [ "--name", "John Doe", "--message", "Hello World!", "--list", "item1,item2,item3" ] } ``` ## 五、最佳实践总结 | 配置场景 | 推荐方法 | 示例 | |---------|----------|------| | 固定参数 | 静态 args 数组 | `"args": ["--param", "value"]` | | 用户交互 | inputs 动态输入 | `"args": ["${input:userInput}"]` | | 环境配置 | env 环境变量 | `"env": {"CONFIG": "path"}` | | 多环境 | 多个配置方案 | 开发/测试/生产不同配置 | | 复杂逻辑 | 预启动任务 | `"preLaunchTask": "setup"` | 通过合理配置 launch.json 文件，可以显著提升 Python 程序在 VSCode 中的调试体验，特别是在处理命令行参数时能够提供灵活且强大的调试支持。建议根据具体项目需求选择合适的参数传递方式，并充分利用 VSCode 提供的各种配置选项来优化调试流程。[ref_2][ref_4][ref_6]