stubs

Author: oliver-zehentleitner

.gitignore

@@ -13,6 +13,7 @@ __pycache__/
 
 # Distribution / packaging
 .Python
+stubs/
 build/
 develop-eggs/
 dist/

dev/reset.sh

@@ -6,6 +6,8 @@ rm dev/*.log
 rm build -r
 rm dist -r
 rm *.egg-info -r
+rm stubs -r
+rm out -r
 
 rm unicorn_binance_websocket_api/*.c
 rm unicorn_binance_websocket_api/*.html

example_binance_dex.py

@@ -40,7 +40,7 @@
 
 # https://docs.python.org/3/library/logging.html#logging-levels
 logging.getLogger("unicorn_binance_websocket_api")
-logging.basicConfig(level=logging.INFO,
+logging.basicConfig(level=logging.DEBUG,
                     filename=os.path.basename(__file__) + '.log',
                     format="{asctime} [{levelname:8}] {process} {thread} {module}: {message}",
                     style="{")
@@ -51,7 +51,9 @@ def print_stream_data_from_stream_buffer(binance_websocket_api_manager):
         if binance_websocket_api_manager.is_manager_stopping():
             exit(0)
         oldest_stream_data_from_stream_buffer = binance_websocket_api_manager.pop_stream_data_from_stream_buffer()
-        if oldest_stream_data_from_stream_buffer is None:
+        if oldest_stream_data_from_stream_buffer is not None:
+            print(oldest_stream_data_from_stream_buffer)
+        else:
             time.sleep(0.01)
 
 
@@ -60,7 +62,7 @@ def print_stream_data_from_stream_buffer(binance_websocket_api_manager):
 
 # create instance of BinanceWebSocketApiManager for Binance Chain DEX
 # use `exchange="binance.org-testnet"` for testnet mode
-binance_websocket_api_manager = BinanceWebSocketApiManager(exchange="binance.org")
+binance_websocket_api_manager = BinanceWebSocketApiManager(exchange="binance.org-testnet", high_performance=False)
 
 # start a worker process to move the received stream_data from the stream_buffer to a print function
 worker_thread = threading.Thread(target=print_stream_data_from_stream_buffer, args=(binance_websocket_api_manager,))
@@ -82,13 +84,6 @@ def print_stream_data_from_stream_buffer(binance_websocket_api_manager):
 binance_websocket_api_manager.create_stream('transfers', binance_dex_user_address)
 user_address_multi_stream_id = binance_websocket_api_manager.create_stream(['orders', 'transfers'],
                                                                            binance_dex_user_address)
-
-# subscribe is going to be rewritten, dont use for now!
-#if binance_websocket_api_manager.wait_till_stream_has_started(user_address_multi_stream_id):
-#    binance_websocket_api_manager.subscribe_to_stream(user_address_multi_stream_id,
-#                                                      'accounts',
-#                                                      binance_dex_user_address)
-
 # single streams
 if binance_websocket_api_manager.get_exchange() == "binance.org":
     markets = 'RAVEN-F66_BNB'
@@ -105,7 +100,7 @@ def print_stream_data_from_stream_buffer(binance_websocket_api_manager):
     channels = ['trades', 'kline_1m', 'kline_5m', 'kline_15m', 'marketDepth', 'ticker', 'miniTicker', 'marketDiff']
     markets = ['RAVEN-F66_BNB', 'ANKR-E97_BNB', 'AWC-986_BNB', 'COVA-218_BNB', 'BCPT-95A_BNB', 'WISH-2D5_BNB',
                'MITH-C76_BNB', 'BNB_BTCB-1DE', 'BNB_USDSB-1AC', 'BTCB-1DE_USDSB-1AC', 'NEXO-A84_BNB']
-    #multiplex_stream_id = binance_websocket_api_manager.create_stream(channels, markets)
+    multiplex_stream_id = binance_websocket_api_manager.create_stream(channels, markets)
 
 while True:
     binance_websocket_api_manager.print_summary()

pyproject.toml

@@ -46,4 +46,4 @@ requires = ["setuptools", "wheel", "Cython", "pip"]
 build-backend = "setuptools.build_meta"
 
 [tool.poetry.package_data]
-unicorn_binance_websocket_api = ["*.so", "*.dll", "*.py"]
+"unicorn_binance_websocket_api" = ["*.so", "*.dll", "*.py", "*.pyi"]

setup.py

@@ -18,25 +18,51 @@
 # Copyright (c) 2019-2024, LUCIT Systems and Development (https://www.lucit.tech)
 # All rights reserved.
 
-from setuptools import setup
 from Cython.Build import cythonize
+from setuptools import setup
+import os
+import shutil
+import subprocess
+
+source_dir = "unicorn_binance_websocket_api"
+stubs_dir = "stubs"
+
+
+def generate_stubs():
+    print("Generating stub files ...")
+    target_dir = os.path.join(stubs_dir)
+    os.makedirs(target_dir, exist_ok=True)
+    for filename in os.listdir(source_dir):
+        if filename.endswith('.py'):
+            source_path = os.path.join(source_dir, filename)
+            stub_output_dir = os.path.join(stubs_dir, source_dir)
+            os.makedirs(stub_output_dir, exist_ok=True)
+            subprocess.run(['stubgen', '-o', stub_output_dir, source_path], check=True)
+            for stub_file in os.listdir(stub_output_dir):
+                if stub_file.endswith('.pyi'):
+                    source_stub_path = os.path.join(stub_output_dir, stub_file)
+                    shutil.move(source_stub_path, source_dir)
+    print("Stub files generated and moved successfully.")
+
 
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
+generate_stubs()
+
 setup(
     ext_modules=cythonize(
-        ['unicorn_binance_websocket_api/__init__.py',
-         'unicorn_binance_websocket_api/api.py',
-         'unicorn_binance_websocket_api/connection.py',
-         'unicorn_binance_websocket_api/connection_settings.py',
-         'unicorn_binance_websocket_api/exceptions.py',
-         'unicorn_binance_websocket_api/manager.py',
-         'unicorn_binance_websocket_api/restclient.py',
-         'unicorn_binance_websocket_api/restserver.py',
-         'unicorn_binance_websocket_api/sockets.py',
-         'unicorn_binance_websocket_api/licensing_exceptions.py',
-         'unicorn_binance_websocket_api/licensing_manager.py'],
+        [f'{source_dir}/__init__.py',
+         f'{source_dir}/api.py',
+         f'{source_dir}/connection.py',
+         f'{source_dir}/connection_settings.py',
+         f'{source_dir}/exceptions.py',
+         f'{source_dir}/manager.py',
+         f'{source_dir}/restclient.py',
+         f'{source_dir}/restserver.py',
+         f'{source_dir}/sockets.py',
+         f'{source_dir}/licensing_exceptions.py',
+         f'{source_dir}/licensing_manager.py'],
         annotate=False),
     name='unicorn-binance-websocket-api',
     version="2.6.0",
@@ -54,7 +80,7 @@
                       'unicorn-binance-rest-api', 'typing_extensions', 'Cython'],
     keywords='binance, asyncio, async, asynchronous, concurrent, websocket-api, webstream-api, '
              'binance-websocket, binance-webstream, webstream, websocket, api, binance-dex, '
-            'binance-futures, binance-margin, binance-us',
+             'binance-futures, binance-margin, binance-us',
     project_urls={
         'Howto': 'https://www.lucit.tech/unicorn-binance-websocket-api.html#howto',
         'Documentation': 'https://unicorn-binance-websocket-api.docs.lucit.tech',
@@ -69,9 +95,7 @@
         'LUCIT Online Shop': 'https://shop.lucit.services/software',
     },
     python_requires='>=3.7.0',
-    package_data={'': ['unicorn_binance_websocket_api/*.so',
-                       'unicorn_binance_websocket_api/*.dll',
-                       'unicorn_binance_websocket_api/*.py']},
+    package_data={'': ['*.so', '*.dll', '*.py', '*.pyi']},
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Programming Language :: Python :: 3.7",

unicorn_binance_websocket_api/__init__.pyi

@@ -428,8 +428,8 @@ def __init__(self,
         self.warn_on_update = warn_on_update
         if warn_on_update and self.is_update_available():
             update_msg = f"Release {self.name}_" + self.get_latest_version() + " is available, " \
-                         f"please consider updating! (Changelog: " \
-                         f"https://unicorn-binance-websocket-api.docs.lucit.tech/changelog.html)"
+                         f"please consider updating! Changelog: " \
+                         f"https://unicorn-binance-websocket-api.docs.lucit.tech/changelog.html"
             print(update_msg)
             logger.warning(update_msg)
         self.restclient = BinanceWebSocketApiRestclient(debug=self.debug,