このファイルは開発とメンテナンス用です。このファイルには、qteasy/__init__.py::__all__ にエクスポートされたトップレベル API のソース モジュールとドキュメントの保存先がリストされており、グローバル API ドキュメントの一貫性監査の実施が容易になります。

注: このファイルはユーザー チュートリアルのエントリ ポイントとしては使用されません (Sphinx の目次には自動的に表示されません)。これはリポジトリ内のメンテナンスのみを目的としています。

1. 顶层导出(按 __all__ 分类)

1.1 起動/実行エントリ ポイント (コア/構成)

  • 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 データの取得/概要 (コア)

  • 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.rst

  • docs/source/references/2-get-history-data.md

1.3 研究コンテナ(履歴)

  • HistoryPanel (qteasy/history.py)

  • dataframe_to_hp / stack_dataframes (qteasy/history.py)

対応するドキュメントのエントリ:

  • docs/source/api/HistoryPanel.rst

  • docs/source/tutorials/2.5-historypanel-data-analysis.md (§9–§11 を含む: 研究 → バックテストの移行、マルチソース パネルの結合、統計モデルへのエクスポート)

  • docs/source/design/10-historypanel-factor-research-layer.md (オプションの FactorResearch レイヤー評価)

  • 例: examples/historypanel_research_to_strategy.pyexamples/historypanel_multisource_research.pyexamples/historypanel_statsmodels_export.py

1.4 ストラテジーと演算子 (演算子 / ストラテジー / 組み込み)

  • 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.rst

  • docs/source/api/Strategies.rst

  • docs/source/api/built_in_strategies.rst

1.5 データソースとデータ型 (データベース/データ型)

  • DataSource (qteasy/database.py)

  • DataType / StgData / find_history_data (qteasy/datatypes.py)

対応するドキュメントのエントリ:

  • docs/source/api/data_source.rst

  • docs/source/api/data_types.rst

1.6 見える化とコスト(ビジュアル/財務)

  • 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 (実行モードと定数のクイックリファレンス)