VeighNa 量化交易平台 VSCode 开发环境搭建、运行与断点调试完整指南【免费下载链接】vnpy基于Python的开源量化交易平台开发框架项目地址: https://gitcode.com/gh_mirrors/vn/vnpy本篇指南以 VeighNavnpy开源量化交易框架在 VSCodeVisual Studio Code中的开发流程为主线系统讲解 VSCode 的安装与附加任务配置、VeighNa 项目的文件/文件夹打开方式、工作区管理、Python 解释器切换、启动脚本运行以及 Python 与 C 回调线程的断点调试技巧并配套说明 Python、Jupyter、Flake8 等必选与可选插件的安装与用途。读完本文你将能够从零搭建一套可直接运行 VeighNa Trader 图形界面、执行策略回测脚本并进行源码级单步调试的 VSCode 开发环境。一、环境准备系统支持与 Python 发行版选择本文内容基于 Windows 系统编写但大部分操作同样适用于 Linux 和 macOS。VeighNa 官方支持的 Windows 系统版本包括Windows 11Windows Server 2019 / 2022其他版本的 Windows 系统在安装时可能遇到各种依赖库问题官方不推荐使用。在 Windows 系统上使用 VeighNa官方推荐安装【VeighNa Station】集成的 VeighNa Studio Python 发行版特别适合初次接触 Python 开发的新手用户——它已经预装好 VeighNa 主程序以及 CTA 策略、回测等常用功能模块所需的全部依赖可避免手动安装 PySide6、ta-lib、numpy 等底层库带来的兼容性问题。作为佐证当前仓库的 pyproject.toml 中列出了项目运行所需的完整依赖清单包括PySide66.8.2.1图形界面、pyqtgraph0.13.7K 线图表、ta-lib0.6.4技术指标、pandas2.2.3数据处理等并声明requires-python 3.10支持 Python 3.10~3.13手工逐一安装这些组件对新手并不友好这正是推荐直接使用 VeighNa Studio 的原因。VeighNa Station 的详细安装与登录、模块选择、策略加密、组件更新等操作可参考同目录下的 VeighNa Station 使用文档。二、VSCode 安装2.1 下载与安装向导从 VSCode 官网下载 VS Code for Windows 安装包后双击安装包即可进入 VSCodeUser安装向导。整个向导按以下步骤推进许可协议页选择【我同意此协议】点击【下一步】选择目标位置指定安装目录点击【下一步】选择开始菜单文件夹配置快捷方式位置点击【下一步】选择附加任务勾选附加功能见下文点击【下一步】准备安装核对前述所有安装设置后点击【安装】安装完成若勾选了运行 Visual Studio Code选项此时会自动打开 VSCode。2.2 附加任务勾选项详解在选择附加任务页面建议选中所有勾选框每个选项的具体功能如下勾选项功能说明将通过 Code 打开操作添加到 Windows 资源管理器文件上下文菜单可直接通过右键菜单在 VSCode 中打开单个文件将通过 Code 打开操作添加到 Windows 资源管理器目录上下文菜单可直接通过右键菜单在 VSCode 中打开整个文件夹及其内容将 Code 注册为受支持的文件类型的编辑器将 VSCode 设置为系统默认打开受支持文件类型如 .py、.txt 等的编辑器添加到 PATH重启后生效安装完成后把 VSCode 的安装目录添加到 PATH 环境变量便于在终端中直接使用code命令三、VeighNa 开发从打开文件到运行程序3.1 打开单一文件启动 VSCode 后在弹出的欢迎界面点击【Open File】即可打开单个文件。在弹出的窗口中选择存放文件的路径并点击【打开】即可在编辑器中查看和编辑该文件。请注意如果以受限模式打开文件想临时关闭受限模式可以找到窗口顶部的受限模式提示点击【Manage】在弹出的 Workspace Trust 页面点击【Trust】即可关闭该文件的受限模式。3.2 打开文件夹点击欢迎界面的【Open Folder】即可打开整个文件夹。在弹出的 Open Folder 窗口中选择目标文件夹路径并点击【打开】VSCode 会在资源管理器中展示该文件夹下的全部内容方便浏览 VeighNa 仓库或自定义策略目录的整体结构。3.3 保存 VSCode 开发项目工作区为了方便集中管理代码资源、避免环境切换混乱VSCode 提供了工作区Workspace支持点击【File】-【Save Workspace As...】可将当前窗口保存为工作区文件到指定路径便于后续快速恢复开发环境点击【File】-【Add Folder to Workspace...】可以将不同的项目文件夹添加到同一个工作区中解决多项目之间来回切换的困难。例如你可以把 VeighNa 框架源码目录与自己的strategies策略文件夹同时放入一个工作区随时对照查看。3.4 Python 环境选择在安装了 Python 插件之后打开任意 .py 文件VSCode 窗口右下角会显示当前使用的 Python 环境信息。默认显示的是自动搜索到的 Python 环境。如果当前系统中存在多个 Python 环境例如同时安装了 VeighNa Studio 自带解释器、Anaconda 或系统 Python可以点击右下角的 Python 环境信息在窗口顶部弹出的下拉框中选择目标解释器进行切换。这一步骤非常重要VeighNa 的依赖必须安装在所选解释器对应的环境中否则运行脚本时会报ModuleNotFoundError。3.5 运行程序启动 VeighNa Trader仓库中提供了开箱即用的图形界面启动脚本 run.py。用 VSCode 打开该文件后点击右上角的运行按钮选择【Run Python File】即可运行脚本此时界面底部的 TERMINAL 终端标签页中会输出程序运行时的打印信息与此同时VeighNa Trader 的主窗口会自动弹出显示。从源码看run.py 的启动流程非常清晰先通过create_qapp()创建 Qt 应用再创建EventEngine事件引擎与MainEngine主引擎随后通过main_engine.add_gateway(CtpGateway)加载 CTP 期货交易接口、通过main_engine.add_app(CtaStrategyApp)等调用加载 CTA 策略、CTA 回测、数据管理等应用模块最后创建MainWindow并以最大化方式显示进入qapp.exec()事件循环。如果你只安装了部分模块或想加载其他交易接口如vnpy_mini、vnpy_ib等和应用模块可以仿照文件中大量被注释的示例行进行增删。请注意以下几点启动脚本时会在当前 VSCode 使用的 Python 环境中运行如需使用其他 Python 环境请参考前文步骤进行切换如果想直接在终端中运行脚本可以按Ctrl J打开 Terminal在其中输入命令启动 VeighNa Trader终端打印的没有配置要使用的数据服务请修改全局配置中的 datafeed 相关内容输出不影响VeighNa Trader 的运行如需配置数据服务可在 VeighNa Trader 主界面【配置】-【全局配置】中设置不需要则可直接忽略此条提示。3.6 断点调试以策略回测脚本为例VSCode 提供了强大的断点调试功能。这里以 VeighNa 的策略历史回测脚本演示完整调试流程点击【New File】在界面上方弹出的窗口中选择【Python File】创建backtest.py在文件中编写一段策略回测代码可参考仓库中的 回测示例 Notebook并在想要暂停的代码行左侧点击打上断点红色小圆点点击 VSCode 右上角的向下按钮选择【Python Debugger: Debug Python File】开始调试也可以点击左侧菜单栏的 Run and Debug 图标或直接按F5键启动调试。启动调试后窗口左侧的 RUN AND DEBUG 区域会输出程序运行信息程序会暂停在第一个断点处。左侧面板分别展示变量VARIABLES、监视WATCH、**调用堆栈CALL STACK和断点BREAKPOINTS**信息点击变量可查看详细信息。以仓库中的回测示例为例调试时你可以观察BacktestingEngine对象的set_parameters过程如vt_symbolIF888.CFFEX、interval1m、rate0.3/10000、capital1_000_000等参数赋值以及add_strategy(AtrRsiStrategy, {})之后引擎加载历史数据、回放 K 线、计算统计指标的完整链路。继续调试时点击类似播放键的【Continue】或按F5可继续运行到下一个断点每次暂停后VARIABLES 区域中当前上下文的变量值会随之更新可逐断点核对数据变化重复点击【Continue】直到调试结束可在 Terminal 中看到回测结果输出包括总收益率、最大回撤、Sharpe Ratio 等统计指标。调试过程中的常用操作操作快捷键/按钮说明ContinueF5继续运行直到下一个断点Step OverF10越过子函数子函数会执行Step IntoF11进入子函数内部查看运行时细节Step OutShiftF11跳出当前函数查看外层调用栈状态Restart--重新启动调试任务StopShiftF5直接停止当前调试任务变量监视在 VARIABLES 区域中选中要监控的变量名称并点击鼠标右键选择【Add to Watch】即可在 WATCH 监控区域实时观测该变量的变化。交互式调试窗口底部的 DEBUG CONSOLE 提供交互式调试支持可以在调试过程中运行任意命令如查看对象属性、调用函数等。3.6.1 C 回调断点调试CTP 接口、PySide 等场景通常情况下VSCode 只能在 Python 解释器中启动的线程里进行断点调试。如果希望在C 回调函数如 CTP API 接口、PySide 图形库等非 Python 线程中打断点可以通过在代码中设置断点的方式实现。步骤如下点击【New File】创建gateway_test.py在其中添加一段脚本策略代码可参考仓库中的 demo_script.py该示例展示了如何通过ScriptEngine订阅行情、获取合约信息并轮询打印最新行情按住Ctrl同时用鼠标左键点击代码中的CtpGateway跳转到其源码文件中在想要调试的回调函数内打上断点注意不要打在函数定义的 def 那一行回到gateway_test.py开始调试此时会发现并没有进入之前设定的断点——这正是 Python 线程无法直接捕获 C 回调线程断点的表现。请注意脚本中若使用load_json函数读取connect_ctp.json请确保对应的.vntrader文件夹下的 json 文件中已配置 CTP 账户登录信息。这一机制的底层实现在 vnpy/trader/utility.py 中get_file_path会把配置文件名定位到用户目录下的.vntrader文件夹load_json读取该路径下的 json 文件不存在时自动创建空配置save_json则以 UTF-8 编码、缩进 4 格的格式写回。终止调试后回到之前在 CTP 源码中设定的断点处在回调函数内的断点之前添加以下代码import pydevd pydevd.settrace(suspendFalse, trace_only_current_threadTrue)再次运行调试gateway_test.py此时底部调试窗口开始输出相关信息程序暂停在之前设置的断点处。调用堆栈窗口显示线程信息可以看到多了一个 Dummy 线程变量窗口显示回调函数的入参。关于这段代码请特别注意pydevd是 VSCode 自带的调试插件没有安装在 Python 解释器所在的 Python 环境里suspend参数设置为True后调试会在这一句代码运行完之后暂停而不是停在断点处此处设为False表示先附加调试再在断点暂停trace_only_current_thread参数设置为True后调试过程中只会监控当前线程调试结束之后不要忘记删掉这段代码避免污染正式交易代码。补充如果在调试过程中没有跳转可以点击【Run and Debug】页面上方的设置按钮打开launch.json将justMyCode参数配置为false即可在调试过程中进入第三方库如 vnpy_ctp 接口层内部进行跳转。四、插件安装VSCode 提供了极为丰富的扩展插件功能可显著提升开发效率和便捷性。以下是针对 VeighNa 开发的推荐插件清单。4.1 必选插件Python点击 VSCode 左侧菜单栏的 Extensions 图标搜索【Python】并点击【install】安装。安装 Python 插件时会自动安装以下两个插件Pylance提供类型检查、代码补全、引用跳转和代码诊断支持Python Debugger提供断点调试功能。安装完成后可以在 Extension 栏看到 Python、Pylance 和 Python Debugger 三个插件。Pylance 的两个高频使用技巧将鼠标光标移到代码上方会自动弹出对应的文档信息如 VeighNa 各类接口方法的签名与 docstring按住Ctrl键的同时用鼠标左键点击代码会跳转到代码的声明部分如从CtpGateway跳转到其类定义。Jupyter搜索【Jupyter】并安装后Jupyter 插件将 Jupyter Notebook 的功能集成到 VSCode 中用户可以直接在 VSCode 中打开、编辑和运行 Notebook——这对于运行仓库中的 回测示例 Notebook、alpha_research 研究流程 Notebook 等投研脚本非常有用。安装 Jupyter 插件时会自动安装以下四个附属插件Jupyter Cell Tags提供在单元格中添加标签的支持Jupyter Keymap提供快捷键支持Jupyter Notebook Renderers提供对不同内容类型图表、数据等的渲染和解析支持Jupyter Slide Show提供幻灯片支持。安装完成后Extension 栏共出现 Jupyter、Jupyter Cell Tags、Jupyter Keymap、Jupyter Notebook Renderers、Jupyter Slide Show 五个插件。Flake8搜索【Flake8】并安装。Flake8 插件可以检查 Python 代码是否符合 PEP 8 代码风格规范包括代码中的错误、复杂度过高的构造以及不符合 PEP 8 风格指南的地方。使用效果当 Flake8 检测到代码不规范或存在错误时会在代码下方显示红色波浪线警告帮助快速定位问题同时会在窗口底部的【PROBLEMS】标签页中汇总显示整个工作分区内检测到的所有错误。参考当前仓库自身的 pyproject.toml 中即配置了基于 Ruff 的 lint 规则flake8-bugbear、pycodestyle、pyflakes、pyupgrade等可见该社区对代码风格与静态检查的重视在 VSCode 中使用 Flake8 插件可以让你在开发自己的策略代码时也保持同样的规范水平。4.2 可选插件以下插件可根据个人习惯按需安装插件功能Chinese Language将 VSCode 界面和菜单翻译成中文适合对英文不太熟悉的用户Excel Viewer允许在 VSCode 中直接查看和编辑 CSV 文件支持基本的单元格编辑、筛选和排序功能可配合 VeighNa 导出的成交记录等 CSV 数据使用One Monokai Theme提供代码高亮主题通过改变代码的颜色、字体和背景使代码更易于阅读和理解Material Icon Theme将文件和目录图标替换为 Material Design 风格使侧边栏中的文件和目录更易于区分和识别Github CopilotAI 代码辅助工具提高代码编写的效率与一致性C/C 和 C/C Extension Pack提供 C/C 语言支持、代码调试、代码格式化、代码补全、头文件包含等功能如需要阅读 CTP 等底层接口的 C 头文件时可安装五、常见问题与实用提示运行时找不到模块优先检查 VSCode 右下角当前选中的 Python 环境是否为安装 VeighNa 的那一个必要时手动切换解释器运行 run.py 报接口或应用缺失确认pip list中已安装vnpy_ctp、vnpy_ctastrategy等对应模块未安装时可将 run.py 中对应行的add_gateway/add_app注释掉或按 VeighNa Station 使用文档 通过 Station 的【交易】页勾选模块后一键启动数据服务提示可忽略如前述没有配置要使用的数据服务日志不影响程序主体运行需要历史数据回测或 K 线展示时再到【配置】-【全局配置】中填写 datafeed 相关参数C 回调断点不生效先确认断点打在回调函数体内而非 def 行再确认已添加pydevd.settrace附加代码且调试完成后已删除第三方库内无法跳转在launch.json中将justMyCode设置为false。至此你已经拥有了一个完整的 VeighNa VSCode 开发环境从安装配置、环境切换、运行图形界面与回测脚本到 Python 线程与 C 回调线程的断点调试再到代码规范检查与 Notebook 投研均可在一套编辑器内完成。后续编写自己的 CTA 策略时可直接参考仓库的 策略模板 与回测示例结合断点调试逐行验证策略逻辑。【免费下载链接】vnpy基于Python的开源量化交易平台开发框架项目地址: https://gitcode.com/gh_mirrors/vn/vnpy创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考