Merge branch 'main_merge_250801' into 'main'

feat: add method to set headers

See merge request webull/openapi-python-sdk!15

Author: 方佳

webull-python-sdk-core/webullsdkcore/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.14"
+__version__ = "0.1.15"
 
 import logging
 

webull-python-sdk-core/webullsdkcore/context/request_context_holder.py

@@ -0,0 +1,33 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# coding=utf-8
+
+import threading
+
+class RequestContextHolder:
+    _thread_local = threading.local()
+
+    @classmethod
+    def get(cls) -> dict:
+        # Initializes the headers dictionary for the current thread.
+        if not hasattr(cls._thread_local, 'headers'):
+            cls._thread_local.headers = {}
+        return cls._thread_local.headers
+
+    @classmethod
+    def clear(cls):
+        # Delete the current thread's headers field to prevent threads from reusing residual data.
+        if hasattr(cls._thread_local, 'headers'):
+            del cls._thread_local.headers

webull-python-sdk-demos/setup.py

@@ -15,8 +15,8 @@
     LONG_DESCRIPTION = fp.read()
 
 requires = [
-    "webull-python-sdk-mdata==0.1.14",
-    "webull-python-sdk-trade==0.1.14"
+    "webull-python-sdk-mdata==0.1.15",
+    "webull-python-sdk-trade==0.1.15"
 ]
 
 setup_args = {

webull-python-sdk-demos/tests/trade/request/test_order_operation.py

@@ -16,6 +16,7 @@
 import uuid
 
 from webullsdkcore.client import ApiClient
+from webullsdkmdata.common.category import Category
 
 from webullsdktrade.trade.order_operation import OrderOperation
 
@@ -44,7 +45,12 @@ def test_order_operation(self):
                 "extended_hours_trading": False,
             }
         }
-        res = order_operation.place_order(account_id, stock_order['stock_order'])
+
+        # This is an optional feature; you can still make a request without setting it.
+        custom_headers_map = {"category": Category.US_STOCK.name}
+        order_operation.add_custom_headers(custom_headers_map)
+        res = order_operation.place_order(account_id, **stock_order['stock_order'])
+        order_operation.remove_custom_headers()
         if res.status_code == 200:
             print('place order status:', res.json())
 

webull-python-sdk-demos/tests/trade/request/test_place_option.py

@@ -17,6 +17,7 @@
 
 from webullsdkcore.client import ApiClient
 from webullsdkcore.exception.exceptions import ServerException
+from webullsdkmdata.common.category import Category
 from webullsdktrade.request.v2.place_option_request import PlaceOptionRequest
 
 optional_api_endpoint = "<api_endpoint>"
@@ -61,12 +62,15 @@ def test_preview_order(self):
         request.set_endpoint(optional_api_endpoint)
         request.set_account_id(account_id)
         request.set_new_orders(new_orders)
-        request.set_custom_header(new_orders)
         post_body = request.get_body_params()
         print(json.dumps(post_body, indent=4))
         params = request.get_query_params()
         print(params)
 
+        # This is an optional feature; you can still make a request without setting it.
+        custom_headers_map = {"category": Category.US_OPTION.name}
+        request.add_custom_headers(custom_headers_map)
+
         try:
             response = api_client.get_response(request)
             print(response.json())

webull-python-sdk-demos/tests/trade/request/test_place_order.py

@@ -16,6 +16,7 @@
 
 from webullsdkcore.client import ApiClient
 from webullsdkcore.exception.exceptions import ServerException
+from webullsdkmdata.common.category import Category
 from webullsdktrade.request.palce_order_request import PlaceOrderRequest
 
 
@@ -59,6 +60,10 @@ def test_order(self):
         # request.set_trailing_type(stock_order['stock_order']['trailing_type'])
         # request.set_trailing_stop_step(stock_order['stock_order']['trailing_stop_step'])
 
+        # This is an optional feature; you can still make a request without setting it.
+        custom_headers_map = {"category": Category.US_STOCK.name}
+        request.add_custom_headers(custom_headers_map)
+
         try:
             response = api_client.get_response(request)
             print(response.json())

webull-python-sdk-demos/tests/trade/request/v2/test_place_order.py

@@ -16,7 +16,9 @@
 import uuid
 
 from webullsdkcore.client import ApiClient
+from webullsdkcore.context.request_context_holder import RequestContextHolder
 from webullsdkcore.exception.exceptions import ServerException
+from webullsdkmdata.common.category import Category
 from webullsdktrade.request.v2.palce_order_request import PlaceOrderRequest
 
 optional_api_endpoint = "<api_endpoint>"
