入口函数

run_func - 传入约定函数运行回测

rqalpha.run_func(**kwargs)

传入约定函数和策略配置运行回测。约定函数详见 API 手册约定函数部分,可用的配置项详见参数配置部分。

Keyword Arguments
  • config (dict) -- 策略配置字典

  • init (Callable[[StrategyContext], Any]) -- 策略初始化函数,会在策略开始运行时被调用,仅会执行一次

  • before_trading (Callable[[StrategyContext], Any]) -- 盘前函数,会在每日盘前被调用一次

  • open_auction (Callable[[StrategyContext, dict[str, BarObject]], Any]) -- 集合竞价函数,会在每日盘前集合竞价阶段被调用一次

  • handle_bar (Callable[[StrategyContext, dict[str, BarObject]], Any]) -- k 线处理函数,会在盘中 k 线发生更新时被调用,适用于日/分钟级别回测

  • handle_tick (Callable[[StrategyContext, TickObject], Any]) -- 快照数据处理函数,会在每个 tick 到达时被调用,适用于 tick 回测

  • after_trading (Callable[[StrategyContext], Any]) -- 盘后函数,会在每日交易结束后被调用一次

Returns

dict

Example

config = {
    "base": {
        ...
    }
}

def init(context):
    ...

def handle_bar(context, bar_dict):
    ...

run_func(config=config, init=init, handle_bar=handle_bar)

run_file - 传入代码文件运行回测

rqalpha.run_file(strategy_file_path, config=None)

传入策略文件路径运行回测。

Parameters
  • strategy_file_path (str) -- 策略文件路径

  • config (Optional[dict]) -- 策略配置项字典,默认为空,此处传入的配置项优先级高于策略内 __config__ 中的配置项

Example

config = {
    "base": {
        ...
    }
}

run_file("strategy.py", config=config)
Return type

dict

run_code - 传入代码字符串运行回测

rqalpha.run_code(code, config=None)

传入字符串形式的策略代码以运行回测。

Parameters
  • code (str) -- 策略代码字符串

  • config (Optional[dict]) -- 策略配置项字典,默认为空,此处传入的配置项优先级高于策略内 __config__ 中的配置项

Example

config = {
    "base": {
        ...
    }
}

CODE = """
def init(context):
    ...

def handle_bar(context, bar_dict):
    ...
"""

run_code(CODE, config=config)
Return type

dict