Files
sanguo_vnpy_v2/docs
claude_dev 4966d30a11
CI/CD / test (push) Failing after 3s
CI/CD / nas-deploy (push) Has been skipped
CI/CD / nas-verify (push) Has been skipped
feat(provider): A档截面数据使用层出口——泛型底座+涨停池门面双层接口
09-02任务①落地。§15采集的14类panel数据此前零读取出口,策略/因子session
想用只能手搓parquet路径;经业界对照(dsa get_limit_up_pool/tushare
limit_list_d U/D/Z参数化/聚宽per-domain/OpenBB TET)定稿「泛型底座+域
语义门面」:

①get_event_panel(event_type,date/start+end,trading_days_only=True):
保真底座,白名单14类统一通道(=采集注册表口径,hot_rank未挂载不入列),
返回akshare原样中文列+trade_date(文件名合成);缺文件=合法缺失→空df;
trading_days_only默认用get_trade_days滤非交易日——治快照族「周中法定
假日文件=上一交易日态复制品」的区间双计数(采集层只按周一~五落盘,
周六根本无文件,风险面=周中假日);=False按周一~五枚举(=采集口径)

②get_limit_pool(kind=zt|zbgc|dtgc,...):涨停池门面(温度计/炸板率/行业
集中度消费契约),kind三合一←tushare limit_list_d;英文标准列
code/consecutive_boards/seal_amount/break_count/industry…(键名对齐dsa);
映射表基于VPS真实parquet实测(dtgc实测含动态市盈率/封单资金/板上成交额/
连续跌停/开板次数,与文档口径有差);akshare改中文列名时本层吸收漂移,
有行缺源列→DataSchemaError fail-fast;真空日(dtgc 0跌停空文件无列)
→仍返标准列空表schema稳定

③实现=TET Fetcher(fetchers/event_panel.py双Fetcher同文件,price.py先例),
FETCHERS注册表+event_panel/limit_pool两键(未来MCP出口零成本);base.py
新增_DateRangeParams跨字段校验(date/start+end互斥二选一);LocalUnified
Provider(回测)与SanguoMiniQmtProvider(实盘,委托self._unified)双侧同款
——方法面钉死测试强制无缺口,双侧同schema支持副本对照;miniQMT/QMT/
PTrade均无此类接口(业界惯例=外部源补),实盘同读本地文件

测试:21新测试(白名单fail-fast/日期语义/保真读/假日滤/门面schema/
列漂移fail-fast/真空日空表/注册表)+全量793绿;活文档§16+§15指引行 [vps]
2026-09-02 10:43:11 +08:00
..

Sanguo VeighNa 文档中心

本目录包含项目的完整文档体系。

📚 文档目录

1. 需求文档 (requirements/)

业务需求、功能需求和非功能需求的存放位置。

  • business/ - 业务需求文档 (BRD)
  • functional/ - 功能需求文档和用户故事
  • non_functional/ - 非功能需求(性能、安全等)

查看详情: requirements/README.md


2. 设计文档 (design/)

技术架构和详细设计文档。

  • architecture/ - 系统架构设计
  • database/ - 数据库设计
  • ui/ - 界面设计和原型
  • integration/ - 接口和集成设计

查看详情: design/README.md


3. API 文档 (api/)

接口定义和 API 规范。

  • rest/ - REST API 文档
  • event/ - 事件定义和说明
  • internal/ - 内部接口定义

查看详情: api/README.md


4. 用户指南 (user_guide/)

面向终端用户的使用文档。

  • quick_start/ - 快速开始指南
  • tutorials/ - 详细教程
  • faq/ - 常见问题

查看详情: user_guide/README.md


5. 运维文档 (operations/)

系统部署、监控和故障排查。

  • deployment/ - 部署文档
  • monitoring/ - 监控指标和告警
  • troubleshooting/ - 故障排查手册

查看详情: operations/README.md


6. 量化研究 (research/)

因子、策略和回测报告。

  • factors/ - 因子研究文档
  • strategies/ - 策略说明文档
  • backtests/ - 回测报告

查看详情: research/README.md


📝 文档规范

命名规范

类型 格式 示例
业务需求 brd-XXX.md brd-001-平台概述.md
功能需求 feature-XXX-模块-功能.md feature-001-gateway-ctp.md
设计文档 system-名称.md system-交易核心.md
API 文档 gateway-接口名.md gateway-ctp-api.md
用户文档 主题.md installation.md

编写规范

  1. 使用 Markdown 格式
  2. 代码块指定语言
  3. 添加必要的图表和示例
  4. 保持与代码同步更新
  5. 使用中文编写,技术术语保留英文

🔗 快速链接


📋 文档更新记录

日期 文档 变更说明
2025-07-01 全部 初始化文档体系