* feat: DataFrame 直出(df="polars"/"pandas")+ 版本 0.7.0 TdxData 新增构造参数 df: - None(默认)→ 行为与 0.6.x 完全一致,返回 list[dataclass] - "polars"/"pandas" → 42 个表格型接口直接返回 DataFrame 转换层 src/pytdxdata/frames.py: - 列计划按模型缓存,列式采集(不做逐行 asdict) - 时间列替换:year/month/day/hour/minute → datetime + trading_date;Xdxr 给 date - 嵌套定型:bid/ask 展开 10 列、fields 字典 JSON 化、codes 保持列表 - 容器展开:get_indicators 合并指标、get_index_trade_stats 展开 minutes、 get_kline_batch/get_minute_batch 纵向拼接 - ContextVar 层次标记:批量/别名方法内层不二次转换,并发互不干扰 - 后端惰性加载:缺包抛 FrameBackendError(带安装命令),构造时即失败 依赖:新增 extras pandas/polars/dataframe,核心包仍零依赖;dev 组加 pandas+polars 测试:tests/test_frames.py 40 项(双后端×双格式);全量 401 项通过 文档:新增 docs/dataframe.md,同步 API_REFERENCE/SKILL/llms.txt/README/mkdocs * perf(kline): 按日期取K线贴最新时走倒推,1分钟 4.2s → 82ms 问题:start_date/end_date 一律走「探总根数 + 二分定位」。1 分钟 K 线历史 二十万根量级 = 6 次翻倍探测 + 2 次方向探测 + 两次各 ~18 次跳转,共 36+ 次 串行往返。「取今天」这个最常见的调用要 4.2 秒。 改法(_bars_backtrack 快路径): - 右端离最新不超过 _BACKTRACK_GRACE(10 天) 时,直接 start=0, count=N 拿最新 N 根再裁剪;N 按时间跨度估(_BARS_PER_DAY),一天内一次命中, 不够才翻倍,放大到 _BACKTRACK_MAX_BARS 仍不够则回落二分 - 历史中段仍走二分,结果口径完全一致(已逐条比对基准) 两个关键细节: - 偏移方向是通道级属性而非标的属性,首次探测后缓存在实例上 (_kline_dir_cache)——全市场 5,225 只批量只付一次探测成本 - K线 hour/minute 是周期**结束**时刻,最新一根可能比 now() 略大(14:29 那根还在走),「右端贴最新」必须留周期容差,否则 end_date=now() 被误判 成历史中段 实测(1 分钟,冷启动): 取今天 4,208ms → 82ms 2天前~now 2,211ms → 75ms 最近3天 2,000ms+ → 239ms 历史中段 1,512ms → 285ms 全市场5225只取今天 32.1s(1,140,699 根,精确当天口径) 注:route_for 让 MIN_1 一律走 MAC(0x122E),所以按通道做方向缓存而不是按 「标准/扩展」写死分支。 测试:新增 tests/test_kline_date.py 6 项(倒推次数上界、结束时刻容差、 中段回落二分、未来区间、反向通道、与 count 路径口径一致);全量 407 项通过 * perf(kline): 全市场1分钟K线改多连接流水线抓取(43.6s → 5~7s,盘中 2s) 瓶颈其实是**往返次数**不是带宽:单只K线一请求一标的,串行 33ms/只 ≈ 1 个 RTT。 同一台服务器 16 连接 × 深度 8 实测能跑 5.2 MB/s(此前「单 IP 限流 1.5MB/s」 是浅流水下的假象)。 - get_bars 新增 pipeline 参数(None=按单请求字节自适应 8~32,1=关闭走逐只) - 多标的(≥16 只)走 _bulk_bars:多连接 work-stealing + 单连接 execute_pipeline - 只用实测最快的 12 台:池里 24 台全用反而被慢节点拖长尾 - 盘中按交易时段只拉已走过的根数(10:00 → 35 根,数据量差 7 倍) - 标准通道(日线不复权)同样走批量:全市场 49~72s → 13s - 修 pipeline 失败时队列剩余标的静默丢失(实测 20 只只回 16 只) - 修 test_future_range_returns_empty_quickly 时间炸弹(固定日期会漂进 _BACKTRACK_GRACE) - conftest 关闭后台测速 task,避免污染「往返次数」类断言 实测(5,225 只):count=2 → 2.7s;count=35 → 2.2s;count=240 → 6.9s。 逐根一致性 30/30 相同。新增 tests/test_bulk_kline.py 12 项,合计 419 项全绿。 * test: 批量K线测试的时间锚点改用真实 now(CI 是 UTC,固定日期会漂到别的时段分支) * fix(ex): EX 通道 K 线回填成交额与结算价(0x23FF 槽位按市场分两类) 报告:EX 通道 get_bars 返回的 SecurityBar.amount 恒为 0.0。 定位属实,但实际情况比报告更细 —— 32B 记录里那 28B 行情只有**一个** 4B 槽位 可复用,语义按市场分两类(全市场实测,用 成交额/(close×vol) 逐条校验): | 市场 | 槽位5 | 槽位6 | 槽位7 | |---|---|---|---| | 港股主板31/港股基金49 | 成交额(f) | 量(手=100股) | 未知 | | 港股创业板48/新三板44/美股74 | 成交额(f) | 量(股) | 0 | | 期货/期权 7/8/9/47… | 持仓量(I) | 量 | 结算价(f) | 改前 amount 硬编码 0.0、第 7 个 float 用 `_` 丢弃 —— 于是港股/美股/新三板 明明帧内有成交额却全为 0,期货期权的结算价也拿不到。 - 新增 SecurityBar.settle(结算价,float|None):仅 EX 期货/期权日线有值, 分钟线该槽位恒 0 已归一化为 None,其它通道恒 None。 - 权益类市场回填真实 amount;港股主板/基金的 vol 单位是手(=100股), amount/vol 是均价的 100 倍,已写进模型注释与量纲表。 - 期货/期权的 amount 仍是 0.0(帧内确实没有成交额,协议限制), 已在 SecurityBar / API_REFERENCE / llms.txt / SKILL.md 写清, 避免使用者再按旧文档判断成调用方 bug。 - 港股指数27/中证指数62 该槽位量级对不上(既非额也非结算价),保守保持 0.0。 - SecurityBar.__setstate__ 兜底旧磁盘缓存:缓存键无 schema 版本,升级后读旧 pickle 缺 settle 槽位,默认反序列化不补默认值 → AttributeError,已容错; EX K 线缓存键额外加 @v2,让 amount 恒 0 的旧缓存自然失效。 - K 线 DataFrame 因此多一列 settle(0.7.0 未发布,列清单同步更新)。 测试:tests/test_ex_bars_fields.py 16 项(解析层双布局、日内 settle 归零、 API 透传、旧 pickle 兼容);全套 435 项通过。 * docs: 0.7.0 全站口径同步(DataFrame 出口 + EX 成交额限制 + 构造参数表) - 首页:特性表补「DataFrame 直出」与 K 线批量性能,导航新增 DataFrame 卡片, 统一方法数按实测修正为 35(+33 别名 = 68 个公开方法) - 安装页:补 extras(polars/pandas/dataframe)与 df 用法;构造参数表补 df / std_pool_cap / ex_pool_cap,并把 pool_max 默认值从 12 修正为 24(实际值) - 场景示例:`转成 pandas` 一节改为先推 df= 开关,手动转换降级为局部场景 - 数据模型页:不再说「刻意不提供 DataFrame」,改为 dataclass 与 DataFrame 是同一份数据、两种容器 - AI 接入页:返回值约定补 `df=` 开关的说法 - README:K 线列注释补 settle;已知限制补 EX 通道成交额/结算价的协议口径 - CHANGELOG:新增「升级」小节(升级命令、旧缓存无需清理) --------- Co-authored-by: openbot-coder <openbot-coder@users.noreply.github.com>
6.1 KiB
6.1 KiB
DataFrame 输出(pandas / polars)
0.7.0 起,TdxData 可以直接把表格型接口的返回值变成 DataFrame,不用再自己 [asdict(x) for x in rows]。
设计上只有一条开关,就是构造参数 df:
from pytdxdata import TdxData, KlinePeriod
# 默认:df=None,行为和 0.6.x 完全一致,返回 list[dataclass]
async with TdxData() as td:
bars = await td.get_bars("sh600000", KlinePeriod.DAY, count=240) # list[SecurityBar]
# 要 DataFrame 就在构造时声明一次后端
async with TdxData(df="polars") as td:
df = await td.get_bars("sh600000", KlinePeriod.DAY, count=240) # polars.DataFrame
async with TdxData(df="pandas") as td:
df = await td.get_bars("sh600000", KlinePeriod.DAY, count=240) # pandas.DataFrame
安装
pandas / polars 都是可选依赖——pytdxdata 的 dependencies 仍然是空的,不想用 DataFrame 的人一点额外开销都不用付。
pip install "pytdxdata[polars]" # 只要 polars
pip install "pytdxdata[pandas]" # 只要 pandas
pip install "pytdxdata[dataframe]" # 两个都要
没装就 TdxData(df="polars"),会在构造时直接报错,而不是等到第一次查询:
FrameBackendError: 未安装 polars,无法输出 DataFrame。请执行:pip install pytdxdata[polars]
df 取值非法(比如 df="numpy")抛 ValueError,并列出可用值。
三个口径约定
1. 时间列:datetime 替换拆开的年月日时分
原始模型为了解析性能把时间拆成 year/month/day/hour/minute。DataFrame 里再这么摆,用的人第一件事就是自己拼时间戳——所以直接给一列 datetime:
| 模型 | 原始字段 | DataFrame 里的列 |
|---|---|---|
SecurityBar / IndexBar |
year month day hour minute |
datetime(+ trading_date) |
MinuteBar |
date hour minute day_offset |
datetime(+ trading_date) |
XdxrRecord |
year month day |
date |
datetime的 dtype:polars 是Datetime('us'),pandas 是datetime64[ns]。trading_date是YYYY-MM-DD字符串,按交易日聚合要用它:美股一个交易日横跨两个北京自然日(21:30→次日 04:00),凌晨段的datetime属于次日,但trading_date归属前一交易日。- 除权记录的
date是「日」不是「时刻」,值为当日 00:00,仍用 datetime 类型以便排序比较。 TransactionRecord.time只有HH:MM:SS、协议里没有日期,所以逐笔不生成datetime,time原样保留。
2. 嵌套字段:能定型的定型,不能定型的 JSON 化
| 字段 | DataFrame 里的形态 |
|---|---|
SecurityQuote.bid / ask(五档) |
展开成 bid1_price bid1_vol … ask5_price ask5_vol 共 10 列,缺档为 None |
fields(A股字段位 / EX 额外字段) |
JSON 字符串列;空字典给 None(不会看到一列 "{}") |
TdxBlock.codes(成分股列表) |
保持列表(polars 为 List(Str),pandas 为 object),需要时 .explode() |
fields 之所以不展开:键集随市场和通道变化,展开会让列数失控。
3. 特殊容器会被展开成一张表
| 接口 | 原始返回 | DataFrame 形态 |
|---|---|---|
get_indicators |
list[IndicatorSet] |
bars 列 + 每个指标一列,按长度对齐(不足补 None),symbol 取自 IndicatorSet.symbol |
get_index_trade_stats |
IndexTradeStats |
minutes 展开成行,并补 index / date 两个常量列 |
get_index_trade_stats_multi |
list[IndexTradeStats] |
同上,多个指数纵向拼接 |
get_kline_batch / get_minute_batch |
dict[标的, list[...]] |
各标的分块纵向拼接成一张表(symbol/code 列本来就在行里) |
get_board_ranking / get_board_change_ranking |
list[dict] |
按首次出现顺序取键并集作为列名 |
哪些接口不受影响
df 只作用于表格型返回。下面这些原样返回,不转 DataFrame:
| 返回类型 | 接口 |
|---|---|
bytes |
get_file get_block_info get_report_file download_file get_financial_records |
int |
get_security_count get_goods_count |
dict |
decimal_point_status get_board_summary get_industry_map |
| 单个对象 | get_server_info get_market_stat get_symbol_info |
tuple |
get_price_limits get_kline_offset |
list[float] / list[str] |
get_chart_sampling get_goods_chart_sampling get_financial_file_list |
理由是单行表没有意义,而 bytes/int 根本不是表格数据。
空结果
查不到数据时返回的是列名齐全的空 DataFrame(列由模型定义推出,不依赖是否拿到行):
async with TdxData(df="polars") as td:
df = await td.get_xdxr("sz000001") # 假设当天无除权
df.height, df.columns # 0, ['market', 'code', 'date', ...]
⚠️ 空表只保证列名正确,dtype 由后端自行推断(polars 可能全为 Null,pandas 为 object)。
语义提醒
DataFrame 只是换了个容器,下面这些口径不会因为转成 DataFrame 而变化:
- 股票/ETF 的
vol是「手」,日线是「股」;可转债vol手=10 张,amount/vol是均价 ×10;指数逐笔vol是百元。 - 指数和 ETF/LOF 的
trade_count不是笔数(见TransactionRecord.trade_count_available)。 - 深市
399xxx的amount是全板块口径,不要拿去校验成分合计。 - K 线的
settle(结算价)列只有 EX 通道的期货/期权日线有值,其余行全为None; 同一批 EX 标的中,期货/期权的amount恒0.0(0x23FF帧内没有成交额), 港股主板/基金的vol单位是「手」(amount/vol是均价的 100 倍)。
性能
转换是列式采集:按模型预先算好列计划,一次遍历填满所有列,不做逐行 asdict()。
5,227 只 A 股报价转 polars 约 20~40ms,相对一次全市场查询(约 300ms)可以忽略。
df=None 时完全不经过这层(装饰器直接透传),零额外开销。