exception handling in user code (not ready)

Author: oliver-zehentleitner

README.md

@@ -177,6 +177,18 @@ ubwa.api.cancel_order(orig_client_order_id=orig_client_order_id, symbol="BUSDUSD
 guide on 
 [how to process requests via the Binance WebSocket API](https://medium.lucit.tech/create-and-cancel-orders-via-websocket-on-binance-7f828831404)!
 
+## Stop `ubwa` after usage to avoid memory leaks
+When you instantiate UBWA with `with`, `ubwa.stop_manager()` is automatically executed upon exiting the `with`-block.
+```
+with BinanceWebSocketApiManager() as ubwa:
+    ubwa.create_stream(channels="trade", markets="btcusdt", stream_label="TRADES")
+```
+
+Without `with`, you must explicitly execute `ubwa.stop_manager()` yourself.
+```
+ubwa.stop_manager()
+```
+
 ## STREAM SIGNALS - know the state of your streams
 Usually you want to know when a stream is working and when it is not. This can be useful to know that your own system is 
 currently "blind" and you may want to close open positions to be on the safe side, know that indicators will now provide 
@@ -187,10 +199,19 @@ For this purpose, the UNICORN Binance WebSocket API provides so-called
 , which are used to tell your code in real time when a stream is connected, when it received its first data record, when 
 it was disconnected and stopped, and when the stream cannot be restored.
 
-## Stop `ubwa` after usage to avoid memory leaks
-
 ```
-ubwa.stop_manager()
+from unicorn_binance_websocket_api import BinanceWebSocketApiManager
+import time
+
+def process_stream_signals(signal_type=None, stream_id=None, data_record=None, error_msg=None):
+    print(f"Received stream_signal for stream '{ubwa.get_stream_label(stream_id=stream_id)}': "
+          f"{signal_type} - {stream_id} - {data_record} - {error_msg}")
+
+with BinanceWebSocketApiManager(process_stream_signals=process_stream_signals) as ubwa:
+    ubwa.create_stream(channels="trade", markets="btcusdt", stream_label="TRADES")
+    time.sleep(2)
+    print(f"Waiting 5 seconds and then stop the stream ...")
+    time.sleep(5)
 ```
 
 [Discover even more possibilities](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html)

dev/test_stream_signals.py

@@ -1,17 +1,13 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
 from unicorn_binance_websocket_api import BinanceWebSocketApiManager
 import time
 
-
-def receive_stream_signal(self, signal_type=None, stream_id=None, data_record=None, error_msg=None):
+def process_stream_signals(signal_type=None, stream_id=None, data_record=None, error_msg=None):
     print(f"Received stream_signal for stream '{ubwa.get_stream_label(stream_id=stream_id)}': "
           f"{signal_type} - {stream_id} - {data_record} - {error_msg}")
 
-
-with BinanceWebSocketApiManager(process_stream_signals=receive_stream_signal) as ubwa:
-    ubwa.create_stream(channels="trade", markets="btcusdt", stream_label="HEALTHY")
+with BinanceWebSocketApiManager(process_stream_signals=process_stream_signals) as ubwa:
+    ubwa.create_stream(channels="trade", markets="btcusdt", stream_label="TRADES")
+    time.sleep(2)
     print(f"Waiting 5 seconds and then stop the stream ...")
     time.sleep(5)
 

unicorn_binance_websocket_api/manager.py

@@ -864,8 +864,7 @@ def _create_stream_thread(self,
                                  f"\033[1m\033[31m{type(error_msg).__name__} - {error_msg}\033[0m\r\n"
                                  f"{traceback.format_exc()}")
             print(f"\r\n{error_msg_wrapper}")
-            error_msg_wrapper = (f"Exception within to UBWA`s provided `process_asyncio_queue`-coroutine of stream "
-                                 f"'{stream_id}'{stream_label}: "
+            error_msg_wrapper = (f"Exception within a coroutine of stream '{stream_id}'{stream_label}: "
                                  f"{type(error_msg).__name__} - {error_msg}\r\n"
                                  f"{traceback.format_exc()}")
             logger.critical(error_msg_wrapper)