- 新增 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/
46 lines
1.2 KiB
Markdown
46 lines
1.2 KiB
Markdown
# TdxData 方法签名
|
|
|
|
> 本页由 `mkdocstrings` **从 `src/pytdxdata/api.py` 的 docstring 实时渲染**。
|
|
> 你看到的签名就是当前代码的签名——不需要手动维护,也就不会过期。
|
|
|
|
## 用法
|
|
|
|
```python
|
|
import asyncio
|
|
from pytdxdata import TdxData
|
|
from pytdxdata.models import KlinePeriod, Market
|
|
|
|
async def main():
|
|
async with TdxData() as td:
|
|
bars = await td.get_kline(Market.SH, "600000", KlinePeriod.DAY, count=240)
|
|
print(bars[-1])
|
|
|
|
asyncio.run(main())
|
|
```
|
|
|
|
!!! tip "本页太长?"
|
|
想看「有哪些能力」的地图,去 [接口总览](index.md)。
|
|
本页是完整的签名字典,适合用浏览器 `Ctrl+F` 搜方法名。
|
|
|
|
## 完整定义
|
|
|
|
::: pytdxdata.TdxData
|
|
options:
|
|
members_order: source
|
|
group_by_category: true
|
|
show_category_heading: true
|
|
show_root_heading: true
|
|
show_root_full_path: false
|
|
show_signature_annotations: true
|
|
separate_signature: true
|
|
merge_init_into_class: true
|
|
docstring_section_style: list
|
|
filters:
|
|
- "!^_"
|
|
|
|
## 相关
|
|
|
|
- [枚举速查](enums.md) — 参数该填哪个成员
|
|
- [数据模型](models.md) — 返回值有哪些字段
|
|
- [场景示例](../cookbook.md) — 组合用法
|