Merge branch 'feature_license_conf' into 'dev'

multi license conf

See merge request server/openapi/openapi-python-sdk!133

Author: tigersk

CHANGELOG.md

@@ -1,3 +1,12 @@
+## 2.1.9 (2022-10-12)
+### New
+- 支持多牌照配置, 分牌照请求不同域名. 可通过 client_config.license 指定牌照
+### Modify
+- `Contract` 新增属性 `short_initial_margin`, `short_maintenance_margin`, 新增方法 `to_str()` 可打印全部属性
+- `QuoteClient.get_financial_report` 增加参数 `begin_date`, `end_date`
+- `QuoteClient.get_trade_ticks` 兼容 1.0 版本接口
+
+
 ## 2.1.8 (2022-08-26)
 ### Modify
 - `TradeClient.get_orders` 新增参数 `seg_type`， 可指定交易品种(证券SEC/期货FUT/全部ALL)  

setup.py

@@ -34,5 +34,6 @@
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
     ],
 )

tests/test_client_config.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+# 
+# @Date    : 2022/10/8
+# @Author  : sukai
+import unittest
+from unittest.mock import MagicMock
+
+from tigeropen.common.consts import License
+from tigeropen.tiger_open_config import TigerOpenClientConfig, GATEWAY_SUFFIX
+
+
+class TestClientConfig(unittest.TestCase):
+
+    def test_refresh_server_info(self):
+        domain_map = {
+            'socket_port': 9883,
+            'port': 9887,
+            'TBSG-QUOTE': 'https://openapi.tigerfintech.com/sgp-quote',
+            'TBNZ-QUOTE': 'https://openapi.tigerfintech.com/hkg-quote',
+            'TBSG-PAPER': 'https://openapi-sandbox.tigerfintech.com/sgp',
+            'TBNZ-PAPER': 'https://openapi-sandbox.tigerfintech.com/hkg',
+            'TBSG': 'https://openapi.tigerfintech.com/sgp',
+            'TBNZ': 'https://openapi.tigerfintech.com/hkg',
+            'COMMON': 'https://openapi.tigerfintech.com',
+        }
+        config = TigerOpenClientConfig()
+        config.query_domains = MagicMock(name='query_domains', return_value=domain_map)
+        config.domain_conf = config.query_domains()
+
+        self.assertEqual('https://openapi.tigerfintech.com' + GATEWAY_SUFFIX, config.server_url)
+        self.assertEqual(('ssl', 'openapi.tigerfintech.com', 9883), config.socket_host_port)
+
+        config.license = License.TBNZ
+        config.refresh_server_info()
+        self.assertEqual('https://openapi.tigerfintech.com/hkg' + GATEWAY_SUFFIX, config.server_url)
+        self.assertEqual('https://openapi.tigerfintech.com/hkg-quote' + GATEWAY_SUFFIX, config.quote_server_url)
+
+        config.license = 'TBSG'
+        config.refresh_server_info()
+        self.assertEqual('https://openapi.tigerfintech.com/sgp' + GATEWAY_SUFFIX, config.server_url)
+        self.assertEqual('https://openapi.tigerfintech.com/sgp-quote' + GATEWAY_SUFFIX, config.quote_server_url)
+
+        config.is_paper = True
+        config.license = 'TBNZ'
+        config.refresh_server_info()
+        self.assertEqual('https://openapi-sandbox.tigerfintech.com/hkg' + GATEWAY_SUFFIX, config.server_url)
+        self.assertEqual('https://openapi.tigerfintech.com/hkg-quote' + GATEWAY_SUFFIX, config.quote_server_url)
+
+        config = TigerOpenClientConfig(enable_dynamic_domain=False)
+        config.query_domains = MagicMock(name='query_domains', return_value=domain_map)
+        config.domain_conf = config.query_domains()
+        config.license = 'TBNZ'
+        config.refresh_server_info()
+        self.assertEqual('https://openapi.tigerfintech.com' + GATEWAY_SUFFIX, config.server_url)
+        self.assertEqual(('ssl', 'openapi.tigerfintech.com', 9883), config.socket_host_port)

tigeropen/common/consts/__init__.py

@@ -169,3 +169,17 @@ class OrderType(Enum):
     STP = 'STP'  # 止损单
     STP_LMT = 'STP_LMT'  # 止损限价单
     TRAIL = 'TRAIL'  # 跟踪止损单
+
+
+@unique
+class License(Enum):
+    TBNZ = 'TBNZ'
+    TBSG = 'TBSG'
+
+
+@unique
+class ServiceType(Enum):
+    COMMON = 'COMMON'
+    TRADE = 'TRADE'
+    QUOTE = 'QUOTE'
+

tigeropen/common/consts/service_types.py

@@ -25,6 +25,8 @@
 ORDER_TRANSACTIONS = "order_transactions"  # 订单成交记录
 ANALYTICS_ASSET = "analytics_asset"
 
