- 新增 MkDocs + Material 文档站(19 页):入门、CLI、场景示例、FAQ、 Contributing、Changelog、API 参考(mkdocstrings 自动渲染)、内部原理 (架构 / 协议 / 三池路由 / 缓存) - 新增 docs/llms.txt:面向 LLM 的结构化摘要(枚举取值、方法速查、常见陷阱) - 新增 scripts/check_docs.py:校验文档与 api.py 公开方法清单是否漂移 - 新增根 CHANGELOG.md 作为版本记录唯一来源,docs/changelog.md 用 snippet 引入 - 新增 .github/workflows/docs.yml:push main 自动构建并部署 GitHub Pages - 修正文档口径:TdxData 公开方法 53 个(51 数据方法 + start/close); API_REFERENCE 版本号 v0.3.2 -> v0.4.0 - pyproject.toml 新增 docs 依赖组;.gitignore 忽略 site/
3.5 KiB
3.5 KiB
更新日志
本项目遵循 语义化版本。
Unreleased
新增
- 文档站(MkDocs + Material,自动部署到 https://openbot-coder.github.io/pytdxdata/)
llms.txt— 面向 LLM 的结构化摘要,供 AI 助手快速建立项目心智模型CHANGELOG.md独立成文件(此前内嵌在 README 中)
变更
- README 瘦身为「入口层」:只保留定位、安装、30 秒上手、特性与目录,深层内容迁入文档站
0.4.0 - 2026-09-15
新增
- 服务器文件「下载 + 解析」能力(对齐并超越 easy-tdx 的文件解析):
get_block_parsed(filename)— 板块block_zs/gn/fg.dat→list[TdxBlock](板块名 / 类别 / 成分股代码)get_industry_map()—tdxhy.cfg→dict[str, IndustryInfo](通达信行业 + 申万行业)get_financial_file_infos()—tdxfin/gpcw.txt→list[FinancialFileInfo](文件名 / MD5 / 大小)get_financial_records_parsed(filename)—gpcw*.zip解压 + 解析 →list[FinancialRecord](每股原始字段)
- 解析器模块
codec/block.py、codec/industry.py、codec/financial.py(纯标准库,脱网可单测) - 数据模型
TdxBlock/IndustryInfo/FinancialFileInfo/FinancialRecord - CLI 新增 4 个命令:
tdx block/tdx industry/tdx financial-list/tdx financial - 测试
tests/test_cli_files.py(11 项 CLI 离线测试,FakeTD 桩)
修复
- 修复财报索引市场字段解析(
<6s1c1L→<6sBL)。此前恒判深市,现市场字段 0=深 / 1=沪 正确
变更
- 公开异步方法 47 → 51,新增接口全部向后兼容(原
bytes方法保留) - README 与
docs/API_REFERENCE.md同步更新
0.3.2 - 2026-08-17
新增
get_kline_batch(stocks, period, ...)— 批量 K 线,多股票自动并发,连接池分配不同服务器get_minute_batch(stocks, ...)— 批量分时,多股票自动并发
0.3.1 - 2026-08-17
变更
get_kline(MIN_1)切换为 MAC 通道(0x122E),解决标准通道 1 分钟 K 线深度不足的问题router.py中KlinePeriod.MIN_1强制路由到 MAC 通道- 标准通道其他周期(
MIN_5/15/30/60/DAY/WEEK/MONTH)不受影响
修复
- 修复 MAC K 线并发分页的数据空洞:并发分页器把不同页分配到不同服务器,
而各服务器数据深度不一致时
stop_when_short会导致非确定性数据丢失。 改为单连接串行分页(_fetch_mac_kline_serial,start动态偏移,与 easy-tdx 一致)
0.3.0 - 2026-08-17
变更
get_minute切换为 MAC 通道(0x122DMacTickChartCmd),历史分时稳定返回完整 240 条(09:30~14:59)- 移除不再使用的
GetHistoryMinuteTimeDataCmd
新增
protocol/commands/mac_tick.py— MAC 单日分时图命令
[0.2.2] 及之前
- 初始版本:动态连接池 + 双层 TTL 缓存 + 3 连接并发分页 + 双通道(标准 / MAC)+ 扩展市场(港股 / 美股 / 期货 / 期权)