API 参考
August 14, 2026 · View on GitHub
本 API 文档涵盖了 AKQuant 的核心类和方法。
快速跳转:
1. 高级入口 (High-Level API)
akquant.run_backtest
最常用的回测入口函数,封装了引擎的初始化和配置过程。
def run_backtest(
data: Optional[BacktestDataInput] = None,
strategy: Union[Type[Strategy], Strategy, Callable[[Any, Bar], None], None] = None,
strategy_source: Optional[Union[str, bytes, os.PathLike[str]]] = None,
strategy_loader: Optional[str] = None,
strategy_loader_options: Optional[Dict[str, Any]] = None,
symbols: Optional[Union[str, List[str], Tuple[str, ...], set[str]]] = None,
initial_cash: Optional[float] = None,
commission_policy: Optional[CommissionPolicy] = None,
commission_rate: Optional[float] = None,
stamp_tax_rate: Optional[float] = None,
transfer_fee_rate: Optional[float] = None,
min_commission: Optional[float] = None,
slippage: SlippageInput = None,
volume_limit_pct: Optional[float] = None,
timezone: Optional[str] = None,
t_plus_one: bool = False,
initialize: Optional[Callable[[Any], None]] = None,
on_start: Optional[Callable[[Any], None]] = None,
on_resume: Optional[Callable[[Any], None]] = None,
on_train_signal: Optional[Callable[[Any], None]] = None,
on_stop: Optional[Callable[[Any], None]] = None,
on_tick: Optional[Callable[[Any, Any], None]] = None,
on_order: Optional[Callable[[Any, Any], None]] = None,
on_trade: Optional[Callable[[Any, Any], None]] = None,
on_reject: Optional[Callable[[Any, Any], None]] = None,
on_before_trading: Optional[Callable[[Any, Any, int], None]] = None,
on_after_trading: Optional[Callable[[Any, Any, int], None]] = None,
on_cross_section: Optional[Callable[[Any, Any, int], None]] = None,
on_portfolio_update: Optional[Callable[[Any, Dict[str, Any]], None]] = None,
on_error: Optional[Callable[[Any, Exception, str, Any], None]] = None,
on_expiry: Optional[Callable[[Any, Dict[str, Any]], None]] = None,
on_pre_open: Optional[Callable[[Any, Dict[str, Any]], None]] = None,
on_timer: Optional[Callable[[Any, str], None]] = None,
context: Optional[Dict[str, Any]] = None,
history_depth: Optional[int] = None,
warmup_period: int = 0,
lot_size: Union[int, Dict[str, int], None] = None,
show_progress: Optional[bool] = None,
start_time: Optional[Union[str, Any]] = None,
end_time: Optional[Union[str, Any]] = None,
catalog_path: Optional[str] = None,
config: Optional[BacktestConfig] = None,
custom_matchers: Optional[Dict[AssetType, Any]] = None,
risk_config: Optional[Union[Dict[str, Any], RiskConfig]] = None,
strategy_runtime_config: Optional[Union[StrategyRuntimeConfig, Dict[str, Any]]] = None,
runtime_config_override: bool = True,
strategy_id: Optional[str] = None,
strategies_by_slot: Optional[Dict[str, Union[Type[Strategy], Strategy, Callable[[Any, Bar], None]]]] = None,
strategy_max_order_value: Optional[Dict[str, float]] = None,
strategy_max_order_size: Optional[Dict[str, float]] = None,
strategy_max_position_size: Optional[Dict[str, float]] = None,
strategy_max_daily_loss: Optional[Dict[str, float]] = None,
strategy_max_drawdown: Optional[Dict[str, float]] = None,
strategy_reduce_only_after_risk: Optional[Dict[str, bool]] = None,
strategy_risk_cooldown_bars: Optional[Dict[str, int]] = None,
strategy_priority: Optional[Dict[str, int]] = None,
strategy_risk_budget: Optional[Dict[str, float]] = None,
strategy_fill_policy: Optional[Dict[str, FillMode]] = None,
strategy_slippage: Optional[Dict[str, SlippageInput]] = None,
strategy_commission: Optional[Dict[str, CommissionPolicy]] = None,
portfolio_risk_budget: Optional[float] = None,
risk_budget_mode: str = "order_notional",
risk_budget_reset_daily: bool = False,
analyzer_plugins: Optional[Sequence[AnalyzerPlugin]] = None,
on_event: Optional[Callable[[BacktestStreamEvent], None]] = None,
broker_profile: Optional[str] = None,
fill_policy: Optional[FillMode] = None,
strict_strategy_params: bool = True,
**kwargs: Any,
) -> BacktestResult
akquant.run_grid_search
参数网格搜索入口,用于批量回测并按指标排序返回最优参数组合。
def run_grid_search(
strategy: Type[Strategy],
param_grid: Mapping[str, Sequence[Any]],
data: Any = None,
max_workers: Optional[int] = None,
sort_by: Union[str, List[str]] = "sharpe_ratio",
ascending: Union[bool, List[bool]] = False,
return_df: bool = True,
warmup_calc: Optional[Any] = None,
constraint: Optional[Any] = None,
result_filter: Optional[Any] = None,
timeout: Optional[float] = None,
max_tasks_per_child: Optional[int] = None,
db_path: Optional[str] = None,
forward_worker_logs: bool = False,
**kwargs: Any,
) -> Union[pd.DataFrame, List[OptimizationResult]]
关键参数补充:
forward_worker_logs: 并行优化时是否将子进程策略日志回传到主进程。False:吞吐优先,日志可能在主进程不可见。True:启用日志聚合,便于排障。
strict_strategy_params: 通过**kwargs传递给run_backtest(默认在run_grid_search内为True)。- 严格校验
param_grid与策略构造参数匹配关系; - 参数不匹配时快速失败,避免静默回退。
- 严格校验
akquant.run_walk_forward
滚动优化入口。按窗口执行“样本内参数优化 + 样本外验证”,并拼接样本外资金曲线。
def run_walk_forward(
strategy: Type[Strategy],
param_grid: Mapping[str, Sequence[Any]],
data: pd.DataFrame,
train_period: int,
test_period: int,
metric: Union[str, List[str]] = "sharpe_ratio",
ascending: Union[bool, List[bool]] = False,
initial_cash: float = 100_000.0,
warmup_period: int = 0,
warmup_calc: Optional[Any] = None,
constraint: Optional[Any] = None,
result_filter: Optional[Any] = None,
compounding: bool = False,
timeout: Optional[float] = None,
max_tasks_per_child: Optional[int] = None,
**kwargs: Any,
) -> pd.DataFrame
关键参数补充:
**kwargs会透传到run_grid_search(样本内优化阶段)与run_backtest(样本外验证阶段)。- 因此,
forward_worker_logs可用于控制样本内并行优化日志回传。 - 同时,
strict_strategy_params会在优化与回测阶段保持严格参数校验语义(默认严格)。
akquant.run_from_checkpoint
从快照恢复并继续运行回测(支持多策略 slot 执行)。
def run_from_checkpoint(
checkpoint_path: str,
data: Optional[BacktestDataInput] = None,
show_progress: bool = True,
symbols: Optional[Union[str, List[str], Tuple[str, ...], set[str]]] = None,
commission_policy: Optional[CommissionPolicy] = None,
strategy_runtime_config: Optional[Union[StrategyRuntimeConfig, Dict[str, Any]]] = None,
runtime_config_override: bool = True,
strategy_id: Optional[str] = None,
strategies_by_slot: Optional[Dict[str, Union[Type[Strategy], Strategy, Callable[[Any, Bar], None]]]] = None,
strategy_max_order_value: Optional[Dict[str, float]] = None,
strategy_max_order_size: Optional[Dict[str, float]] = None,
strategy_max_position_size: Optional[Dict[str, float]] = None,
strategy_max_daily_loss: Optional[Dict[str, float]] = None,
strategy_max_drawdown: Optional[Dict[str, float]] = None,
strategy_reduce_only_after_risk: Optional[Dict[str, bool]] = None,
strategy_risk_cooldown_bars: Optional[Dict[str, int]] = None,
strategy_priority: Optional[Dict[str, int]] = None,
strategy_risk_budget: Optional[Dict[str, float]] = None,
strategy_fill_policy: Optional[Dict[str, FillMode]] = None,
strategy_slippage: Optional[Dict[str, SlippageInput]] = None,
strategy_commission: Optional[Dict[str, CommissionPolicy]] = None,
portfolio_risk_budget: Optional[float] = None,
risk_budget_mode: str = "order_notional",
risk_budget_reset_daily: bool = False,
on_event: Optional[Callable[[BacktestStreamEvent], None]] = None,
config: Optional[BacktestConfig] = None,
**kwargs: Any,
) -> BacktestResult
run_from_checkpoint 使用与 run_backtest 相同的策略 slot、策略级风控与成交默认项;
对这些字段,优先级为:显式函数参数 > config.strategy_config > checkpoint 恢复值 / 默认值。
通用行为说明(主要对应 run_backtest,run_from_checkpoint 共享其中的成交/风控/策略映射规则):
data: 回测数据。支持单个 DataFrame,{symbol: DataFrame}字典,List[Bar],DataFeed,或实现DataFeedAdapter.load(request)的对象。strategy: 策略类、策略实例,或on_bar函数(函数式编程风格)。strategy_source/strategy_loader/strategy_loader_options: 动态策略加载入口。strategy=None时可直接从源码、路径或自定义加载器构造策略。initialize/on_start/on_resume/on_stop: 函数式策略生命周期回调;其中on_resume(ctx)仅在 checkpoint 恢复后的热启动阶段触发,且先于on_start(ctx)。on_tick/on_order/on_trade/on_reject/on_before_trading/on_after_trading/on_cross_section/on_portfolio_update/on_error/on_expiry/on_pre_open/on_timer/on_train_signal: 函数式策略事件回调;其中on_expiry(ctx, event)在引擎实际执行到期结算后触发,on_pre_open(ctx, event)在每个交易日首个常规行情事件前触发,适合“盘前决策,本次 open 成交”;on_error(ctx, error, source, payload)会在其他用户回调抛出异常时触发;on_train_signal(ctx)仅在 ML 滚动训练窗口触发。symbols: 标的代码或代码列表。默认None(未显式传入):数据里出现的标的即视为要跑的标的(“数据即订阅”),行为与传入前完全一致。显式传入(哪怕传的是当前数据里已有的标的)后语义变为「只跑这些标的」:白名单外的标的会被前置过滤掉,不进入引擎、不参与撮合与统计(多标的输入下,回测结果可能因此变化);显式传入空集合会报错,而不是退化为不过滤。白名单实际由symbols∪config.instruments∪(__init__阶段)self.subscribe()已订阅的标的三者合并而成;显式传了symbols后,on_start里再subscribe()白名单外的标的会抛ValueError(详见策略指南「策略生命周期」一节on_start的说明)。此校验仅作用于回测:实盘run_live从不下发白名单,subscribe()不受约束。run_from_checkpoint的特例:白名单合并的第三项不只是本次调用__init__阶段的subscribe()——热启动恢复出来的策略实例带着从存档 pickle 恢复的_subscriptions(即上一段运行期间、含on_start里新增的全部订阅),这些也会并入白名单。也就是说,若阶段一的策略订阅过某个标的,阶段二哪怕不再显式subscribe()它,只要阶段二传了symbols,该标的仍会留在合并后的白名单里——这是热启动「延续上一段状态」的整体语义的一部分,与「__init__阶段订阅」并入run_backtest白名单的规则并非完全对称,请勿照搬run_backtest的白名单范围去推断run_from_checkpoint的实际过滤结果。- 迁移提示(旧版
symbols="BENCHMARK"写法):改动前,symbol/symbols的签名默认值就是字面量"BENCHMARK"(仓库内部分热启动示例也这么显式写过)。升级后,显式传入的值一律被当作真实过滤条件,不再等价于「未传」,且不同数据形态下会向相反方向出错:List[Bar]/DataFeed形态因为数据里没有任何标的字面量等于"BENCHMARK",白名单谁都不放行,回测直接空跑(只有一条 WARNING,其余悄无声息);DataFrame/Dict[str, DataFrame]形态则因为"BENCHMARK"触发了既有前置过滤判据的短路,反而完全不过滤。升级方式很简单:把显式的symbols="BENCHMARK"删掉(省略该参数),不要迁移成其他字面量。
initial_cash: 初始资金。未显式传入时会回落到StrategyConfig.initial_cash,其默认值为100000.0。commission_policy: 运行级默认佣金策略。支持三种模式:{"type": "percent", "value": 0.0003}: 按成交额比例收费。{"type": "fixed", "value": 3.0}: 每次成交固定收取 3 元。{"type": "per_unit", "value": 0.01}: 按成交数量线性收费,即fill_quantity * 0.01。- 若显式提供,优先级高于
commission_rate;commission_rate仍保留为兼容入口。
- legacy 价格基准参数:已移除。
- legacy 时序参数:已移除。
fill_policy: 运行级默认成交语义,接受一个FillMode对象(从akquant顶层导入)。五个命名模式:NextOpen(): 下一根 K 线开盘价成交(默认,无未来函数)。NextClose(): 下一根 K 线收盘价成交。NextAverage(): 下一根 K 线 OHLC4 均价成交。NextHighLowMid(): 下一根 K 线 HL2(高低中价)成交。CurrentClose(timer_fill_timing="immediate"|"deferred"): 当根收盘价成交;timer_fill_timing仅影响on_timer触发的订单如何撮合(immediate当期成交,deferred顺延到下一根 bar)。
- 旧的
fill_policy=dict(price_basis/bar_offset/temporal)与make_fill_policy(...)已移除,传入 dict 会抛出TypeError。请改用上述FillMode构造器。 legacy_execution_policy_compat(通过**kwargs): 已移除。- 迁移建议:legacy 执行参数已不再接受,统一使用
FillMode对象。 strict_strategy_params: 是否严格校验策略构造参数(默认True)。- 当传入策略不接受的参数时会立即抛错;
- 推荐保持默认值,避免参数错配被静默忽略导致回测结果偏差。
t_plus_one: 是否启用 T+1 交易规则 (默认 False)。如果启用,将强制使用中国市场模型。slippage: 全局滑点 (默认 0.0)。例如 0.0001 代表 1bp (0.01%) 的滑点,采用百分比模型。volume_limit_pct: 成交量限制比例 (默认 0.25)。限制单笔成交不超过该 Bar 总成交量的百分比。warmup_period: 策略预热期。指定需要预加载的历史数据长度(Bar 数量),用于计算指标。start_time/end_time: 回测开始/结束时间。若传入 naive 时间字符串或Timestamp,会按当前timezone解释,再转换为 UTC 参与过滤。catalog_path: 当data未显式传入时,可从该目录按ParquetDataCatalog规则加载数据。config:BacktestConfig配置对象,用于集中管理配置。lot_size: 最小交易单位。如果是int,应用于所有标的;如果是字典,按标的匹配。custom_matchers: 自定义撮合器字典。risk_config: 风控配置。支持字典 (e.g.,{"max_position_pct": 0.1}) 或RiskConfig对象。如果同时提供了config.strategy_config.risk,此参数将覆盖其中的同名字段。strategy_runtime_config/runtime_config_override: 运行时行为注入与冲突处理开关,支持StrategyRuntimeConfig或dict。strategies_by_slot: 可选多策略映射。键为 slot id,值为策略类/实例/函数式 on_bar 回调;用于启用 slot 迭代执行。strategy_fill_policy: 可选策略级默认成交策略映射(strategy_id -> FillMode)。 下单时优先级:订单级fill_mode>strategy_fill_policy[strategy_id]> 运行级fill_policy。strategy_slippage: 可选策略级默认滑点映射(strategy_id -> slippage)。 下单时优先级:订单级slippage>strategy_slippage[strategy_id]> 运行级slippage。strategy_commission: 可选策略级默认佣金映射(strategy_id -> commission)。 下单时优先级:订单级commission>strategy_commission[strategy_id]> 运行级佣金模型。commission/strategy_commission中的CommissionPolicy与运行级commission_policy共享同一结构:
{"type": "percent" | "fixed" | "per_unit", "value": non_negative_number}
* `percent`: 按成交额比例收费。
* `fixed`: 每次成交固定金额,不随成交数量变化。
* `per_unit`: 按成交数量收费,适合“每股/每手/每份”线性收费场景。
- 配置分层(推荐心智模型):
- 订单级(
buy/sell/submit_order传参); - 策略映射级(
strategy_*,按strategy_id/slot); - 运行级(
run_backtest参数); - 市场默认(market model 内建默认规则)。
- 订单级(
- T+1 范围说明:当前
t_plus_one仍是运行级/市场级开关,不支持按strategy_id分层配置。 analyzer_plugins: 可选 Analyzer 插件列表。插件接收on_start/on_bar/on_trade/on_finish生命周期回调,结果汇总到result.analyzer_outputs。on_event: 可选事件回调。不传时内部使用 no-op 回调并保持阻塞返回语义;传入时可实时消费事件。broker_profile: 可选 broker 参数模板,用于快速注入费率/滑点/最小手数等默认值。内置模板:cn_stock_miniqmt、cn_stock_t1_low_fee、cn_stock_sim_high_slippage。
fill_policy 推荐示例(主路径):
import akquant as aq
from akquant import NextClose, CurrentClose
# 下一根 K 线收盘价成交
result = aq.run_backtest(
data=data,
strategy=MyStrategy,
symbols="000001",
fill_policy=NextClose(),
)
# 当根收盘价 + timer 订单顺延到下一根 bar
result = aq.run_backtest(
data=data,
strategy=MyStrategy,
symbols="000001",
fill_policy=CurrentClose(timer_fill_timing="deferred"),
)
执行语义速查(五个命名模式):
| 场景 | FillMode |
|---|---|
| next-open 风格成交(默认) | NextOpen() |
| 当根收盘价成交 | CurrentClose() |
| 下一根收盘价成交 | NextClose() |
| 下一根 OHLC 均价成交 | NextAverage() |
| 下一根 HL2 成交 | NextHighLowMid() |
说明:
- 只有
CurrentClose支持timer_fill_timing参数;其余模式的on_timer订单均在下一根 bar 成交。 timer_fill_timing="immediate"(默认):timer 触发即在当根收盘价成交;"deferred":timer 不构成成交点,顺延到下一根 bar。它只影响on_timer订单,对普通on_bar订单无影响。
DataFeedAdapter 用法(多时间框):
import akquant as aq
base = aq.CSVFeedAdapter(path_template="/data/{symbol}.csv")
feed_15m = base.resample(freq="15min", emit_partial=False)
feed_replay = base.replay(
freq="1h",
align="session", # session | day | global
day_mode="trading", # 仅 align='day' 时生效: trading | calendar
emit_partial=False,
session_windows=[("09:30", "11:30"), ("13:00", "15:00")], # 仅 align='session'
)
result = aq.run_backtest(
data=feed_replay,
strategy=MyStrategy,
symbols="000001",
show_progress=False,
)
align="session": 按交易日分区,可叠加session_windows。align="day": 按日分区,不接收session_windows;day_mode支持trading/calendar。align="global": 按全局时间轴聚合,不按交易日切段。- 参数建议:统一使用
symbols。run_backtest/run_from_checkpoint已不再接受symbol参数。
兼容与迁移说明:
- 推荐逐步将实时 UI / 日志 / 告警接入迁移到
run_backtest(..., on_event=...)。 - 流式场景统一使用
run_backtest(..., on_event=...)。 - legacy 执行语义兼容开关已移除。
- legacy 执行参数与
legacy_execution_policy_compat不再接受。 - 公开执行配置全量统一使用
FillMode对象(fill_policy=NextOpen()等)。 - 在 PyCharm 中若未开启终端仿真,原生进度条可能不可见;可开启
Emulate terminal in output console或改用on_event的progress事件输出文本进度。 - 阶段 5 后不再提供运行时参数级回滚开关;如需回滚请使用版本级回滚策略。
阶段 5 迁移 FAQ:
run_backtest是否改名?不改名,调用方式保持不变。run_backtest是否仍可不传on_event?可以,不传时仍返回同样的结果对象语义。- PyCharm 看不到进度条怎么办?先确认
show_progress=True,并在 Run 配置中开启Emulate terminal in output console;若仍不可见,使用on_event消费progress事件打印文本进度。 - 线上出现问题如何回退?使用版本级回滚,不再支持
_engine_mode参数级回切。 - 还可以继续用
symbol吗?不可以。请统一迁移到symbols。
akquant.merge_results
def merge_results(
*results: BacktestResult,
drop_expired_instruments: bool = True,
dedupe_boundary: bool = True,
) -> MergedResult
把 run_from_checkpoint 分阶段续跑产生的多段 BacktestResult 按时间顺序合并成
一个 MergedResult,提供与 BacktestResult 一致的只读视图(equity_curve /
cash_curve / margin_curve / orders_df / trades_df / executions_df /
positions_df / daily_returns / to_quantstats)。
行为:
- 曲线与订单/交易/执行/持仓按时间戳拼接;
dedupe_boundary=True时去除相邻段 重叠的边界时间戳(同戳保留后一段,对齐引擎 upsert 语义)。 - 各段必须时间递增、互不重叠(允许 gap);重叠段抛
ValueError。 drop_expired_instruments=True时,依据各段策略 instrument snapshot 的expiry_date清理已过期合约的持仓行,避免长区间资产爆炸。
metrics 为核心子集: MergedResult.metrics / metrics_df 仅重算能从合并权益
曲线 + 交易明细无歧义推导的指标(total_return_pct / max_drawdown /
sharpe_ratio / sortino_ratio / calmar_ratio / volatility /
annualized_return / win_rate / profit_factor / end_market_value 等,
口径对齐单段回测)。其余依赖引擎内部态的字段不提供,访问时抛 AttributeError;
如需完整 60 项指标,请在单段完整回测的 BacktestResult 上读取。
流式参数与事件 (run_backtest)
关键参数:
on_event: 流式事件回调函数(可选),参数为BacktestStreamEvent;不传时内部使用 no-op 回调。stream_progress_interval:progress事件采样间隔(正整数)。stream_equity_interval:equity事件采样间隔(正整数)。stream_batch_size: 事件批量刷新阈值(正整数)。stream_max_buffer: 缓冲区上限(正整数)。stream_error_mode: 回调异常处理策略。"continue": 回调报错后继续回测,并在结束事件中回传统计信息。"fail_fast": 回调首次报错后立即终止,并抛出异常。
stream_mode: 流式模式。"observability": 观测模式,允许采样与非关键事件背压丢弃。"audit": 审计模式,禁用采样并采用阻塞背压(不丢弃非关键事件)。
strategy_id(通过**kwargs透传): 为交易相关事件与结果打上策略归属,默认_default。
事件结构 (BacktestStreamEvent):
run_id: 本次流式回测 ID。seq: 事件序号(单调递增)。ts: 事件时间戳(纳秒)。event_type: 事件类型。symbol: 关联标的(部分事件为空)。level: 事件级别(如info、warn、error)。payload: 事件内容字典(字符串键值)。
常见 event_type:
- 生命周期:
started,finished - 采样更新:
progress,equity - 交易相关:
order,trade,risk,expiry - 运行异常:
error - 行情流:
tick
交易事件 payload 常用字段 (order/trade/risk/expiry):
owner_strategy_id: 策略归属 ID(默认_default)。order_id: 订单 ID(order/trade/risk)。symbol: 标的代码(order/risk)。status: 订单状态(order)。filled_qty: 订单已成交量(order)。trade_id: 成交 ID(trade)。price: 成交价格(trade)。quantity: 成交数量(trade)。reason: 风控拒绝原因(risk)。expiry_date: 到期日(expiry,YYYYMMDD)。quantity_before: 到期前持仓数量(expiry)。quantity_closed: 本次因到期关闭的数量(expiry)。cash_flow: 到期结算现金流(expiry)。settlement_type: 到期结算模式(expiry,如cash、settlement_price、force_close)。settlement_price: 实际采用的结算价(expiry,存在时提供)。
finished.payload 常用字段:
status:completed或failedprocessed_events: 已处理事件数total_trades: 总成交笔数callback_error_count: 回调报错次数dropped_event_count: 背压丢弃事件总数dropped_event_count_by_type: 按事件类型聚合的丢弃计数(event=count逗号拼接)stream_mode: 当前流式模式(observability或audit)sampling_enabled: 是否启用采样(true/false)backpressure_policy: 背压策略(drop_non_critical或block)last_callback_error: 最近一次回调报错信息(存在时提供)reason: 失败原因(存在时提供)
akquant.BacktestConfig
用于集中配置回测参数的数据类。
@dataclass
class BacktestConfig:
strategy_config: StrategyConfig
start_time: Optional[str] = None
end_time: Optional[str] = None
instruments: Optional[List[str]] = None
instruments_config: Optional[Union[List[InstrumentConfig], Dict[str, InstrumentConfig]]] = None
china_futures: Optional[ChinaFuturesConfig] = None
china_options: Optional[ChinaOptionsConfig] = None
benchmark: Optional[str] = None
timezone: str = "Asia/Shanghai"
show_progress: bool = True
history_depth: int = 0
# Analysis & Bootstrap
bootstrap_samples: int = 1000
bootstrap_sample_size: Optional[int] = None
analysis_config: Optional[Dict[str, Any]] = None
akquant.StrategyConfig
策略层面的配置,包含资金、费率和风控。
@dataclass
class StrategyConfig:
initial_cash: float = 100000.0
commission_rate: float = 0.0
commission_policy: Optional[Dict[str, Any]] = None
stamp_tax_rate: float = 0.0
transfer_fee_rate: float = 0.0
min_commission: float = 0.0
enable_fractional_shares: bool = False
round_fill_price: bool = True
slippage: Union[float, Dict[str, Any], None] = 0.0
volume_limit_pct: float = 0.25
max_long_positions: Optional[int] = None
max_short_positions: Optional[int] = None
exit_on_last_bar: bool = True
indicator_mode: str = "precompute"
risk: Optional[RiskConfig] = None
strategy_id: Optional[str] = None
strategies_by_slot: Optional[Dict[str, Any]] = None
strategy_source: Optional[str] = None
strategy_loader: Optional[str] = None
strategy_loader_options: Optional[Dict[str, Any]] = None
strategy_max_order_value: Optional[Dict[str, float]] = None
strategy_max_order_size: Optional[Dict[str, float]] = None
strategy_max_position_size: Optional[Dict[str, float]] = None
strategy_max_daily_loss: Optional[Dict[str, float]] = None
strategy_max_drawdown: Optional[Dict[str, float]] = None
strategy_reduce_only_after_risk: Optional[Dict[str, bool]] = None
strategy_risk_cooldown_bars: Optional[Dict[str, int]] = None
strategy_priority: Optional[Dict[str, int]] = None
strategy_risk_budget: Optional[Dict[str, float]] = None
strategy_fill_policy: Optional[Dict[str, Dict[str, Any]]] = None
strategy_slippage: Optional[Dict[str, Dict[str, Any]]] = None
strategy_commission: Optional[Dict[str, Dict[str, Any]]] = None
portfolio_risk_budget: Optional[float] = None
akquant.InstrumentConfig
用于配置单个标的属性的数据类。
@dataclass
class InstrumentConfig:
symbol: str
asset_type: Union[
Literal["STOCK", "FUTURES", "FUND", "OPTION"],
InstrumentAssetTypeEnum
] = InstrumentAssetTypeEnum.STOCK
multiplier: float = 1.0 # 合约乘数
margin_ratio: float = 1.0 # 保证金率 (0.1 表示 10% 保证金)
tick_size: float = 0.01 # 最小变动价位
lot_size: Optional[int] = None
# 费率与执行 (资产专用)
commission_rate: Optional[float] = None
min_commission: Optional[float] = None
stamp_tax_rate: Optional[float] = None
transfer_fee_rate: Optional[float] = None
slippage: Optional[Union[float, Dict[str, Any]]] = None
# 期权相关
option_type: Optional[
Union[Literal["CALL", "PUT"], InstrumentOptionTypeEnum]
] = None
strike_price: Optional[float] = None
expiry_date: Optional[Union[int, date, datetime]] = None
underlying_symbol: Optional[str] = None
option_margin_model: Optional[InstrumentOptionMarginModelEnum] = None
implied_volatility: Optional[float] = None
reference_volatility: Optional[float] = None
settlement_type: Optional[
Union[
Literal["cash", "settlement_price", "force_close"],
InstrumentSettlementTypeEnum
]
] = None
settlement_price: Optional[float] = None
static_attrs: Dict[str, Union[str, int, float, bool]] = field(default_factory=dict)
常用枚举(均可在 akquant 顶层直接访问):
InstrumentAssetTypeEnum:STOCK/FUTURES/FUND/OPTIONInstrumentOptionMarginModelEnum:RATIO/CHINA_SINGLE_LEG/US_BROKER_SINGLE_LEG/US_BROKER_SINGLE_LEG_VOL_ADJUSTEDInstrumentOptionTypeEnum:CALL/PUTInstrumentSettlementTypeEnum:CASH/SETTLEMENT_PRICE/FORCE_CLOSE
示例:
conf = akquant.InstrumentConfig(
symbol="IF2506",
asset_type=akquant.InstrumentAssetTypeEnum.FUTURES,
settlement_type=akquant.InstrumentSettlementTypeEnum.CASH,
)
akquant.InstrumentSnapshot
策略侧可访问的标的静态属性快照对象(由引擎注入,通常通过 Strategy.get_instrument* 读取)。
@dataclass(frozen=True)
class InstrumentSnapshot:
symbol: str
asset_type: Literal["STOCK", "FUTURES", "FUND", "OPTION"]
multiplier: float
margin_ratio: float
tick_size: float
lot_size: float
option_margin_model: Optional[Literal["RATIO", "CHINA_SINGLE_LEG", "US_BROKER_SINGLE_LEG", "US_BROKER_SINGLE_LEG_VOL_ADJUSTED"]] = None
option_type: Optional[Literal["CALL", "PUT"]] = None
strike_price: Optional[float] = None
expiry_date: Optional[int] = None # YYYYMMDD
underlying_symbol: Optional[str] = None
implied_volatility: Optional[float] = None
reference_volatility: Optional[float] = None
settlement_type: Optional[Literal["CASH", "SETTLEMENT_PRICE", "FORCE_CLOSE"]] = None
settlement_price: Optional[float] = None
static_attrs: Dict[str, Union[str, int, float, bool]] = field(default_factory=dict)
要点:
expiry_date使用int(YYYYMMDD)语义。- 快照在
on_start即可访问。 - 建议在策略中通过
get_instrument/get_instrument_config/get_instrument_field访问。 - 回测与实盘的字段覆盖不同:回测快照由
InstrumentConfig灌入,字段齐全;实盘(run_live)只接Instrument对象,它仅能回读symbol/asset_type/multiplier/margin_ratio/tick_size/lot_size/option_margin_model/implied_volatility/reference_volatility,因此option_type/strike_price/expiry_date/underlying_symbol/settlement_type/settlement_price/static_attrs在实盘快照里为None(或空 dict)。期权策略若依赖这些字段,需自行通过策略参数或context传入。
配置系统详解 (Configuration System)
AKQuant 提供了灵活的配置系统,允许用户通过多种方式设置回测参数。
1. 配置层级 (Hierarchy)
配置对象采用树状结构组织,BacktestConfig 是顶层入口:
BacktestConfig (回测场景)
├── StrategyConfig (策略与账户)
│ ├── initial_cash (初始资金)
│ ├── commission_policy / commission_rate (默认佣金)
│ ├── slippage (默认滑点)
│ └── RiskConfig (风控规则)
│ ├── safety_margin (安全垫)
│ └── max_position_pct (持仓限制)
└── InstrumentConfig (资产属性)
├── multiplier (合约乘数)
└── commission_rate (资产专用佣金,覆盖 StrategyConfig)
中国期货扩展配置位于 BacktestConfig.china_futures,用于管理前缀级规则:
instrument_templates_by_symbol_prefix: 品种模板(乘数/保证金/tick/手数/费率)fee_by_symbol_prefix: 品种费率覆盖validation_by_symbol_prefix: 品种撮合校验开关覆盖enforce_sessions: 是否严格按交易时段控制成交session_profile: 中国期货会话模板(CN_FUTURES_DAY=CN_FUTURES_COMMODITY_DAY/CN_FUTURES_CFFEX_STOCK_INDEX_DAY/CN_FUTURES_CFFEX_BOND_DAY/CN_FUTURES_NIGHT_23/CN_FUTURES_NIGHT_01/CN_FUTURES_NIGHT_0230)
配置对象采用“构造即校验”:
symbol_prefix为空会直接报错- 模板数值范围非法(如
multiplier <= 0)会直接报错 - 同一列表内前缀重复会报错并标注冲突项索引
2. 参数优先级 (Priority)
run_backtest 函数的参数解析遵循以下优先级(由高到低):
- 显式参数 (Explicit Arguments):
- 直接传递给
run_backtest的参数优先级最高。 - 例如:
run_backtest(start_time="2022-01-01")会覆盖config.start_time。
- 直接传递给
- 配置对象 (Config Objects):
- 如果显式参数为
None,则从config(BacktestConfig) 中读取。 - 多策略字段可集中配置在
config.strategy_config(如strategy_id、strategies_by_slot、strategy_max_*、strategy_priority、strategy_risk_budget、portfolio_risk_budget)。
- 如果显式参数为
- 默认值 (Defaults):
- 如果上述两者都未提供,则使用系统默认值。
中国期货扩展(BacktestConfig.china_futures)推荐使用以下优先级口径:
| 配置项 | 高优先级 | 中优先级 | 默认值 |
|---|---|---|---|
| 合约参数(乘数/保证金/tick/手数) | InstrumentConfig 显式字段 | instrument_templates_by_symbol_prefix | run_backtest 默认参数 |
| 品种费率 | fee_by_symbol_prefix | 模板 commission_rate | StrategyConfig.commission_policy 或 StrategyConfig.commission_rate |
| 品种校验开关 | validation_by_symbol_prefix | 模板 enforce_tick_size / enforce_lot_size | 全局 ChinaFuturesConfig.enforce_* |
| 交易时段 | china_futures.sessions 显式配置 | session_profile 模板 | ChinaMarket 默认会话 |
| 市场路由 | use_china_futures_market=False 或混合资产回落 | use_china_futures_market=True 且纯期货 | use_simple_market |
中国股票扩展(BacktestConfig.china_stock)的委托校验开关:
| 配置项 | 字段 | 默认值 | 说明 |
|---|---|---|---|
| 委托价 tick 对齐校验 | ChinaStockConfig.enforce_tick_size | True | 关掉后股票/基金的非对齐委托价不再被撮合拒单。与 ChinaFuturesConfig.enforce_tick_size 对称 |
from akquant import BacktestConfig, ChinaStockConfig, StrategyConfig
config = BacktestConfig(
strategy_config=StrategyConfig(initial_cash=100000.0),
china_stock=ChinaStockConfig(enforce_tick_size=False), # 关闭 tick 校验
)
enforce_tick_size 缺省开启,非对齐委托价(如 tick_size=0.01 却传 2.8314)在回测撮合与实盘报单前都会被拒单而非静默取整——目的是让回测与实盘口径一致。需要自动对齐请用 Strategy.round_to_tick(),详见 tick size 对齐指南。
口径说明:
- 同级规则冲突时,以显式规则覆盖模板规则。
- 撮合校验路径按更具体前缀优先(更长匹配优先)。
中国期权扩展配置位于 BacktestConfig.china_options,用于管理中国期权费率:
fee_per_contract: 全局每张合约手续费fee_by_symbol_prefix: 按品种前缀覆盖每张合约手续费use_china_market: 是否切换到 ChinaMarketsessions: 可选时段覆盖(不与期货会话配置冲突时生效)
中国期权扩展推荐使用以下优先级口径:
| 配置项 | 高优先级 | 中优先级 | 默认值 |
|---|---|---|---|
| 期权费率(按张) | fee_by_symbol_prefix | fee_per_contract | set_option_fee_rules 默认配置 |
| 市场路由 | use_china_market=True | 混合资产时自动 ChinaMarket | use_simple_market |
期货 vs 期权配置能力对照:
| 能力维度 | 中国期货(china_futures) | 中国期权(china_options) |
|---|---|---|
| 路由开关 | use_china_futures_market | use_china_market |
| 全局费率 | StrategyConfig.commission_policy / StrategyConfig.commission_rate 或模板费率 | fee_per_contract |
| 前缀费率覆盖 | fee_by_symbol_prefix | fee_by_symbol_prefix |
| 合约参数模板 | 支持(乘数/保证金/tick/手数) | 不支持 |
| 撮合校验开关 | 支持(tick/手数,含前缀覆盖) | 不支持 |
| 会话覆盖 | 支持(sessions) | 支持(sessions) |
| 前缀匹配策略 | 更长前缀优先 | 更长前缀优先 |
股票配置推荐使用以下优先级口径:
| 配置项 | 高优先级 | 中优先级 | 默认值 |
|---|---|---|---|
| 股票费率(佣金/印花税/过户费/最低佣金) | InstrumentConfig 单标的费率字段 | StrategyConfig 全局费率字段(含 commission_policy / commission_rate) | run_backtest 内置默认值 |
交易单位(lot_size) | InstrumentConfig.lot_size(显式设置) | run_backtest(lot_size=...) 全局设置 | 1 |
| 市场制度(T+1) | run_backtest(t_plus_one=...) 显式参数 | Engine.set_t_plus_one(...) 引擎设置 | False |
| 市场模型 | use_china_market() | use_simple_market() | 引擎默认市场配置 |
股票侧说明:
- 当前股票没有按代码前缀的模板层(不像期货的
china_futures前缀模板)。 - 生产场景建议优先用
InstrumentConfig精确配置重点股票,再用StrategyConfig作为全局兜底。
3. 风控配置合并 (Risk Config Merging)
risk_config 参数的处理逻辑比较特殊,旨在支持“基准配置 + 快速覆盖”的模式:
- 基准: 首先加载
config.strategy_config.risk(如果存在)。 - 覆盖: 如果提供了
risk_config参数(字典或对象),它将覆盖基准配置中的同名字段。- 这允许你在不修改 Config 对象的情况下,通过
run_backtest(..., risk_config={"max_position_pct": 0.5})快速调整风控参数进行测试。
- 这允许你在不修改 Config 对象的情况下,通过
4. 策略运行时配置注入 (Strategy Runtime Config Injection)
run_backtest 与 run_from_checkpoint 支持 strategy_runtime_config 参数:
- 支持
StrategyRuntimeConfig对象或dict。 - 用于在不修改策略类代码的前提下注入运行时行为开关。
- 示例:
run_backtest(..., strategy_runtime_config={"error_mode": "continue"})。 - 校验行为:未知字段或非法值会快速失败,并给出字段级错误信息。
- 冲突处理:
runtime_config_override=True时应用外部配置;False时保留策略侧配置。 - 上述冲突规则在
run_backtest与run_from_checkpoint中保持一致。 - 对同一策略实例、同一冲突内容,告警日志会自动去重。
- 优先级规则:显式传入的
strategy_runtime_config参数高于转发配置映射中的同名配置。 - 故障速查入口:参考 Runtime Config 指南。
from akquant import StrategyRuntimeConfig, run_backtest
result = run_backtest(
data=data,
strategy=MyStrategy,
strategy_runtime_config=StrategyRuntimeConfig(
error_mode="continue",
portfolio_update_eps=1.0,
),
)
5. 最佳实践 (Best Practices)
- 简单脚本: 直接使用
run_backtest的扁平参数(如initial_cash,start_time)。 - 生产/复杂策略: 构建完整的
BacktestConfig对象,以便于版本管理和复用。 - 页面化参数输入: 在策略类中内联声明参数字段(
IntParam等,例如fast_period = IntParam(10, ge=2, le=200),运行时通过self.params.fast_period访问),并使用get_strategy_param_schema/validate_strategy_params完成前后端参数联动与校验。 - 参数调优: 使用
run_grid_search时,通常通过修改 Config 对象或传入 override 参数来实现。
日志配置 API (Logging)
AKQuant 作为库使用时默认保持静默;未显式配置前,akquant 根 logger 仅挂载 NullHandler。
akquant.LogConfig
高级日志配置对象,供 configure_logging(...) 使用。
核心字段:
level: 全局回退等级。console: 是否启用控制台 handler。console_level/file_level: handler 级别覆盖。console_format/file_format: 文本 formatter 覆盖。console_show_context/file_show_context: 文本模式下是否附带结构化上下文。console_json/file_json: 是否对对应 handler 启用 JSON line 输出。filename: 文件日志路径。file_mode: 文件模式,默认a。file_max_bytes/file_backup_count: 启用按大小轮转时的阈值与保留份数。profile: 预设 profile,支持research、optimize、live。reset_handlers: 是否重置 AKQuant 自己管理的 handler。propagate: 是否向上游 logger 传播。mask_sensitive: 是否对敏感字段脱敏(默认True)。密钥类(password/token/api_key等)全掩码、账户类(user_id/account等)保留尾 4 位;在 handler 层兜底,任何调用点忘记脱敏也不会泄漏。order_audit_file: 实盘订单审计的独立 JSON 文件路径。设置后,broker_live下每一笔订单的提交/回报/成交/撤单/拒单会额外以 JSON line 写入该文件(akquant.audit.order命名空间),用于事后对账与复盘。order_audit_level: 审计文件级别,默认INFO。order_audit_max_bytes/order_audit_backup_count: 审计文件按大小轮转的阈值与保留份数(默认保留 5 份)。language: 控制台审计消息语言,"en"(默认)/"zh"。仅影响控制台的订单审计行渲染;文件与 JSON 恒为英文 canonical,结构化字段(event/side/price等)任何语言下不变,因此 grep/告警/对账不会因语言分裂。
akquant.configure_logging
def configure_logging(config: LogConfig) -> logging.Logger
使用结构化配置初始化或重配 akquant 日志系统。
推荐示例:
import akquant
akquant.configure_logging(
akquant.LogConfig(
profile="live",
level="INFO",
console=True,
console_json=False,
filename="logs/live.log",
file_level="DEBUG",
file_json=True,
file_max_bytes=10_000_000,
file_backup_count=5,
)
)
行为说明:
profile只填充未显式指定的字段,显式参数优先级更高。profile="optimize"默认文本格式会带processName,便于区分 worker。profile="live"适合打开结构化上下文或 JSON 输出。- Rust 侧运行路径中的
akquant.*warning 也会桥接进入 Pythonlogging,并尽量恢复为统一的结构化字段。 - 例如执行链路中的保证金不足拒单、收盘过期、取消未知订单、同一切片
same-cycle延后等 warning,会携带phase="execution",并在可用时附带symbol、order_id、strategy_id、slot、event_time_iso。
akquant.register_logger
def register_logger(
filename: Optional[str] = None,
console: bool = True,
level: str = "INFO",
) -> None
兼容快捷接口,适合快速打开日志,不暴露高级字段。内部会转成 configure_logging(LogConfig(...))。
akquant.get_logger
def get_logger(name: Optional[str] = None) -> logging.Logger
获取 akquant 命名空间下的 logger:
get_logger()->akquantget_logger("strategy")->akquant.strategyget_logger("gateway.live")->akquant.gateway.live
akquant.set_log_level
def set_log_level(level: Union[str, int]) -> None
修改当前 akquant 根 logger 的 level。
使用边界
self.log(...)面向人类阅读的策略调试日志。run_backtest(..., on_event=...)面向机器消费的统一事件流,更适合实时 UI、告警、审计落盘。- 在
on_order/on_trade/on_reject中使用self.log(...)时,日志会自动携带order_id/client_order_id等结构化字段。 - Rust 执行层与数据层产生的 warning 不需要用户手动接管;只要已经配置了
akquantlogger handler,它们就会进入同一套文本或 JSON 输出链路。
2. 策略开发 (Strategy)
akquant.Strategy
策略基类。用户应继承此类并重写回调方法。
回调方法:
on_start(): 策略启动时触发。用于订阅 (subscribe) 和注册指标。on_bar(bar: Bar): K 线闭合时触发。on_tick(tick: Tick): Tick 到达时触发。on_order(order: Order): 订单状态更新时触发(如成交、取消、拒绝)。on_trade(trade: Trade): 订单成交时触发。on_reject(order: Order): 订单首次进入Rejected时触发一次。on_expiry(event: Dict[str, Any]): 到期结算回调。仅当引擎实际执行expiry_date驱动的到期结算/移除后触发;回调时账户状态已更新。示例见:examples/49_on_expiry_demo.py。on_before_trading(trading_date, timestamp): 每个本地交易日首次进入常规交易会话时触发一次;默认回测路径下该会话通常表现为Continuous。该回调按“前一交易日/前一时点信息可见”的语义工作。on_pre_open(event: Dict[str, Any]): 每个交易日首个常规行情事件前触发一次。适合“盘前决策,本次 open 成交”;默认下单语义等价于NextOpen()(下一根 open 成交)。示例见:examples/52_pre_open_demo.py。on_cross_section(trading_date, timestamp): 横截面同周期调仓钩子。在框架看到当日首个“跨标的完整 bar 切片”后触发,每个交易日最多一次;与on_before_trading不同,它可以看到当日历史和当前账户快照,适合收盘价同周期调仓。调仓频率(日/周/月)在回调内用日历判断。on_after_trading(trading_date, timestamp): 离开常规交易会话时触发;若先跨日则在下一事件补发。on_portfolio_update(snapshot): 账户快照变化时触发。on_error(error, source, payload=None): 用户回调抛异常时触发,默认触发后继续抛出。on_timer(payload: str): 定时器触发。on_stop(): 策略停止时触发。on_train_signal(context): 滚动训练信号触发 (ML 模式)。
on_pre_open 推荐写法:
def on_pre_open(self, event: Dict[str, Any]) -> None:
signal = self.compute_pre_open_signal()
if signal > 0:
self.buy("000001", quantity=100)
说明:若这里不显式传 fill_mode,框架会默认按 NextOpen()(当日 open)语义处理订单。
属性与快捷访问:
self.symbol: 当前正在处理的标的代码。self.close,self.open,self.high,self.low,self.volume: 当前 Bar/Tick 的价格和成交量。self.position: 当前标的持仓辅助对象 (Position),包含size和available属性。self.now: 当前回测时间 (pd.Timestamp)。self.runtime_config: 运行时行为配置对象 (StrategyRuntimeConfig)。self.enable_precise_day_boundary_hooks: 是否启用边界定时器精确交易日钩子(默认False)。该开关只影响日边界 hooks 的触发精度,不改变on_before_trading中get_history()、get_account()、equity等接口的可见数据窗口。self.portfolio_update_eps: 账户快照更新阈值,低于该变化量不触发on_portfolio_update(默认0.0)。self.error_mode: 错误处理模式,"raise"或"continue"(默认"raise")。self.re_raise_on_error: 用户回调异常后是否继续抛出(默认True)。self.ctx: 策略上下文 (StrategyContext),提供底层 API 访问。
交易方法:
buy(symbol=None, quantity=None, price=None, trigger_price=None, ...): 买入(开多/平空)。- 如果不指定
price,则为市价单。 - 如果指定
price,则为限价单。 - 如果指定
trigger_price,则为止损/止盈单 (Stop Market)。 - 不传
symbol时取当前 bar/tick 的标的;在无行情上下文的回调(如on_start)中必须显式传入。 - 不传
quantity时按self.sizer计算下单量(默认FixedSize(100),可用set_sizer()替换)。
- 如果不指定
sell(symbol=None, quantity=None, price=None, trigger_price=None, ...): 卖出(平多/开空)。参数同上,但不传quantity时不走 sizer,而是全平当前持仓:回测取总持仓,broker_live取可用持仓(A 股 T+1 下当日买入部分不可卖,按总量报单会被柜台整单拒绝)。- 解析后下单量
<= 0时不报单,返回空回执(len(receipt) == 0、receipt.primary == "")。 submit_order(..., order_type="StopTrail", trail_offset=..., trail_reference_price=None): 提交跟踪止损单。trail_offset必须大于 0。submit_order(..., order_type="StopTrailLimit", price=..., trail_offset=..., trail_reference_price=None): 提交跟踪止损限价单。price与trail_offset必填。submit_order(..., broker_options={...}): 可选 broker 扩展参数透传(回测阶段仅记录在订单对象order.broker_options上,便于联调与审计)。place_trailing_stop(symbol, quantity, trail_offset, side="Sell", trail_reference_price=None, ...) -> str: 跟踪止损助手,触发后按市价执行。place_trailing_stop_limit(symbol, quantity, price, trail_offset, side="Sell", trail_reference_price=None, ...) -> str: 跟踪止损限价助手,触发后按限价执行。rebalance_weights(target_weights, price_map=None, liquidate_unmentioned=False, allow_leverage=False, rebalance_tolerance=0.0, ...): 按多标的目标权重调仓。target_weights形如{symbol: weight},默认要求权重和不超过1.0。liquidate_unmentioned=True时,会将未出现在目标字典中的现有持仓目标设为0。- 执行顺序为先卖后买,减少现金约束导致的调仓失败。
rebalance_tolerance按组合市值比例跳过小偏差,降低无效换手。
cancel_order(order_id: str): 撤销指定订单。cancel_all_orders(symbol): 取消指定标的的所有挂单。如果不指定symbol,则取消所有挂单。place_oco(first_order_id, second_order_id, group_id=None) -> str: 创建 OCO 订单组。组内任一订单成交后,另一订单会被自动撤单。place_bracket(symbol, quantity, entry_price=None, stop_trigger_price=None, take_profit_price=None, ...) -> str: 创建 Bracket 订单。先提交进场单,进场成交后自动提交止损/止盈;当止损与止盈同时存在时会自动绑定 OCO。
数据与工具:
get_history(count, symbol, field="close", freq=None) -> np.ndarray: 获取历史数据数组(返回滚动缓冲的安全快照拷贝,非零拷贝)。get_history_multi(count, symbol, fields=("open","high","low","close","volume"), freq=None) -> Dict[str, np.ndarray]: 单次跨界批量取回多字段,语义等价于逐字段get_history,get_history_df内部即基于它。get_history_map(count, symbols, field="close", freq=None) -> Dict[str, np.ndarray]: 批量获取多个标的历史数据。rebalance_to_topn(scores, top_n, weight_mode="equal", ...) -> List[str]: 根据打分选取 TopN 并执行调仓,支持等权或按分数归一化。get_history_df(count, symbol, freq=None) -> pd.DataFrame: 获取历史数据 DataFrame (OHLCV)。freq参数(get_history/get_history_map/get_history_multi/get_history_df/get_rolling_data均支持):取值'tick'/'bar'/None。None(默认):该 symbol 只有 bar 序列时取 bar,只有 tick 序列时取 tick(单流下行为不变);若on_bar与on_tick同时触发导致该 symbol 同时存在 bar 与 tick 两条历史序列,则报ValueError,要求显式传freq='bar'或freq='tick'——不会静默选一条。未识别的取值同样报错,不会兜底成'bar'。freq='tick'时field只支持price/close/volume:tick 没有 open/high/low,传这些字段会抛ValueError(此前会静默返回退化 OHLC,price冒充high,破坏性变更)。get_history_df/get_rolling_data固定取 OHLCV 五字段,因此在freq='tick'下必然报错,请改用get_history(freq='tick', field='price')。- 回测中让
on_bar与on_tick同时触发:run_backtest(data=[Tick, ...], freq="1min")(freq只在data为含Tick的列表时生效,DataFrame 不支持,传了会报错而非静默忽略)。实盘中的等价开关是gateway_options={"emit_ticks": True, "emit_bars": True}(klinedata、CTP 网关均支持,use_aggregator保留为兼容别名):两个网关对emit_ticks/emit_bars本身的处理规则一致——按参数逐个回退(只显式传其一不会静默关掉另一路),若回退后emit_ticks与emit_bars都为False则报错而非静默不推送任何数据。broker="ctp"走的是run_live(..., gateway_options=...)→ builder 转发这条链路,此前该链路会把这两个键静默丢弃(on_tick永不触发且无任何报错),现已修复为原样转发到底层CTPMarketGateway。klinedata 有一个前置条件 CTP 没有:klinedata 多一个drive参数,缺省为drive="bar",此时无论emit_ticks/emit_bars怎么传都会被强制覆盖为emit_bars=True、emit_ticks=False(该覆盖排在「都为 False 则报错」的校验之前,所以这条校验在drive="bar"下永远不可能触发)——要让on_tick真正触发,必须显式传"drive": "tick",仅传emit_ticks=True不够。CTP 没有drive这一层,emit_ticks=True会直接生效。
get_position(symbol) -> float: 获取当前持仓量。返回值仍为数量,不返回对象。get_available_position(symbol) -> float: 获取可用持仓量。positions -> Dict[str, float]: 获取所有标的持仓(只读属性)。self.position.entry_price -> float: 通过Positionhelper 获取当前标的持仓均价。self.position.avg_price -> float:entry_price的别名。ctx.get_position_entry_price(symbol) -> float: 获取指定标的当前持仓均价。ctx.get_position_entry_prices() -> Dict[str, float]: 获取所有标的当前持仓均价。get_holding_bars(symbol) -> int: 获取当前持仓持有的 Bar 数量。cash -> float: 获取当前可用资金(只读属性)。get_account() -> Dict[str, float]: 获取账户详情快照。常见字段包括cash、equity、market_value、notional_value、frozen_cash、margin、used_margin、free_margin、unrealized_pnl、borrowed_cash、short_market_value、maintenance_ratio、account_mode、accrued_interest、daily_interest。- 现金账户 / 现货账户下,
market_value通常表示持仓市值。 - 期货保证金账户下,
equity表示账户权益,used_margin表示已占用保证金,notional_value表示期货名义敞口,unrealized_pnl表示浮动盈亏;期货持仓不会像股票那样把全额名义本金直接计入cash扣减,也不会把名义敞口直接映射为market_value。 cash是现金余额,free_margin(=equity - used_margin)才是可用于新开仓的资金,与下单被拒时日志里的Available口径一致。期货保证金账户下开仓不从cash扣减保证金,因此cash通常大于free_margin;股票现金账户下二者相等。- 在策略回调内,如果你只想读取“当前账户总权益”,优先使用
equity;其口径与get_account()["equity"]对齐。
- 现金账户 / 现货账户下,
get_order(order_id) -> Order: 获取指定订单详情。get_open_orders(symbol) -> List[Order]: 获取当前未完成订单列表。get_trades() -> List[ClosedTrade]: 获取所有已平仓交易记录。subscribe(instrument_id: str): 订阅行情。log(msg: str, level: int): 输出带时间戳的日志。schedule(trigger_time, payload): 注册单次定时任务。schedule_daily(time_str, payload): 注册每日定时任务(每个交易日触发)。schedule_weekly(time_str, payload): 每周首个交易日触发(节假日/停牌自动顺延)。schedule_monthly(time_str, payload): 每月首个交易日触发(节假日/停牌自动顺延)。trading_days -> List[pd.Timestamp]: 只读交易日序列,配合schedule自定义节奏。nth_trading_day_of_month(n)/nth_last_trading_day_of_month(n)/nth_trading_day_of_week(n): 交易日历辅助,返回每月/周第 n 个(或倒数第 n 个)交易日。to_local_time(timestamp) -> pd.Timestamp: 将 UTC 时间戳转换为本地时间。format_time(timestamp, fmt) -> str: 格式化时间戳。
标的静态属性 API(推荐):
get_instrument(symbol) -> InstrumentSnapshot: 获取单个标的静态属性快照。get_instruments(symbols=None) -> Dict[str, InstrumentSnapshot]: 获取多个标的静态属性快照字典;symbols=None时返回全部。get_instrument_field(symbol, field) -> Any: 获取单个标的字段值。get_instrument_config(symbol, fields=None) -> Union[Any, Dict[str, Any], InstrumentSnapshot]: 兼容接口;支持整对象、单字段或多字段读取。round_to_tick(symbol, price, direction="nearest") -> float: 按该标的的tick_size对齐委托价。direction取"down"(买入侧保守)/"up"(卖出侧保守)/"nearest"。股票/基金的非对齐委托价会被撮合与实盘报单前校验拒单(见 tick size 对齐指南),需要自动对齐时显式调用本方法。
说明:
- 这些接口在
on_start即可使用(启动阶段已注入快照)。 - 推荐优先使用这些接口读取静态属性,而不是依赖
bar.extra。
机器学习支持:
set_rolling_window(train_window, step): 设置滚动训练窗口。get_rolling_data(length, symbol, freq=None): 获取滚动训练数据 (X, y)。freq语义与限制同上一节的get_history系列(底层基于get_history_df)。prepare_features(df, mode): (需重写) 特征工程与标签生成。
akquant.Bar
K 线数据对象。
timestamp: Unix 时间戳 (纳秒)。open,high,low,close,volume: OHLCV 数据。symbol: 标的代码。extra: 扩展数据字典 (Dict[str, float])。timestamp_iso: UTC ISO 8601 时间字符串。
akquant.Tick
Tick 数据对象。
timestamp: Unix 时间戳 (纳秒)。price: 最新价。volume: 成交量。单笔量(与回测语义一致),不是累计量。- 实盘网关(CTP、klinedata)推给
on_tick/add_tick的Tick.volume是这一笔的成交量;柜台/上游行情原始推的是当日累计成交量,网关内部按 symbol 做差分换算后才对外暴露单笔量。 - 与之相对,网关内部用于
freq聚合(tick 合成 bar)的BarAggregator吃的是原始累计量(构造时声明volume_is_cumulative=True,由聚合器自己差分求和)——这是刻意的分工,不要把它当成 bug "修" 成单笔量,否则聚合量会被腰斩。 - 已知代价:进程盘中启动时,某 symbol 收到的第一帧行情因为没有上一次累计量可比对,换算不出真实单笔量,此时
Tick.volume记为0(表示"未知",而非误用累计量冒充单笔量)。若策略里有「volume == 0就跳过」之类的防御逻辑,会连带跳过每个 symbol 的第一笔行情。
- 实盘网关(CTP、klinedata)推给
symbol: 标的代码。
akquant.run_live(broker_live 执行语义) {: #live-broker-semantics }
实盘 broker 路由可通过 gateway_options 传入网关特定参数:
from akquant import run_live
run_live(
strategy_cls=on_bar,
instruments=instruments,
broker="ctp",
trading_mode="broker_live",
gateway_options={"execution_semantics_mode": "strict"},
)
gateway_options.execution_semantics_mode:
| 取值 | 默认值 | 行为 | 推荐场景 |
|---|---|---|---|
strict | 是 | Cancelled / Rejected / Filled 等终态由订单回报 (OnRtnOrder) 最终确认。错误回报会先缓存拒单原因,再在后续订单回报中补齐。 | 生产实盘 |
compatible | 否 | 在部分错误/撤单路径允许本地立即推进终态,以兼容历史行为。 | 迁移过渡 |
严格模式注意事项:
- 撤单请求发送成功不等于
Cancelled,需等待OnRtnOrder(Cancelled)。 - 收到错误回报不等于
Rejected,最终状态以订单回报为准。
3. 核心引擎 (Core)
akquant.Engine
回测引擎的主入口 (通常通过 run_backtest 隐式使用)。
配置方法:
set_timezone_name(timezone: str): 设置 IANA 时区名称,例如Asia/Shanghai、UTC、US/Eastern。推荐优先使用此方法,以正确处理 DST 和历史时区规则。set_timezone(offset: int): 设置固定时区偏移秒数。仅作为兼容接口保留,不包含 DST / 历史时区规则。use_simulated_execution()/use_realtime_execution(): 设置执行环境。set_fill_mode(mode: ExecutionMode, timer_timing: str): 设置运行级默认执行模式。mode取ExecutionMode枚举(NextOpen/NextClose/NextAverage/NextHighLowMid/CurrentClose),timer_timing取"same_cycle"/"next_event"(仅对CurrentClose有意义)。日常使用推荐通过run_backtest(..., fill_policy=NextOpen())传入FillMode对象,由框架翻译到该底层方法。get_fill_policy(): 获取当前执行模式对应的核心三元组(price_basis, bar_offset, temporal)(内部表示)。set_history_depth(depth): 设置历史数据缓存长度。
市场与费率配置:
use_simple_market(): 启用简单市场(按比例佣金兼容入口)。use_simple_market_policy(type, value): 启用简单市场并显式设置佣金模式。use_china_market(): 启用中国市场 (股票)。use_china_futures_market(): 启用中国期货市场。set_stock_fee_rules(commission, stamp_tax, transfer_fee, min_commission): 设置股票费率。set_stock_fee_policy(type, value, stamp_tax, transfer_fee, min_commission): 设置股票佣金模式与费率。set_futures_fee_rules(commission_rate): 设置期货费率。set_futures_fee_rules_by_prefix(symbol_prefix, commission_rate): 设置期货品种前缀费率。set_futures_validation_options(enforce_tick_size, enforce_lot_size): 设置期货撮合前校验开关。set_futures_validation_options_by_prefix(symbol_prefix, enforce_tick_size, enforce_lot_size): 设置期货品种前缀校验开关。set_fund_fee_rules(...): 设置基金费率。set_option_fee_rules(...): 设置期权费率。set_slippage(type, value): 设置滑点 (Fixed 或 Percent)。set_volume_limit(limit): 设置成交量限制 (如 0.1 表示不超过 Bar 成交量的 10%)。set_market_sessions(sessions): 设置交易时段。
命名约定说明:
- 期货费率接口统一使用复数命名
set_futures_fee_rules*。 - 旧单数命名
set_future_fee_rules*已移除,不再对外暴露。
akquant.DataFeed
DataFeed 是引擎内部的事件数据源封装,适合在你希望显式控制“数据如何进入引擎”时直接使用。
构造与工厂方法:
DataFeed(): 创建一个空的历史数据源。DataFeed.from_csv(path, symbol): 直接从 CSV 文件创建数据源;适合由 Rust 侧按行读取并驱动事件流。DataFeed.create_live(): 创建实时数据源,适合供 gateway / 行情推送场景写入事件。
写入方法:
add_bar(bar): 向数据源追加单个Bar。add_bars(bars): 向数据源批量追加Bar列表。add_tick(tick): 向实时数据源追加单个Tick。add_arrays(timestamps, opens, highs, lows, closes, volumes, symbol): 通过数组快速批量构建Bar并注入数据源。sort(): 对当前历史数据源按事件时间排序。
使用边界:
- 若你只是做普通回测,优先使用
run_backtest(data=...),直接传DataFrame、List[Bar]或DataFeedAdapter即可。 - 若你需要复用同一数据源对象、显式切换历史/实时模式,或直接接入
Engine.add_data(feed),则使用DataFeed更合适。 from_csv(...)/add_arrays(...)中如果遇到非法浮点值,Rust 侧会记录 warning,并通过 AKQuant 的 Pythonlogging体系输出,例如akquant.data.client、akquant.data.batch。
akquant.gateway 自定义 Broker 注册
可通过注册表机制按名称接入自定义 broker,而无需修改内置工厂分支。
注册表 API:
register_broker(name, builder): 注册 broker 构建函数。unregister_broker(name): 取消注册 broker。get_broker_builder(name): 查询 broker 构建函数。list_registered_brokers(): 获取当前已注册 broker 列表。
Builder 签名:
def builder(
feed: DataFeed,
symbols: Sequence[str],
use_aggregator: bool,
**kwargs: Any,
) -> GatewayBundle:
...
示例:
from akquant import DataFeed
from akquant.gateway import create_gateway_bundle, register_broker
register_broker("demo", demo_builder)
bundle = create_gateway_bundle(
broker="demo",
feed=DataFeed(),
symbols=["000001.SZ"],
)
行情源与交易源分开指定 {: #mixed-market-trader-broker }
GatewayBundle 的 market_gateway 与 trader_gateway 是两个独立可选字段,因此
一个 broker 可以只提供其中一侧:replay 只有行情(trader_gateway=None,不能
下单),而某些券商/柜台插件只有交易通道(market_gateway=None,收不到行情)。
create_gateway_bundle 与 run_live 支持把两侧分开指定:
两种模式,二选一:
- 单 broker:只传
broker,由它同时提供行情与交易两侧(原语义,不变)。 - 分开指定:同时传
market_broker与trader_broker,各供一侧;此时broker完全不参与构建。
run_live(
strategy_cls=MyStrategy,
instruments=instruments,
market_broker="replay", # 行情源
trader_broker="demo", # 交易源
trading_mode="paper",
gateway_options={"bars": bars},
)
只传其中一个会报错,要求把另一侧也写明。这是刻意的设计:如果让 broker 去
兼任缺失的那一侧,它就一词双义了——读 broker='qmf', market_broker='replay' 时,
你必须先知道「qmf 只有交易通道」才能推断出 broker 在这里指交易源,而参数名本身
没有表达这件事。两侧都写明则无需这层推断。
要点:
gateway_options会同时传给两个 builder,两侧所需参数放在同一个 dict 里即可。- 两侧同名时只构建一次(builder 可能连柜台、起线程,构建两次有副作用)。
metadata会记录market_broker/trader_broker便于排障;行情侧声明的 会话级信息(如replay的bounded_event_total)不会因分开指定而丢失。- 未注册的名字会报错并点名具体参数(
market_broker must be one of: ...), 而不是静默缺失某一侧通道。
4. 交易对象 (Trading Objects)
akquant.Order
id: 订单 ID。symbol: 标的代码。side:OrderSide.Buy/OrderSide.Sell。order_type:OrderType.Market/OrderType.Limit/StopMarket等。status:OrderStatus.New/Filled/Cancelled等。quantity/filled_quantity: 委托/成交数量。price: 委托价格。average_filled_price: 成交均价。trigger_price: 触发价格。time_in_force: 有效期 (GTC,IOC,FOK,Day)。created_at/updated_at: 时间戳。tag: 标签。reject_reason: 拒绝原因。
akquant.Trade
单次成交记录(一个订单可能对应多次成交)。
id: 成交 ID。order_id: 对应订单 ID。symbol: 标的代码。side: 方向。quantity: 成交数量。price: 成交价格。commission: 手续费。timestamp: 成交时间。
akquant.ClosedTrade
已平仓交易记录(开仓+平仓的完整周期)。
entry_time/exit_time: 开/平仓时间。entry_price/exit_price: 开/平仓价格。quantity: 数量。pnl: 盈亏金额。return_pct: 收益率。duration: 持仓时间。mae/mfe: 最大不利/有利变动。
5. 投资组合与风控 (Portfolio & Risk)
akquant.RiskConfig
风控配置。
@dataclass
class RiskConfig:
active: bool = True
check_cash: bool = True
safety_margin: float = 0.0001
max_order_size: Optional[float] = None
max_order_value: Optional[float] = None
max_position_size: Optional[float] = None
restricted_list: Optional[List[str]] = None
max_position_pct: Optional[float] = None
sector_concentration: Optional[Union[float, tuple]] = None
max_account_drawdown: Optional[float] = None
max_daily_loss: Optional[float] = None
stop_loss_threshold: Optional[float] = None
account_mode: str = "cash"
enable_short_sell: bool = False
initial_margin_ratio: float = 1.0
maintenance_margin_ratio: float = 0.3
financing_rate_annual: float = 0.08
borrow_rate_annual: float = 0.10
allow_force_liquidation: bool = True
liquidation_priority: str = "short_first"
账户级字段说明:
max_account_drawdown: 最大回撤阈值(0~1 小数)。以历史权益峰值为基准,当前权益回撤超过阈值后,新的下单请求会被拒绝。max_daily_loss: 单日亏损阈值(0~1 小数)。以当日首次风控检查时的权益为基准,当日亏损超过阈值后,新的下单请求会被拒绝。- `stop_loss_threshold$: 账户净值止损阈值(0~1 小数)。当当前权益低于“规则首次生效时权益 \times 阈值”后,新的下单请求会被拒绝。
这些拒单原因会体现在 $orders_df.reject_reason` 字段中。
6. 结果分析 (Analysis)
akquant.BacktestResult
回测结果对象。
属性:
metrics_df: 绩效指标表格 (Sharpe, Drawdown 等)。其中交易相关主字段包括closed_trade_count、execution_count、open_position_count。trades_df: 所有平仓交易记录表格。orders_df: 所有委托记录表格。含position_effect(开平语义)、reduce_only、created_at_iso/updated_at_iso(UTC ISO 串)。executions_df: 所有成交流水表格(优先使用 Rust IPC/dict 快速导出)。含position_effect与timestamp_iso。
!!! tip "开平语义(position_effect)"
取值为 auto / open / close / close_today / close_yesterday,与下单
入参同一套词表,可直接用于筛选(如 df[df.position_effect == "close_today"])。
`buy()` / `sell()` 在默认的 `position_effect="auto"` 下会自动拆开平腿:反手
时先出 `close` 腿再出 `open` 腿。这两列就是查看拆腿结果的地方——委托表在
下单时即可见,成交表在成交后可见。
positions_df: 每日持仓详情。equity_curve: 权益曲线 (List[Tuple[timestamp, value]])。cash_curve: 现金曲线 (List[Tuple[timestamp, value]])。margin_curve: 保证金曲线 (List[Tuple[timestamp, value]])。equity_curve_daily: 日频权益曲线(按日末值聚合)。cash_curve_daily: 日频现金曲线(按日末值聚合)。margin_curve_daily: 日频保证金曲线(按日末值聚合)。trades:ClosedTrade对象列表。executions:Trade对象列表 (所有成交流水)。snapshots: 每日PositionSnapshot列表。
分析方法:
exposure_df(freq="D"): 组合暴露分解(净暴露、总暴露、杠杆)。attribution_df(by="symbol", use_net=True, top_n=None): 按 symbol/tag 做归因汇总。capacity_df(freq="D"): 容量代理指标(订单数、成交率、换手)。benchmark_analysis(benchmark=None, curve_freq="raw"): 返回结构化 benchmark analysis,可直接供前端/API 使用。export_benchmark_analysis(path, benchmark=None, format="json", curve_freq="raw"): 将 benchmark analysis 导出为 JSON 或 parquet 产物。top_reject_reason_types(top_n=10): 按拒单类型聚合拒单统计,并附带一条示例明细。orders_by_strategy(): 按owner_strategy_id聚合订单统计。executions_by_strategy(): 按owner_strategy_id聚合成交流水统计。get_event_stats(): 返回流式事件统计摘要(如processed_events、dropped_event_count、callback_error_count、backpressure_policy、stream_mode)。report(..., curve_freq="D" | "raw"): 生成 HTML 报告时,默认使用日频末值曲线,也可切回原始频率。
orders_by_strategy = result.orders_by_strategy()
executions_by_strategy = result.executions_by_strategy()
benchmark_analysis = result.benchmark_analysis(
benchmark=benchmark_returns,
curve_freq="D",
)
# benchmark_analysis 常用字段:
# - schema_version, available, reason
# - benchmark.label
# - summary.total_excess / annual_excess / tracking_error
# - summary.information_ratio / beta / alpha
# - series[*].date / strategy_return / benchmark_return / excess_return
# - series[*].strategy_cum_return / benchmark_cum_return / excess_cum_return
# 常用字段示例
# orders_by_strategy:
# - owner_strategy_id, order_count, filled_order_count,
# ordered_quantity, filled_quantity, ordered_value, filled_value,
# fill_rate_qty, fill_rate_value
#
# executions_by_strategy:
# - owner_strategy_id, execution_count, total_quantity,
# total_notional, total_commission, avg_fill_price
event_stats = result.get_event_stats()
# 常见字段:
# - processed_events, dropped_event_count, callback_error_count,
# backpressure_policy, stream_mode, reason
7. 数据输入与向量化 (Data I/O & Vectorized Compute)
7.1 run_backtest 的数据输入类型
run_backtest(data=...) 接受多种输入,内部统一归一化后进入引擎:
pandas.DataFrame/Dict[str, pandas.DataFrame]polars.DataFrame/polars.LazyFrame/pyarrow.Table(一等输入,内部零成本转 pandas 路径)List[Bar]DataFeed(含流式DataFeed.from_parquet,见 7.3)/DataFeedAdapter
7.2 akquant.write_canonical_parquet
def write_canonical_parquet(source, path, *, symbol=None) -> Path: ...
将任意来源(pandas / polars / pyarrow / 路径 / List[Bar])规范化并写出可流式(out-of-core)读取的 Parquet:列 timestamp(int64 纳秒 UTC)+ open/high/low/close/volume(float64)+ symbol(str),按 timestamp 升序、zstd 压缩。产物可由 DataFeed.from_parquet 有界内存流式读取。
7.3 akquant.DataFeed.from_parquet
@staticmethod
def from_parquet(path, symbol=None, chunk_size=None) -> DataFeed: ...
从规范 Parquet 创建有界内存(out-of-core)流式数据源:数据按 chunk_size 行(默认 65536)分块从磁盘读取,回测峰值内存与数据总量无关。要求 Parquet 按 timestamp 升序;含 symbol 列即支持多标的。详见「数据准备与加载指南 · 2.6」。
7.4 向量化列计算 akquant.vec_*
在 numpy 数组上零拷贝、向量化的批量列计算原语(与逐点增量指标互补,适合整列一次性求值):
| 函数 | 说明 |
|---|---|
vec_sma(values, period) | 简单移动平均 |
vec_ema(values, period) | 指数移动平均 |
vec_wma(values, period) | 加权移动平均 |
vec_rolling_sum/min/max(values, period) | 滚动求和 / 最小 / 最大 |
vec_rolling_std(values, period) | 滚动样本标准差(ddof=1) |
vec_zscore(values, period) | 滚动 z-score |
vec_returns(values) / vec_log_returns(values) | 简单 / 对数收益率 |
vec_cumsum(values) | 累积求和 |
语义与 pandas 对齐(NaN 位置一致、rolling_std 为样本标准差)。
import numpy as np
import akquant as aq
close = np.array([10.0, 11.0, 12.0, 11.0, 13.0])
ma = aq.vec_sma(close, 3) # 前 period-1 个为 NaN
z = aq.vec_zscore(close, 3)