exception handling in user code (not ready)

Author: oliver-zehentleitner

README.md

@@ -114,7 +114,7 @@ with BinanceWebSocketApiManager(exchange='binance.com') as ubwa:
 
 Basically that's it, but there are more options.
 
-### Convert received raw webstream data into well-formed Python dictionaries with [UnicornFy](https://www.lucit.tech/unicorn-fy.html):
+### Convert received stream data into well-formed Python dictionaries with [UnicornFy](https://www.lucit.tech/unicorn-fy.html):
 
 ```
 unicorn_fied_stream_data = UnicornFy.binance_com_websocket(data)
@@ -126,7 +126,7 @@ or
 ubwa.create_stream(['trade'], ['btcusdt'], output="UnicornFy")
 ```
 
-### [Subscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.subscribe_to_stream) / [unsubscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.unsubscribe_from_stream) new markets and channels:
+## [Subscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.subscribe_to_stream) / [unsubscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.unsubscribe_from_stream) new markets and channels:
 
 ```
 markets = ['engbtc', 'zileth']
@@ -178,24 +178,27 @@ 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
+## `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 
 incorrect values or that you have to reload the missing data via REST as an alternative. 
 
 For this purpose, the UNICORN Binance WebSocket API provides so-called 
-[STREAM SIGNALS](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/%60stream_signals%60)
+[`stream_signals`](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/%60stream_signals%60)
 , 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.
 

dev/sphinx/source/readme.md

@@ -114,7 +114,7 @@ with BinanceWebSocketApiManager(exchange='binance.com') as ubwa:
 
 Basically that's it, but there are more options.
 
-### Convert received raw webstream data into well-formed Python dictionaries with [UnicornFy](https://www.lucit.tech/unicorn-fy.html):
+### Convert received stream data into well-formed Python dictionaries with [UnicornFy](https://www.lucit.tech/unicorn-fy.html):
 
 ```
 unicorn_fied_stream_data = UnicornFy.binance_com_websocket(data)
@@ -126,7 +126,7 @@ or
 ubwa.create_stream(['trade'], ['btcusdt'], output="UnicornFy")
 ```
 
-### [Subscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.subscribe_to_stream) / [unsubscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.unsubscribe_from_stream) new markets and channels:
+## [Subscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.subscribe_to_stream) / [unsubscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.unsubscribe_from_stream) new markets and channels:
 
 ```
 markets = ['engbtc', 'zileth']
@@ -178,24 +178,27 @@ 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
+## `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 
 incorrect values or that you have to reload the missing data via REST as an alternative. 
 
 For this purpose, the UNICORN Binance WebSocket API provides so-called 
-[STREAM SIGNALS](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/%60stream_signals%60)
+[`stream_signals`](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/%60stream_signals%60)
 , 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.
 

docs/_modules/index.html

@@ -254,7 +254,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 04 2024 at 11:22 (CET).
+    Last updated on May 04 2024 at 11:34 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/_sources/readme.md.txt

@@ -114,7 +114,7 @@ with BinanceWebSocketApiManager(exchange='binance.com') as ubwa:
 
 Basically that's it, but there are more options.
 
-### Convert received raw webstream data into well-formed Python dictionaries with [UnicornFy](https://www.lucit.tech/unicorn-fy.html):
+### Convert received stream data into well-formed Python dictionaries with [UnicornFy](https://www.lucit.tech/unicorn-fy.html):
 
 ```
 unicorn_fied_stream_data = UnicornFy.binance_com_websocket(data)
@@ -126,7 +126,7 @@ or
 ubwa.create_stream(['trade'], ['btcusdt'], output="UnicornFy")
 ```
 
-### [Subscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.subscribe_to_stream) / [unsubscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.unsubscribe_from_stream) new markets and channels:
+## [Subscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.subscribe_to_stream) / [unsubscribe](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.unsubscribe_from_stream) new markets and channels:
 
 ```
 markets = ['engbtc', 'zileth']
@@ -178,24 +178,27 @@ 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
+## `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 
 incorrect values or that you have to reload the missing data via REST as an alternative. 
 
 For this purpose, the UNICORN Binance WebSocket API provides so-called 
