Migrate RiceQuant integration code to new framework

Author: sinall

README.rst

@@ -194,6 +194,7 @@ Mac/Linux
 - 修改策略代码，可参考如下示例：
 
   - examples/ricequant/simple\_strategy.py - 基本用法
+  - examples/ricequant/advanced\_strategy.py - 高级同步用法（非侵入式设计，推荐）
   - examples/ricequant/new\_stocks\_purchase.py - 新股申购
   - examples/ricequant/repo.py - 逆回购
 

config/online-quant/research/shipane_sdk_config_template.yaml

@@ -134,6 +134,7 @@ managers:
                 # 工作模式
                 # 1. SYNC：  指按模拟交易的持仓进行同步
                 # 2. FOLLOW：指按模拟交易的下单进行跟单
+                # 目前米筐只支持 SYNC 模式
                 mode: SYNC
                 # 同步选项
                 # 如果该策略无需同步操作，可以省略 sync 配置项

examples/ricequant/advanced_strategy.py

@@ -0,0 +1,19 @@
+import shipane_sdk
+
+
+def init(context):
+    context.s1 = "000001.XSHE"
+
+def before_trading(context):
+    # 创建 RiceQuantStrategyManagerFactory 对象
+    # 参数为 shipane_sdk_config_template.yaml 中配置的 manager id
+    context.__manager = shipane_sdk.RiceQuantStrategyManagerFactory(context).create('manager-1')
+
+def handle_bar(context, bar_dict):
+    try:
+        order_target_value(context.s1, 0)
+        order_target_value(context.s1, 500)
+    finally:
+        # 放在 finally 块中，以防原有代码抛出异常或者 return
+        # 在函数结尾处加入以下语句，用来将模拟盘同步至实盘
+        g.__manager.work()

examples/ricequant/new_stocks_purchase.py

@@ -12,19 +12,13 @@ def init(context):
 
 
 def before_trading(context):
-    # 创建 RiceQuantExecutor 对象
-    # 可选参数包括：host, port, key, client, timeout 等
-    # 请将下面的 IP 替换为实际 IP
-    context.__executor = shipane_sdk.RiceQuantExecutor(
-        host='xxx.xxx.xxx.xxx',
-        port=8888,
-        key='',
-        client=''
-    )
+    # 创建 RiceQuantStrategyManagerFactory 对象
+    # 参数为 shipane_sdk_config_template.yaml 中配置的 manager id
+    context.__manager = shipane_sdk.RiceQuantStrategyManagerFactory(context).create('manager-1')
 
 
 def purchase_new_stocks(context, bar_dict):
     if context.run_info.run_type == RUN_TYPE.PAPER_TRADING:
-        context.__executor.purchase_new_stocks()
+        context.__manager.purchase_new_stocks()
     else:
         logger.info('回测中不进行新股申购')

examples/ricequant/repo.py

@@ -12,15 +12,9 @@ def initialize(context):
 
 
 def process_initialize(context):
-    # 创建 RiceQuantExecutor 对象
-    # 可选参数包括：host, port, key, client, timeout 等
-    # 请将下面的 IP 替换为实际 IP
-    g.__executor = shipane_sdk.RiceQuantExecutor(
-        host='xxx.xxx.xxx.xxx',
-        port=8888,
-        key='',
-        client=''
-    )
+    # 创建 RiceQuantStrategyManagerFactory 对象
+    # 参数为 shipane_sdk_config_template.yaml 中配置的 manager id
+    g.__manager = shipane_sdk.RiceQuantStrategyManagerFactory(context).create('manager-1')
 
 
 def repo(context):
@@ -34,6 +28,6 @@ def repo(context):
             'price': float(quote_df['bid'][0]),
             'amountProportion': 'ALL'
         }
-        g.__executor.client.execute(**order)
+        g.__manager.execute(**order)
     else:
         log.info('回测中不进行逆回购')

examples/ricequant/simple_strategy.py

@@ -1,41 +1,22 @@
-# 可以自己import我们平台支持的第三方python模块，比如pandas、numpy等。
 import shipane_sdk
 
 
-# 在这个方法中编写任何的初始化逻辑。context对象将会在你的算法策略的任何方法之间做传递。
 def init(context):
     context.s1 = "000001.XSHE"