+USER_LICENSE = "user_license"
+
 """
 合约
 """

tigeropen/common/util/account_util.py

@@ -0,0 +1,17 @@
+import re
+
+PAPER_ACCOUNT_DIGIT_LEN = 17
+
+
+class AccountUtil:
+
+    @staticmethod
+    def is_paper_account(account):
+        try:
+            if account:
+                account = str(account)
+                return account.isdigit() and len(account) >= PAPER_ACCOUNT_DIGIT_LEN
+        except:
+            pass
+        return False
+

tigeropen/quote/quote_client.py

@@ -76,7 +76,9 @@ def __init__(self, client_config, logger=None, is_grab_permission=True):
         super(QuoteClient, self).__init__(client_config, logger=self.logger)
         self._lang = LANGUAGE
         self._timezone = eastern
+        self._url = None
         if client_config:
+            self._url = client_config.quote_server_url
             self._lang = client_config.language
             if client_config.timezone:
                 self._timezone = client_config.timezone
@@ -87,7 +89,7 @@ def __init__(self, client_config, logger=None, is_grab_permission=True):
 
     def __fetch_data(self, request):
         try:
-            response = super(QuoteClient, self).execute(request)
+            response = super(QuoteClient, self).execute(request, url=self._url)
             return response
         except Exception as e:
             if hasattr(THREAD_LOCAL, 'logger') and THREAD_LOCAL.logger:

tigeropen/tiger_open_client.py

@@ -12,7 +12,10 @@
 from tigeropen.common.consts import OPEN_API_SERVICE_VERSION, THREAD_LOCAL
 from tigeropen.common.consts.params import P_TIMESTAMP, P_TIGER_ID, P_METHOD, P_CHARSET, P_VERSION, P_SIGN_TYPE, \
     P_DEVICE_ID, P_NOTIFY_URL, COMMON_PARAM_KEYS, P_SIGN
+from tigeropen.common.consts.service_types import USER_LICENSE
 from tigeropen.common.exceptions import ResponseException, RequestException
+from tigeropen.common.request import OpenApiRequest
+from tigeropen.common.response import TigerResponse
 from tigeropen.common.util.common_utils import has_value
 from tigeropen.common.util.signature_utils import get_sign_content, sign_with_rsa, verify_with_rsa
 from tigeropen.common.util.web_utils import do_post
@@ -40,6 +43,16 @@ def __init__(self, client_config, logger=None):
             "User-Agent": 'openapi-python-sdk-' + __VERSION__
         }
         self.__device_id = self.__get_device_id()
+        self.__init_license()
+        self.__refresh_server_info()
+
+    def __init_license(self):
+        if self.__config.license is None and self.__config.enable_dynamic_domain:
+            self.__config.license = self.query_license()
+
+    def __refresh_server_info(self):
+        self.__config.refresh_server_info()
+
 
     """
     内部方法，从params中抽取公共参数
@@ -82,7 +95,7 @@ def __remove_common_params(self, params):
     """
     内部方法，通过请求request对象构造请求查询字符串和业务参数
     """
-    def __prepare_request(self, request):
+    def __prepare_request(self, request, url=None):
         THREAD_LOCAL.logger = self.__logger
         params = request.get_params()
         params[P_TIMESTAMP] = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
@@ -97,7 +110,7 @@ def __prepare_request(self, request):
             raise RequestException('[' + THREAD_LOCAL.uuid + ']request sign failed. ' + str(e))
         all_params[P_SIGN] = sign
 
-        log_url = self.__config.server_url + '?' + sign_content + "&sign=" + sign
+        log_url = url + '?' + sign_content + "&sign=" + sign
         if THREAD_LOCAL.logger:
             THREAD_LOCAL.logger.debug('[' + THREAD_LOCAL.uuid + ']request:' + log_url)
 
@@ -134,12 +147,29 @@ def __parse_response(self, response_str, timestamp=None):
     执行接口请求
     """
 
-    def execute(self, request):
+    def execute(self, request, url=None):
+        if url is None:
+            url = self.__config.server_url
         THREAD_LOCAL.uuid = str(uuid.uuid1())
         query_string = None
-        params = self.__prepare_request(request)
+        params = self.__prepare_request(request, url)
 
-        response = do_post(self.__config.server_url, query_string, self.__headers, params, self.__config.timeout,
+        response = do_post(url, query_string, self.__headers, params, self.__config.timeout,
                            self.__config.charset)
 
         return self.__parse_response(response, params.get('timestamp'))
+
+    def query_license(self):
+        request = OpenApiRequest(method=USER_LICENSE)
+
+        response_content = None
+        try:
+            response_content = self.execute(request)
+        except Exception as e:
+            self.__logger.error(e, exc_info=True)
+        if response_content:
+            response = TigerResponse()
+            response.parse_response_content(response_content)
+            if response.is_success():
+                return json.loads(response.data).get('license')
+        self.__logger.error(f"failed to query license, response: {response_content}")