fix #380

Author: oliver-zehentleitner

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -113,8 +113,10 @@ body:
       description: |
         Are you using the `stream_buffer` or the `process_stream_data`-callback function?
       options:
-        - stream_buffer
+        - process_asyncio_queue
         - process_stream_data
+        - process_stream_data_async
+        - stream_buffer
     validations:
       required: true
 

.github/workflows/build_wheels.yml

@@ -90,7 +90,7 @@ jobs:
           generate_release_notes: true
           name: unicorn-binance-websocket-api
           prerelease: false
-          tag_name: 2.7.1
+          tag_name: 2.7.2
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Create PyPi Release

CHANGELOG.md

@@ -9,7 +9,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 [How to upgrade to the latest version!](https://unicorn-binance-websocket-api.docs.lucit.tech/readme.html#installation-and-upgrade)
 
-## 2.7.1.dev (development stage/unreleased/unstable)
+## 2.7.2.dev (development stage/unreleased/unstable)
+
+## 2.7.2
+### Fixed
+- Stream Data is always returned in `raw_data` format. [issue#380](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/380)
 
 ## 2.7.1
 ### Added

README.md

@@ -486,10 +486,10 @@ Run in bash:
 `pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade`
 
 #### Windows
-Use the below command with the version (such as 2.7.1) you determined 
+Use the below command with the version (such as 2.7.2) you determined 
 [here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases/latest):
 
-`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.7.1.tar.gz --upgrade`
+`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.7.2.tar.gz --upgrade`
 ### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api)
 This is not a release version and can not be considered to be stable!
 

dev/set_version_config.txt

@@ -1,2 +1,2 @@
-2.7.1
+2.7.2
 meta.yaml,pyproject.toml,setup.py,README.md,.github/workflows/build_wheels.yml,dev/sphinx/source/conf.py,unicorn_binance_websocket_api/manager.py

dev/sphinx/source/changelog.md

@@ -9,7 +9,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 [How to upgrade to the latest version!](https://unicorn-binance-websocket-api.docs.lucit.tech/readme.html#installation-and-upgrade)
 
-## 2.7.1.dev (development stage/unreleased/unstable)
+## 2.7.2.dev (development stage/unreleased/unstable)
+
+## 2.7.2
+### Fixed
+- Stream Data is always returned in `raw_data` format. [issue#380](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/380)
 
 ## 2.7.1
 ### Added

dev/sphinx/source/conf.py

@@ -27,7 +27,7 @@
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-release = '2.7.1'
+release = '2.7.2'
 
 html_last_updated_fmt = "%b %d %Y at %H:%M (CET)"
 

dev/sphinx/source/readme.md

@@ -76,7 +76,7 @@ ubwa.create_stream(channels=['trade', 'kline_1m'],
                    process_stream_data=process_new_receives)
 ```
 
-### Or with a [async callback function](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html?highlight=process_stream_data#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.create_stream) just do
+### Or with an [async callback function](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html?highlight=process_stream_data#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.create_stream) just do
 
 ```
 from unicorn_binance_websocket_api import BinanceWebSocketApiManager
@@ -210,8 +210,8 @@ currently "blind" and you may want to close open positions to be on the safe sid
 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)
-, which are used to tell your code in real time when a stream is connected, when it received its first data record, when 
+[`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.
 
 ```
@@ -263,7 +263,7 @@ also all private userData streams which needs to be used with a valid
 from the Binance Exchange [www.binance.com](https://www.binance.com/), 
 [testnet.binance.vision](https://testnet.binance.vision/) or 
 [www.binance.us](https://www.binance.us) - for the DEX you need a user address from 
-[www.binance.org](https://www.binance.org/en/create) or [testnet.binance.org](https://testnet.binance.org/en/create) 
+[www.binance.org](https://www.binance.org/en/create) or [testnet.binance.org](https://testnet.binance.org/en/create), 
 and you can [get funds](https://www.binance.vision/tutorials/binance-dex-funding-your-testnet-account) for the testnet.
 
 Use the [UNICORN Binance REST API](https://www.lucit.tech/unicorn-binance-rest-api.html) in combination. 
@@ -367,6 +367,9 @@ and many more! Explore them [here](https://unicorn-binance-websocket-api.docs.lu
 and specific streams with 
 [`get_stream_info()`](https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html#unicorn_binance_websocket_api.manager.BinanceWebSocketApiManager.get_stream_info).
 
+- Available as a package via `pip` and `conda` as precompiled C extension with stub files for improved Intellisense 
+  functions and source code for easier debugging of the source code. [To the installation.](#installation-and-upgrade)
+
 - Nice to use with [iPython](https://ipython.org/): 
 "IPython (Interactive Python) is a command shell for interactive computing that offers introspection, 
 rich media, shell syntax, tab completion, and history." 
@@ -483,10 +486,10 @@ Run in bash:
 `pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/$(curl -s https://api.github.com/repos/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade`
 
 #### Windows
-Use the below command with the version (such as 2.7.1) you determined 
+Use the below command with the version (such as 2.7.2) you determined 
 [here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/releases/latest):
 
-`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.7.1.tar.gz --upgrade`
+`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/archive/2.7.2.tar.gz --upgrade`
 ### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api)
 This is not a release version and can not be considered to be stable!
 

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 5be6d9e3caa654ce2760904d74eac401
+config: 2388cf749599782cc97e4320c09ba519
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_modules/index.html

@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; unicorn-binance-websocket-api 2.7.1 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Overview: module code &#8212; unicorn-binance-websocket-api 2.7.2 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=92fd9be5" />
     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=fdf8e9ae" />
@@ -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 14 2024 at 21:34 (CET).
+    Last updated on May 15 2024 at 09:17 (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/_modules/unicorn_binance_websocket_api/manager.html

@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>unicorn_binance_websocket_api.manager &#8212; unicorn-binance-websocket-api 2.7.1 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>unicorn_binance_websocket_api.manager &#8212; unicorn-binance-websocket-api 2.7.2 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=92fd9be5" />
     <link rel="stylesheet" type="text/css" href="../../_static/pydoctheme.css?v=fdf8e9ae" />
@@ -208,7 +208,7 @@ <h1>Source code for unicorn_binance_websocket_api.manager</h1><div class="highli
 
 
 <span class="n">__app_name__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;unicorn-binance-websocket-api&quot;</span>
-<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;2.7.1.dev&quot;</span>
+<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;2.7.2&quot;</span>
 <span class="n">__logger__</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;unicorn_binance_websocket_api&quot;</span><span class="p">)</span>
 
 <span class="n">logger</span> <span class="o">=</span> <span class="n">__logger__</span>
@@ -859,7 +859,7 @@ <h1>Source code for unicorn_binance_websocket_api.manager</h1><div class="highli
                                    <span class="n">api_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                    <span class="n">api_secret</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                    <span class="n">symbols</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
-                                   <span class="n">output</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;dict&#39;</span><span class="p">,</span> <span class="s1">&#39;raw_data&#39;</span><span class="p">,</span> <span class="s1">&#39;UnicornFy&#39;</span><span class="p">]]</span> <span class="o">=</span> <span class="s2">&quot;raw_data&quot;</span><span class="p">,</span>
+                                   <span class="n">output</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;dict&#39;</span><span class="p">,</span> <span class="s1">&#39;raw_data&#39;</span><span class="p">,</span> <span class="s1">&#39;UnicornFy&#39;</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                                    <span class="n">ping_interval</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                    <span class="n">ping_timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                    <span class="n">close_timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
@@ -1821,7 +1821,7 @@ <h1>Source code for unicorn_binance_websocket_api.manager</h1><div class="highli
                       <span class="n">api_key</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                       <span class="n">api_secret</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                       <span class="n">symbols</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">Set</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
-                      <span class="n">output</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;dict&#39;</span><span class="p">,</span> <span class="s1">&#39;raw_data&#39;</span><span class="p">,</span> <span class="s1">&#39;UnicornFy&#39;</span><span class="p">]]</span> <span class="o">=</span> <span class="s2">&quot;raw_data&quot;</span><span class="p">,</span>
+                      <span class="n">output</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;dict&#39;</span><span class="p">,</span> <span class="s1">&#39;raw_data&#39;</span><span class="p">,</span> <span class="s1">&#39;UnicornFy&#39;</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                       <span class="n">ping_interval</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                       <span class="n">ping_timeout</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                       <span class="n">close_timeout</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
@@ -1894,7 +1894,7 @@ <h1>Source code for unicorn_binance_websocket_api.manager</h1><div class="highli
 <span class="sd">        :type api_secret: str</span>
 <span class="sd">        :param symbols: provide the symbols for isolated_margin user_data streams</span>
 <span class="sd">        :type symbols: str, list, set</span>
-<span class="sd">        :param output: the default setting `raw_data` can be globaly overwritten with the parameter</span>
+<span class="sd">        :param output: the default setting `raw_data` can be globally overwritten with the parameter</span>
 <span class="sd">                       `output_default &lt;https://unicorn-binance-websocket-api.docs.lucit.tech/unicorn_binance_websocket_api.html?highlight=output_default#module-unicorn_binance_websocket_api.unicorn_binance_websocket_api_manager&gt;`__</span>
 <span class="sd">                       of BinanceWebSocketApiManager`. To overrule the `output_default` value for this specific stream,</span>
 <span class="sd">                       set `output` to &quot;dict&quot; to convert the received raw data to a python dict,  set to &quot;UnicornFy&quot; to</span>
@@ -4506,7 +4506,7 @@ <h1>Source code for unicorn_binance_websocket_api.manager</h1><div class="highli
                        <span class="n">new_api_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                        <span class="n">new_api_secret</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                        <span class="n">new_symbols</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
-                       <span class="n">new_output</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;dict&#39;</span><span class="p">,</span> <span class="s1">&#39;raw_data&#39;</span><span class="p">,</span> <span class="s1">&#39;UnicornFy&#39;</span><span class="p">]]</span> <span class="o">=</span> <span class="s2">&quot;raw_data&quot;</span><span class="p">,</span>
+                       <span class="n">new_output</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;dict&#39;</span><span class="p">,</span> <span class="s1">&#39;raw_data&#39;</span><span class="p">,</span> <span class="s1">&#39;UnicornFy&#39;</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                        <span class="n">new_ping_interval</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span>
                        <span class="n">new_ping_timeout</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span>
                        <span class="n">new_close_timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
@@ -4539,8 +4539,8 @@ <h1>Source code for unicorn_binance_websocket_api.manager</h1><div class="highli
 <span class="sd">        :type new_symbols: str</span>
 <span class="sd">        :return: new stream_id</span>
 <span class="sd">        :param new_output: set to &quot;dict&quot; to convert the received raw data to a python dict, set to &quot;UnicornFy&quot; to convert</span>
-<span class="sd">                           with `UnicornFy &lt;https://github.com/LUCIT-Systems-and-Development/unicorn-fy&gt;`__ - otherwise the output</span>
-<span class="sd">                           remains unchanged and gets delivered as received from the endpoints</span>
+<span class="sd">                           with `UnicornFy &lt;https://github.com/LUCIT-Systems-and-Development/unicorn-fy&gt;`__ - otherwise</span>
+<span class="sd">                           the output remains unchanged and gets delivered as received from the endpoints</span>
 <span class="sd">        :type new_output: str</span>
 <span class="sd">        :param new_ping_interval: Once the connection is open, a `Ping frame` is sent every</span>
 <span class="sd">                                  `ping_interval` seconds. This serves as a keepalive. It helps keeping</span>
@@ -5428,7 +5428,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 14 2024 at 21:34 (CET).
+    Last updated on May 15 2024 at 09:17 (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.