Skip to content

Commit

Permalink
fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
EricWang committed Feb 28, 2017
1 parent 7165d01 commit dcf8ddb
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 8 deletions.
Binary file added docs/source/_static/progress_bar.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 10 additions & 5 deletions docs/source/development/event_source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ RQAlpha 大部分的组件是以 :code:`add_listener` 的方式进行事件的
* 当订单成交,则会触发 :code:`EVENT.TRADE` 事件,那么系统的账户模块因为注册了该事件,就可以立即计算成交以后的收益和资金变化。
* 当订单下单,则会触发 :code:`EVENT.ORDER_PENDING_NEW` 事件,前端风控模块注册了该事件,则可以立即对该订单进行审核,如果不满足风控要求,则直接指定执行 :code:`order._cancel(some_reason)` 来保证有问题的订单不会进入实际下单环节。

程序化交易中很多需求,都可以以注册事件无缝插入到 RQAlpha 中的方式来满足和扩展
程序化交易中很多需求,都可以通过注册事件的方式无缝插入到 RQAlpha 中进行扩展

事件源分类
==================
Expand All @@ -23,7 +23,7 @@ RQAlpha 大部分的组件是以 :code:`add_listener` 的方式进行事件的
* POST_USER_INIT: 策略的 :code:`init` 函数执行后触发

* MarketEvent: 市场及数据事件源

* POST_UNIVERSE_CHANGED: 策略证券池发生变化后触发
* PRE_BEFORE_TRADING: 执行 :code:`before_trading` 函数前触发
* BEFORE_TRADING: 该事件会触发策略的 :code:`before_trading` 函数
Expand Down Expand Up @@ -57,11 +57,16 @@ RQAlpha 大部分的组件是以 :code:`add_listener` 的方式进行事件的
事件源的订阅及使用
==================

我们可以订阅我们需要的事件源,从而在该事件发生时实现我们的特定的需求。
我们可以订阅需要的事件源,从而在该事件发生时实现指定需求。

下面以最简单的 Mod - ProgressMod 为例,介绍事件源的订阅和使用。

ProgressMod 需要实现的需求非常的简单:在命令行输出目前回测的进度条。

.. image:: ../_static/progress_bar.png

下面以最简单的 Mod - ProgressMod 为例,介绍以下事件源的订阅和使用。 ProgressMod 需要实现的需求非常的简单:在命令行输出目前回测的进度条。

首先我们定义一个 ProgressMod 类,继承与接口类 :class:`~AbstractMod`
首先定义一个 ProgressMod 类,继承与接口类 :class:`~AbstractMod`

.. code-block:: python3
Expand Down
4 changes: 2 additions & 2 deletions docs/source/intro/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ RQAlpha 的 API 主要分为三类:约定函数、数据查询和交易接口
# after_trading函数会在每天交易结束后被调用,当天只会被调用一次
def after_trading(context):
logger.info("开盘前执行after_trading函数")
logger.info("收盘后执行after_trading函数")
至此,我们写出了一个“完整”的策略,但是该策略实际上什么也没有做。

Expand All @@ -113,7 +113,7 @@ RQAlpha 的 API 主要分为三类:约定函数、数据查询和交易接口
* :func:`is_suspended` : 判断某股票当天是否停牌
* :func:`is_st_stock` : 判断某股票是否为 \*st

Ricequant 金融、财务、合约历史数据等数据接口,详情请查看 :ref:`api-extend-api`
Ricequant 金融、财务、合约历史数据等数据接口请查看 :ref:`api-extend-api`

* bar_dict: 在 :func:`handle_bar` 中我们可以使用 `bar_dict` 来获取相应的 :class:`Bar` 数据,`bar_dict` 是一个字典类型变量,直接通过传 `key` 的方式就可以获取到对应的 :class:`Bar` 数据。

Expand Down
2 changes: 1 addition & 1 deletion rqalpha/examples/buy_and_hold.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ def init(context):
context.fired = False


def before_trading(context, bar_dict):
def before_trading(context):
pass


Expand Down

0 comments on commit dcf8ddb

Please sign in to comment.