@@ -30,17 +32,16 @@
 client_order_id = uuid.uuid4().hex
 new_orders = {
     "client_order_id": client_order_id,
-    "symbol": "7011",
+    "symbol": "AAPL",
     "instrument_type": "EQUITY",
-    "market": "JP",
+    "market": "US",
     "order_type": "LIMIT",
-    "limit_price": "2080",
-    "quantity": "100",
+    "limit_price": "196",
+    "quantity": "1",
     "support_trading_session": "N",
     "side": "BUY",
     "time_in_force": "DAY",
-    "entrust_type": "QTY",
-    "account_tax_type": "GENERAL"
+    "entrust_type": "QTY"
 }
 
 
@@ -50,13 +51,16 @@ def test_place_order(self):
         request.set_endpoint(optional_api_endpoint)
         request.set_account_id(account_id)
         request.set_new_orders(new_orders)
-        request.set_custom_header(new_orders)
         request.finalize_order()
         post_body = request.get_body_params()
         print(json.dumps(post_body, indent=4))
         params = request.get_query_params()
         print(params)
 
+        # This is an optional feature; you can still make a request without setting it.
+        custom_headers_map = {"category": Category.US_STOCK.name}
+        request.add_custom_headers(custom_headers_map)
+
         try:
             response = api_client.get_response(request)
             print(response.json())

webull-python-sdk-demos/tests/trade/test_api.py

@@ -221,13 +221,22 @@ def test_api(self):
         }
         """
 
+        # This is an optional feature; you can still make a request without setting it.
+        custom_headers_map = {"category": Category.US_STOCK.name}
+        api.order.add_custom_headers(custom_headers_map)
         res = api.order.place_order(stock_order['account_id'], **stock_order['stock_order'])
+        api.order.remove_custom_headers()
         if res.status_code == 200:
             print('place order res:', res.json())
         res = api.order.replace_order(stock_order['account_id'], **stock_order['stock_order'])
         if res.status_code == 200:
             print('replace order res:', res.json())
+
+        # This is an optional feature; you can still make a request without setting it.
+        custom_headers_map = {"category": Category.US_STOCK.name}
+        api.order.add_custom_headers(custom_headers_map)
         res = api.order.place_order_v2(stock_order['account_id'], stock_order['stock_order'])
+        api.order.remove_custom_headers()
         if res.status_code == 200:
             print('place order v2 res:', res.json())
         res = api.order.replace_order_v2(stock_order['account_id'], stock_order['stock_order'])
@@ -298,7 +307,11 @@ def test_api(self):
         sleep(5)
 
         # place
+        # This is an optional feature; you can still make a request without setting it.
+        custom_headers_map = {"category": Category.US_OPTION.name}
+        api.order.add_custom_headers(custom_headers_map)
         res = api.order.place_option(account_id, option_new_orders)
+        api.order.remove_custom_headers()
         if res.status_code == 200:
             print("place option=" + json.dumps(res.json(), indent=4))
         sleep(5)

webull-python-sdk-demos/tests/trade/test_api_v2.py

@@ -86,7 +86,12 @@ def test_api(self):
             #     {"party_id":"BNG144.666555","party_id_source":"D","party_role":"3"}
             # ]
         }
+
+        # This is an optional feature; you can still make a request without setting it.
+        custom_headers_map = {"category": Category.US_STOCK.name}
+        api.order_v2.add_custom_headers(custom_headers_map)
         res = api.order_v2.place_order(account_id=account_id, new_orders=new_orders)
+        api.order_v2.remove_custom_headers()
         if res.status_code == 200:
             print("place_order_res=" + json.dumps(res.json(), indent=4))
         sleep(5)
@@ -158,7 +163,12 @@ def test_api(self):
             print("preview option=" + json.dumps(res.json(), indent=4))
         sleep(5)
         # place
+
+        # This is an optional feature; you can still make a request without setting it.
+        custom_headers_map = {"category": Category.US_OPTION.name}
+        api.order_v2.add_custom_headers(custom_headers_map)
         res = api.order_v2.place_option(account_id, option_new_orders)
+        api.order_v2.remove_custom_headers()
         if res.status_code == 200:
             print("place option=" + json.dumps(res.json(), indent=4))
         sleep(5)

webull-python-sdk-mdata/setup.py

@@ -15,8 +15,8 @@
     LONG_DESCRIPTION = fp.read()
 
 requires = [
-    "webull-python-sdk-core==0.1.14",
-    "webull-python-sdk-quotes-core==0.1.14"
+    "webull-python-sdk-core==0.1.15",
+    "webull-python-sdk-quotes-core==0.1.15"
 ]
 
 setup_args = {