-    # 实时打印日志
-    logger.info("Interested at stock: " + str(context.s1))
 
 def before_trading(context):
-    # 创建 RiceQuantExecutor 对象
-    # 可选参数包括：host, port, key, client, timeout 等
-    # 请将下面的 IP 替换为实际 IP
-    context.__executor = shipane_sdk.RiceQuantExecutor(
-        host='xxx.xxx.xxx.xxx',
-        port=8888,
-        key='',
-        client=''
-    )
+    # 创建 RiceQuantStrategyManagerFactory 对象
+    # 参数为 shipane_sdk_config_template.yaml 中配置的 manager id
+    context.__manager = shipane_sdk.RiceQuantStrategyManagerFactory(context).create('manager-1')
 
-# 你选择的证券的数据更新将会触发此段逻辑，例如日或分钟历史数据切片或者是实时数据切片更新
 def handle_bar(context, bar_dict):
-    # 开始编写你的主要的算法逻辑
+    # 保存 order
+    order_ = order_shares(context.s1, 100)
+    # 实盘易依据 order_ 下单
+    context.__manager.execute(order_)
 
-    # bar_dict[order_book_id] 可以拿到某个证券的bar信息
-    # context.portfolio 可以拿到现在的投资组合状态信息
+    order_ = order_shares(context.s1, -100)
+    context.__manager.execute(order_)
 
-    # 使用order_shares(id_or_ins, amount)方法进行落单
-
-    # TODO: 开始编写你的算法吧！
-    # 保存 order_id
-    order_id = order_shares(context.s1, 100)
-    # 实盘易依据 order_id 下单
-    context.__executor.execute(order_id)
-
-    order_id = order_shares(context.s1, -100)
-    context.__executor.execute(order_id)
-
-    cancel_order(order_id)
-    context.__executor.cancel(order_id)
+    cancel_order(order_)
+    context.__manager.cancel(order_)

shipane_sdk/base_manager.py

@@ -13,7 +13,7 @@ def __init__(self):
 
     def create(self, id):
         traders = self._create_traders(id)
-        return StrategyManager(id, self._create_logger(), self._config, traders)
+        return StrategyManager(id, self._create_logger(), self._config, traders, self._get_context())
 
     def _get_context(self):
         pass
@@ -60,6 +60,9 @@ def is_sim_trade(self):
     def is_backtest(self):
         pass
 
+    def is_read_file_allowed(self):
+        return False
+
 
 class BaseLogger(object):
     def debug(self, msg, *args, **kwargs):
@@ -81,11 +84,12 @@ def exception(self, msg, *args, **kwargs):
 class StrategyManager(object):
     THEMATIC_BREAK = '-' * 50
 
-    def __init__(self, id, logger, config, traders):
+    def __init__(self, id, logger, config, traders, strategy_context):
         self._id = id
         self._logger = logger
         self._config = config
         self._traders = traders
+        self._strategy_context = strategy_context
 
     @property
     def id(self):
@@ -130,6 +134,8 @@ def work(self):
         self._logger.info(self.THEMATIC_BREAK)
 
     def _refresh(self):
+        if not self._strategy_context.is_read_file_allowed():
+            return
         self._config.reload()
         trader_configs = self._config.build_trader_configs(self._id)
         for id, trader in self._traders.items():
@@ -270,7 +276,7 @@ def _execute(self, order):
         if not self._should_run():
             self._logger.info("[%s] %s", self.id, order)
             return None
-        actual_order =  self._do_execute(order)
+        actual_order = self._do_execute(order)
         return actual_order
 
     def _cancel(self, order):
@@ -388,7 +394,7 @@ def data(self):
 
     def reload(self):
         content = self._strategy_context.read_file('shipane_sdk_config.yaml')
-        stream = six.StringIO(content)
+        stream = six.BytesIO(content)
         self._data = yaml.load(stream, Loader=OrderedDictYAMLLoader)
         self._proxies = self._create_proxy_configs()
         stream.close()

shipane_sdk/joinquant/manager.py

@@ -86,6 +86,9 @@ def is_sim_trade(self):
     def is_backtest(self):
         return not self.is_sim_trade()
 
+    def is_read_file_allowed(self):
+        return True
+
     @staticmethod
     def _convert_position(quant_position):
         position = Position()