Merge branch 'main_merge_26083110' into 'main'

feat:Support the callback of the notice message

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

Author: 方佳

webull/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.18'
+__version__ = '2.0.19'

webull/data/data_streaming_client.py

@@ -20,10 +20,11 @@
 from webull.data.quotes.subscribe.event_snapshot_decoder import EventSnapshotDecoder
 from webull.data.quotes.subscribe.event_tick_decoder import EventTickDecoder
 from webull.data.quotes.subscribe.payload_type import PAYLOAD_TYPE_QUOTE, PAYLOAD_TYPE_SHAPSHOT, PAYLOAD_TYPE_TICK, \
-    PAYLOAD_TYPE_EVENT_SHAPSHOT, PAYLOAD_TYPE_EVENT_DEPTH, PAYLOAD_TYPE_EVENT_TICK
+    PAYLOAD_TYPE_EVENT_SHAPSHOT, PAYLOAD_TYPE_EVENT_DEPTH, PAYLOAD_TYPE_EVENT_TICK, PAYLOAD_TYPE_NOTICE
 from webull.data.quotes.subscribe.quote_decoder import QuoteDecoder
 from webull.data.quotes.subscribe.snapshot_decoder import SnapshotDecoder
 from webull.data.quotes.subscribe.tick_decoder import TickDecoder
+from webull.data.quotes.subscribe.notice_decoder import NoticeDecoder
 
 
 class DataStreamingClient(QuotesClient):
@@ -46,6 +47,7 @@ def __init__(self, app_key, app_secret, region_id, session_id, http_host=None,
         self.register_payload_decoder(PAYLOAD_TYPE_EVENT_DEPTH, EventDepthDecoder())
         self.register_payload_decoder(PAYLOAD_TYPE_EVENT_SHAPSHOT, EventSnapshotDecoder())
         self.register_payload_decoder(PAYLOAD_TYPE_EVENT_TICK, EventTickDecoder())
+        self.register_payload_decoder(PAYLOAD_TYPE_NOTICE, NoticeDecoder())
 
     @property
     def on_connect_success(self):

webull/data/internal/quotes_client.py

@@ -83,7 +83,7 @@ def _quotes_message(client, userdata, message):
                 client._easy_log(
                     LOG_DEBUG, 'decoded message topic: %s, payload: %s', decoded[0], decoded[1])
                 _on_quotes_message = client._on_quotes_message
-                no_callback_topic = ['echo','notice']
+                no_callback_topic = ['echo']
                 if _on_quotes_message and decoded[0] not in no_callback_topic:
                     _on_quotes_message(client, decoded[0], decoded[1])
             else:
@@ -115,7 +115,7 @@ def _quotes_on_connect(client, userdata, flags, rc):
 
         self._quotes_message = _quotes_message
         self._quotes_on_connect = _quotes_on_connect
-        mqttc.Client.__init__(self, self._client_id, transport=transport, reconnect_on_failure=False)
+        mqttc.Client.__init__(self, client_id=self._client_id, transport=transport, reconnect_on_failure=False)
         self.username_pw_set(self._app_key, uuid.uuid4().hex)
         if tls_enable:
             self.tls_set()

webull/data/quotes/subscribe/notice_decoder.py

@@ -0,0 +1,34 @@
+# 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 json
+
+from webull.data.internal.quotes_payload_decoder import BaseQuotesPayloadDecoder
+
+
+class NoticeDecoder(BaseQuotesPayloadDecoder):
+    """Decoder for notice messages from the server.
+
+    Notice messages are JSON-encoded and include:
+    - type '1001': status message with rtt, drop, sent fields
+    - type '1002': permission preemption with content field
+    """
+
+    def __init__(self):
+        super().__init__()
+
+    def parse(self, payload):
+        return json.loads(payload.decode("utf-8"))

webull/data/quotes/subscribe/payload_type.py

@@ -19,4 +19,5 @@
 PAYLOAD_TYPE_TICK = 'tick'
 PAYLOAD_TYPE_EVENT_DEPTH = 'event-quote'
 PAYLOAD_TYPE_EVENT_SHAPSHOT = 'event-snapshot'
-PAYLOAD_TYPE_EVENT_TICK = 'event-tick'
+PAYLOAD_TYPE_EVENT_TICK = 'event-tick'
+PAYLOAD_TYPE_NOTICE = 'notice'