核心模块 API¶
以下 API 文档由源码自动生成,内容始终与代码保持同步。
qka.Data¶
数据管理类
负责股票数据的获取、缓存和管理,支持多数据源、并发下载和自定义因子计算。
通过 indicators 参数统一处理技术指标和自定义因子,在数据加载时一次性预计算。
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
symbols |
List[str]
|
股票代码列表 |
period |
str
|
数据周期,如 '1d'、'1m' 等 |
adjust |
str
|
复权方式,如 'qfq'、'hfq'、'bfq' |
indicators |
dict | Callable
|
预计算指标/因子 |
source |
str
|
数据源,如 'baostock'(默认)、'akshare'、'qmt' |
pool_size |
int
|
并发下载线程数 |
datadir |
Path
|
数据缓存目录 |
target_dir |
Path
|
目标存储目录 |
源代码位于: qka/core/data.py
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 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 | |
__init__(symbols=None, period='1d', adjust='qfq', source='baostock', pool_size=10, datadir=None, indicators=None)
¶
初始化数据对象
参数:
源代码位于: qka/core/data.py
get(lazy=False)
¶
获取历史数据。
并发下载所有股票数据,应用因子计算,并返回合并后的数据。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
lazy
|
bool
|
是否以懒加载模式返回 dask DataFrame(支持大规模数据分区迭代)。 默认 False,返回 compute() 后的 pandas DataFrame(向后兼容)。 |
False
|
返回:
| 类型 | 描述 |
|---|---|
|
lazy=False: pd.DataFrame,列名格式 {symbol}|{factor} |
|
|
lazy=True: dd.DataFrame,列名格式 {symbol}|{factor} |
|
|
没有数据时抛出 RuntimeError |
源代码位于: qka/core/data.py
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 | |
qka.Backtest¶
QKA回测引擎类
提供基于时间序列的回测功能,支持多股票横截面数据处理, 以及绩效指标计算和可视化。
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
data |
Data
|
数据对象实例 |
strategy |
Strategy
|
策略对象实例 |
results |
DataFrame
|
回测结果数据 |
initial_cash |
float
|
初始资金 |
源代码位于: qka/core/backtest.py
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 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 | |
__init__(data, strategy)
¶
run(benchmark=None)
¶
执行回测
遍历所有时间点,在每个时间点调用策略的on_bar方法进行交易决策, 并记录交易后的状态。
大规模回测(>500 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
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 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 | |
report(title='未命名策略', output_path=None)
¶
生成自包含的 HTML 回测报告
包含绩效指标卡片、净值曲线、回撤曲线、月度收益率热力图、 交易明细表和回撤分析。可直接在浏览器中打开。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
title
|
str
|
策略名称(显示在报告标题中) |
'未命名策略'
|
output_path
|
Optional[str]
|
输出 HTML 文件路径。 None 则自动保存在 reports/ 目录下 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
str |
str
|
HTML 文件路径 |
源代码位于: qka/core/backtest.py
qka.Strategy¶
Bases: ABC
策略抽象基类
所有自定义策略都应该继承此类,并实现 on_bar 方法。
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
broker |
Broker
|
交易经纪商实例,用于执行交易操作 |
sizing |
SizingAccessor
|
仓位计算工具,提供 self.sizing.percent() 等方法 |
_data |
DataAccessor
|
数据访问器,提供 self.get() 和 self.history() 接口 |
源代码位于: qka/core/strategy.py
__init__(cash=100000.0)
¶
初始化策略
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
cash
|
float
|
初始资金,默认 10 万元 |
100000.0
|
get(factor)
¶
获取当前 bar 的横截面数据。
替代旧的 on_bar(date, get) 中的 get 参数。 仅当 on_bar 通过 self._data 注入数据后才能使用。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
factor
|
str
|
因子名,如 'close', 'volume' |
必需 |
返回:
| 类型 | 描述 |
|---|---|
|
pd.Series,index=股票代码,values=最新值 |
history(factor, window=20)
¶
获取因子的历史窗口数据。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
factor
|
str
|
因子名 |
必需 |
window
|
int
|
窗口大小 |
20
|
返回:
| 类型 | 描述 |
|---|---|
|
pd.DataFrame,行=日期,列=股票代码 |
on_bar(date)
abstractmethod
¶
每个 bar 的处理逻辑,必须由子类实现。
使用 self.get(factor) / self.history(factor, window) 获取数据。
--- 用法 ---
class MyStrategy(Strategy): def on_bar(self, date): # 横截面数据(当前 bar 所有股票) close = self.get('close')
# 历史序列(过去 N 天)
hist = self.history('close', 20)
# 仓位管理
size = self.sizing.percent(0.1, float(close['000001.SZ']))
# 交易操作
if not close.empty and '000001.SZ' in close.index:
price = float(close['000001.SZ'])
size = self.sizing.percent(0.1, price)
self.broker.buy('000001.SZ', price, size)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
date
|
当前日期(pd.Timestamp) |
必需 |
源代码位于: 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
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 | |
__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 |
源代码位于: qka/core/broker.py
qka.SizingAccessor¶
仓位计算工具
挂载在 Strategy.sizing 下,用于计算每次交易的股数。 自动获取 Broker 的资金信息(cash、positions、total_value)。
A 股最小交易单位 100 股,所有方法自动按手向下取整。
源代码位于: qka/core/sizing.py
11 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 | |
fixed_shares(n)
¶
固定股数。
如果 n 不足一手(100股),返回 0。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
n
|
int
|
股数 |
必需 |
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
int |
int
|
按手取整后的股数 |
fixed_amount(amount, price)
¶
固定金额。
计算 amount 能买多少股,向下按手取整。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
amount
|
float
|
投入金额 |
必需 |
price
|
float
|
每股价格 |
必需 |
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
int |
int
|
可买入股数(按手取整) |
源代码位于: qka/core/sizing.py
percent(ratio, price)
¶
资金百分比。
使用可用现金的 ratio 比例买入,按手取整。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
ratio
|
float
|
0~1 之间的比例,如 0.1 表示 10% |
必需 |
price
|
float
|
每股价格 |
必需 |
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
int |
int
|
可买入股数 |
源代码位于: qka/core/sizing.py
atr_risk(risk_ratio, price, atr_value, multiplier=2.0)
¶
ATR 风险仓位。
基于 ATR(平均真实波幅)计算仓位,确保单笔亏损不超过 risk_ratio 比例。
公式:股数 = (cash * risk_ratio) / (atr_value * multiplier)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
risk_ratio
|
float
|
0~1,单笔最大亏损占资金比例 |
必需 |
price
|
float
|
每股价格 |
必需 |
atr_value
|
float
|
ATR 当前值 |
必需 |
multiplier
|
float
|
止损倍数,默认 2(即止损位为入场价 ± 2 * ATR) |
2.0
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
int |
int
|
可买入股数 |
源代码位于: qka/core/sizing.py
kelly(win_rate, win_loss_ratio, price)
¶
凯利公式。
f* = (p * b - q) / b
其中: - p = 胜率 - b = 赔率(盈利/亏损) - q = 1 - p(败率)
当 f* ≤ 0 时返回 0(不建议下注)。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
win_rate
|
float
|
胜率,0~1 |
必需 |
win_loss_ratio
|
float
|
赔率(平均盈利 / 平均亏损) |
必需 |
price
|
float
|
每股价格 |
必需 |
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
int |
int
|
可买入股数 |