本文件用於開發維護:列出 qteasy/__init__.py::__all__ 頂層導出 API 的來源模塊與文檔落點,便於做全局 API 文檔一致性審計。
注意:本文件不作爲用戶教程入口(不會自動出現在 Sphinx TOC 中),僅用於倉庫內維護。
1. 顶层导出(按 __all__ 分类)
1.1 啓動/運行入口(core / configure)
run(qteasy/core.py):統一運行入口(回測/優化/實盤等)is_ready(qteasy/core.py):檢查運行條件info(qteasy/core.py):幫助/資訊入口(目前未實現)configure(qteasy/configure.py):配置入口set_config(qteasy/configure.py):配置別名configuration/get_config/get_configurations(qteasy/configure.py):查看配置save_config/load_config/reset_config/view_config_files(qteasy/configure.py):配置文件與重置start_up_settings/update_start_up_setting/remove_start_up_setting/get_start_up_settings(qteasy/configure.py):啓動配置維護start_up_config(qteasy/__init__.py):啓動配置解析結果(常量)
對應文檔入口:
docs/source/api/use_qteasy.rst(啓動與運行)docs/source/api/api_reference.rst(配置與參考)
1.2 數據獲取/概覽(core)
get_basic_info/get_stock_info(qteasy/core.py)get_data_overview/refill_data_source(qteasy/core.py)get_history_data/get_kline(qteasy/core.py)filter_stock_codes/filter_stocks(qteasy/core.py)get_table_info/get_table_overview(qteasy/core.py)
對應文檔入口:
docs/source/api/history_data.rstdocs/source/references/2-get-history-data.md
1.3 研究容器(history)
HistoryPanel(qteasy/history.py)dataframe_to_hp/stack_dataframes(qteasy/history.py)
對應文檔入口:
docs/source/api/HistoryPanel.rstdocs/source/tutorials/2.5-historypanel-data-analysis.md(含 §9–§11:研究→回測遷移、多源拼板、導出 statsmodels)docs/source/design/10-historypanel-factor-research-layer.md(可選 FactorResearch 層評估)示例:
examples/historypanel_research_to_strategy.py、examples/historypanel_multisource_research.py、examples/historypanel_statsmodels_export.py
1.4 策略與算子(operator / strategy / built_in)
Operator(qteasy/qt_operator.py)BaseStrategy/RuleIterator/GeneralStg/FactorSorter(qteasy/strategy.py)built_ins/built_in_list/built_in_strategies/get_built_in_strategy(qteasy/built_in.py)
對應文檔入口:
docs/source/api/Operators.rstdocs/source/api/Strategies.rstdocs/source/api/built_in_strategies.rst
1.5 數據源與數據類型(database / datatypes)
DataSource(qteasy/database.py)DataType/StgData/find_history_data(qteasy/datatypes.py)
對應文檔入口:
docs/source/api/data_source.rstdocs/source/api/data_types.rst
1.6 可視化與費用(visual / finance)
candle(qteasy/visual.py)CashPlan/set_cost/update_cost(qteasy/finance.py)
對應文檔入口:
docs/source/api/use_qteasy.rst(入口)
1.7 常量與全局對象(init)
模式常量:
LIVE_MODE/BACKTEST_MODE/OPTIMIZE_MODE/PREDICT_MODE及別名路徑與對象:
QT_ROOT_PATH/QT_SYS_LOG_PATH/QT_TRADE_LOG_PATH/QT_CONFIG/QT_DATA_SOURCE/logger_core版本:
__version__/version_info
對應文檔入口:
docs/source/api/use_qteasy.rst(運行模式與常量速查)