-[STREAM SIGNALS](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/%60stream_signals%60)
+[`stream_signals`](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/wiki/%60stream_signals%60)
 , 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.
 

docs/changelog.html

@@ -3954,7 +3954,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 04 2024 at 11:22 (CET).
+    Last updated on May 04 2024 at 11:34 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/code_of_conduct.html

@@ -399,7 +399,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 04 2024 at 11:22 (CET).
+    Last updated on May 04 2024 at 11:34 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/contributing.html

@@ -338,7 +338,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 04 2024 at 11:22 (CET).
+    Last updated on May 04 2024 at 11:34 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/genindex.html

@@ -779,7 +779,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 04 2024 at 11:22 (CET).
+    Last updated on May 04 2024 at 11:34 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/index.html

@@ -179,16 +179,16 @@ <h1>Welcome to unicorn-binance-websocket-api’s documentation!<a class="headerl
 <li class="toctree-l3"><a class="reference internal" href="readme.html#and-4-more-lines-to-print-out-the-data">And 4 more lines to print out the data:</a></li>
 <li class="toctree-l3"><a class="reference internal" href="readme.html#or-with-a-callback-function-just-do">Or with a callback function just do:</a></li>
 <li class="toctree-l3"><a class="reference internal" href="readme.html#or-await-the-webstream-data-in-an-asyncio-coroutine">Or await the webstream data in an asyncio coroutine:</a></li>
-<li class="toctree-l3"><a class="reference internal" href="readme.html#convert-received-raw-webstream-data-into-well-formed-python-dictionaries-with-unicornfy">Convert received raw webstream data into well-formed Python dictionaries with UnicornFy:</a></li>
-<li class="toctree-l3"><a class="reference internal" href="readme.html#subscribe-unsubscribe-new-markets-and-channels">Subscribe / unsubscribe new markets and channels:</a></li>
+<li class="toctree-l3"><a class="reference internal" href="readme.html#convert-received-stream-data-into-well-formed-python-dictionaries-with-unicornfy">Convert received stream data into well-formed Python dictionaries with UnicornFy:</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="readme.html#subscribe-unsubscribe-new-markets-and-channels">Subscribe / unsubscribe new markets and channels:</a></li>
 <li class="toctree-l2"><a class="reference internal" href="readme.html#send-requests-to-binance-websocket-api">Send Requests to Binance WebSocket API</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="readme.html#place-orders-cancel-orders-or-send-other-requests-via-websocket">Place orders, cancel orders or send other requests via WebSocket:</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="readme.html#stop-ubwa-after-usage-to-avoid-memory-leaks">Stop <code class="docutils literal notranslate"><span class="pre">ubwa</span></code> after usage to avoid memory leaks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="readme.html#stream-signals-know-the-state-of-your-streams">STREAM SIGNALS - know the state of your streams</a></li>
+<li class="toctree-l2"><a class="reference internal" href="readme.html#stream-signals-know-the-state-of-your-streams"><code class="docutils literal notranslate"><span class="pre">stream_signals</span></code> - know the state of your streams</a></li>
 <li class="toctree-l2"><a class="reference internal" href="readme.html#description">Description</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="readme.html#what-are-the-benefits-of-the-unicorn-binance-websocket-api">What are the benefits of the UNICORN Binance WebSocket API?</a></li>
 </ul>
@@ -1063,7 +1063,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 04 2024 at 11:22 (CET).
+    Last updated on May 04 2024 at 11:34 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/license.html

@@ -389,7 +389,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 04 2024 at 11:22 (CET).
+    Last updated on May 04 2024 at 11:34 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/py-modindex.html

@@ -302,7 +302,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on May 04 2024 at 11:22 (CET).
+    Last updated on May 04 2024 at 11:34 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.