核心模块 API¶
以下 API 文档由源码自动生成,内容始终与代码保持同步。
qka.Data¶
数据管理类
负责股票数据的获取、缓存和管理,支持多数据源、并发下载和自定义因子计算。
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
symbols |
List[str]
|
股票代码列表 |
period |
str
|
数据周期,如 '1d'、'1m' 等 |
adjust |
str
|
复权方式,如 'qfq'、'hfq'、'bfq' |
factor |
Callable
|
因子计算函数 |
source |
str
|
数据源,如 'akshare'、'qmt' |
pool_size |
int
|
并发下载线程数 |
datadir |
Path
|
数据缓存目录 |
target_dir |
Path
|
目标存储目录 |
源代码位于: qka/core/data.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 | |
__init__(symbols=None, period='1d', adjust='qfq', factor=lambda df: df, source='akshare', pool_size=10, datadir=None)
¶
初始化数据对象
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
symbols
|
Optional[List[str]]
|
股票代码列表,如 ['000001.SZ', '600000.SH'] |
None
|
period
|
str
|
数据周期,如 '1d'(日线)、'1m'(分钟) |
'1d'
|
adjust
|
str
|
复权方式,'qfq'(前复权)、'hfq'(后复权)、'bfq'(不复权) |
'qfq'
|
factor
|
Callable[[DataFrame], DataFrame]
|
因子计算函数,接收 DataFrame 返回 DataFrame,用于扩展自定义因子 |
lambda df: df
|
source
|
str
|
数据来源,'akshare'(默认)或 'qmt' |
'akshare'
|
pool_size
|
int
|
并发下载线程数 |
10
|
datadir
|
Optional[Path]
|
缓存根目录,默认为当前工作目录下的 datadir/ |
None
|
源代码位于: qka/core/data.py
get()
¶
获取历史数据
并发下载所有股票数据,应用因子计算,并返回合并后的Dask DataFrame。
返回:
| 类型 | 描述 |
|---|---|
DataFrame
|
dd.DataFrame: 合并后的股票数据,每只股票的列名格式为 {symbol}_{column} 如果没有股票,返回空的 Dask DataFrame |
源代码位于: qka/core/data.py
qka.Backtest¶
QKA回测引擎类
提供基于时间序列的回测功能,支持多股票横截面数据处理, 以及绩效指标计算和可视化。
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
data |
Data
|
数据对象实例 |
strategy |
Strategy
|
策略对象实例 |
results |
DataFrame
|
回测结果数据 |
initial_cash |
float
|
初始资金 |
源代码位于: qka/core/backtest.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 | |
__init__(data, strategy)
¶
run(benchmark=None)
¶
执行回测
遍历所有时间点,在每个时间点调用策略的on_bar方法进行交易决策, 并记录交易后的状态。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
benchmark
|
str
|
基准代码,如 '000300.SH'(沪深300)。 如果提供,会下载基准数据用于对比。 |
None
|
返回:
| 类型 | 描述 |
|---|---|
|
None。回测结果保存在 self.results 中,可通过 |
|
|
self.summary() 查看绩效指标,self.report() 生成报告。 |
源代码位于: qka/core/backtest.py
summary()
¶
计算并打印回测绩效指标
返回包含以下指标的字典: - 总收益率、年化收益率、年化波动率 - 夏普比率、最大回撤、Calmar比率 - 胜率、盈亏比、交易次数 - 最终资产、总手续费
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
dict |
dict
|
绩效指标字典 |
源代码位于: qka/core/backtest.py
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | |
report(title='未命名策略', output_path=None)
¶
生成自包含的 HTML 回测报告
包含绩效指标卡片、净值曲线、回撤曲线、月度收益率热力图、 交易明细表和回撤分析。可直接在浏览器中打开。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
title
|
str
|
策略名称(显示在报告标题中) |
'未命名策略'
|
output_path
|
Optional[str]
|
输出 HTML 文件路径。 None 则自动保存在 examples/charts/ 下 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
str |
str
|
HTML 文件路径 |
源代码位于: qka/core/backtest.py
qka.Strategy¶
Bases: ABC
策略抽象基类
所有自定义策略都应该继承此类,并实现on_bar方法。
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
broker |
Broker
|
交易经纪商实例,用于执行交易操作 |
源代码位于: qka/core/strategy.py
qka.Broker¶
虚拟交易经纪商类
管理资金、持仓和交易记录,提供买入卖出操作接口。 支持佣金、印花税、滑点等真实交易成本模拟。
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
cash |
float
|
可用现金 |
positions |
Dict
|
持仓记录 |
trade_history |
List
|
交易历史记录 |
commission_rate |
float
|
佣金费率 |
stamp_duty_rate |
float
|
印花税费率(仅卖出) |
slippage |
float
|
滑点比率 |
total_commission |
float
|
累计佣金 |
total_stamp_duty |
float
|
累计印花税 |
total_slippage_cost |
float
|
累计滑点成本 |
trades |
DataFrame
|
逐日状态记录 |
源代码位于: qka/core/broker.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 | |
__init__(initial_cash=100000.0, commission_rate=DEFAULT_COMMISSION_RATE, stamp_duty_rate=DEFAULT_STAMP_DUTY_RATE, slippage=DEFAULT_SLIPPAGE)
¶
初始化Broker
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
initial_cash
|
float
|
初始资金,默认10万元 |
100000.0
|
commission_rate
|
float
|
佣金费率,默认万2.5 |
DEFAULT_COMMISSION_RATE
|
stamp_duty_rate
|
float
|
印花税费率(仅卖出),默认万5 |
DEFAULT_STAMP_DUTY_RATE
|
slippage
|
float
|
滑点比率,默认0.1% |
DEFAULT_SLIPPAGE
|
源代码位于: qka/core/broker.py
on_bar(date, get)
¶
Bar结束时记录当前状态。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
date
|
当前时间戳 |
必需 | |
get
|
获取因子数据的函数 |
必需 |
源代码位于: qka/core/broker.py
buy(symbol, price, size)
¶
买入操作
考虑滑点(买入价上移)和佣金(最低 5 元)。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
symbol
|
str
|
交易标的代码 |
必需 |
price
|
float
|
市价 |
必需 |
size
|
int
|
买入数量 |
必需 |
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
bool |
bool
|
交易是否成功 |
源代码位于: qka/core/broker.py
sell(symbol, price, size)
¶
卖出操作
考虑滑点(卖出价下移)、佣金(最低 5 元)和印花税。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
symbol
|
str
|
交易标的代码 |
必需 |
price
|
float
|
市价 |
必需 |
size
|
int
|
卖出数量 |
必需 |
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
bool |
bool
|
交易是否成功 |
源代码位于: qka/core/broker.py
get(factor, timestamp=None)
¶
从trades DataFrame中获取数据
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
factor
|
str
|
列名,可选 'cash', 'value', 'total', 'positions', 'trades' |
必需 |
timestamp
|
时间戳,为None则使用当前时间戳 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
Any |
Any
|
对应列的数据,不存在则返回None |