crypto-ws-api 2.0.20__tar.gz → 2.1.2__tar.gz

{crypto_ws_api-2.0.20 → crypto_ws_api-2.1.2}/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 2.1.2 - 2025-08-10
+♻️ refactor(demo/demo_loop): Store demo_loop coroutines in variables for reference
+
+## 2.1.1 - 2025-08-10
+♻️ refactor(ws_session): introduce `tasks_manage` for centralized task handling  
+♻️ chore(deps): update platformdirs and cryptography to latest versions
+
+## 2.1.0 - 2025-06-22
+✨ refactor(ws_session.py): simplify `ws_login` and `request` methods by removing redundant `send_api_key` parameter.
+
+## 2.0.21 - 2025-06-22
+🔧 fix(README.md): Improve documentation layout for better readability  
+🔧 fix(ws_session.py): Handle `asyncio.CancelledError` gracefully in `start_wss` method  
+🔧 fix(ws_session.py): Replace `asyncio.CancelledError` with `KeyboardInterrupt` exception in `handle_request` method  
+🔧 fix(demo.py): Remove unnecessary `asyncio.CancelledError` handling to clean up error logging  
+🔧 fix(ws_api.toml.template): Update testnet URL for Binance websocket API 
+
 ## 2.0.20 - 2025-04-24
 * On `Binance` now API key type [Ed25519](https://www.binance.com/en/support/faq/detail/6b9a63f1e3384cf48a2eedb82767a69a) is used instead of `HMAC`
 ✨ feat(ws_session): implement `compose_binance_ws_auth` for Binance WebSocket authentication  

{crypto_ws_api-2.0.20 → crypto_ws_api-2.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: crypto-ws-api
-Version: 2.0.20
+Version: 2.1.2
 Summary: Crypto WS API connector for ASYNC requests
 Author-email: Jerry Fedorenko <jerry.fedorenko@yahoo.com>
 Requires-Python: >=3.10
@@ -11,12 +11,13 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: Unix
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: MacOS
+License-File: LICENSE.md
 Requires-Dist: shortuuid~=1.0.13
-Requires-Dist: platformdirs==4.3.6
+Requires-Dist: platformdirs==4.3.8
 Requires-Dist: toml~=0.10.2
 Requires-Dist: websockets==15.0.1
 Requires-Dist: ujson~=5.10.0
-Requires-Dist: cryptography~=44.0.2
+Requires-Dist: cryptography~=45.0.6
 Project-URL: Source, https://github.com/DogsTailFarmer/crypto-ws-api
 
 <h1 align="center"><img align="center" src="https://user-images.githubusercontent.com/77513676/250364389-cbedc171-a930-4467-a0cd-21627a6a41ed.svg" width="75">Crypto WS API connector for ASYNC requests</h1>
@@ -26,12 +27,13 @@ Project-URL: Source, https://github.com/DogsTailFarmer/crypto-ws-api
 <h3 align="center">Provides of connection management, keepalive and rate limits control</h3>
 
 ***
-<a href="https://pypi.org/project/crypto-ws-api/"><img src="https://img.shields.io/pypi/v/crypto-ws-api" alt="PyPI version"></a>
-<a href="https://codeclimate.com/github/DogsTailFarmer/crypto-ws-api/maintainability"><img src="https://api.codeclimate.com/v1/badges/2d2a654ba393eb88d911/maintainability" /></a>
+<h1 align="center"><a href="https://pypi.org/project/crypto-ws-api/"><img src="https://img.shields.io/pypi/v/crypto-ws-api" alt="PyPI version"></a>
 <a href="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api/?ref=repository-badge}" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api.svg/?label=resolved+issues&token=TXghPzbi0YWhkCLU8Q1tmDyQ"/></a>
 <a href="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api/?ref=repository-badge}" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api.svg/?label=active+issues&token=TXghPzbi0YWhkCLU8Q1tmDyQ"/></a>
 <a href="https://sonarcloud.io/summary/new_code?id=DogsTailFarmer_crypto-ws-api" target="_blank"><img alt="sonarcloud" title="sonarcloud" src="https://sonarcloud.io/api/project_badges/measure?project=DogsTailFarmer_crypto-ws-api&metric=alert_status"/></a>
 <a href="https://pepy.tech/project/crypto-ws-api" target="_blank"><img alt="Downloads" title="Downloads" src="https://static.pepy.tech/badge/crypto-ws-api"/></a>
+</h1>
+
 ***
 For :heavy_check_mark:[Binance](https://accounts.binance.com/en/register?ref=FXQ6HY5O), :heavy_check_mark:[OKX](https://okx.com/join/2607649), :heavy_check_mark:[Bitfinex](https://www.bitfinex.com/sign-up?refcode=v_4az2nCP), :heavy_check_mark:[HTX](https://www.htx.com/invite/en-us/1f?invite_code=9uaw3223)
 ***

{crypto_ws_api-2.0.20 → crypto_ws_api-2.1.2}/README.md

@@ -5,12 +5,13 @@
 <h3 align="center">Provides of connection management, keepalive and rate limits control</h3>
 
 ***
-<a href="https://pypi.org/project/crypto-ws-api/"><img src="https://img.shields.io/pypi/v/crypto-ws-api" alt="PyPI version"></a>
-<a href="https://codeclimate.com/github/DogsTailFarmer/crypto-ws-api/maintainability"><img src="https://api.codeclimate.com/v1/badges/2d2a654ba393eb88d911/maintainability" /></a>
+<h1 align="center"><a href="https://pypi.org/project/crypto-ws-api/"><img src="https://img.shields.io/pypi/v/crypto-ws-api" alt="PyPI version"></a>
 <a href="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api/?ref=repository-badge}" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api.svg/?label=resolved+issues&token=TXghPzbi0YWhkCLU8Q1tmDyQ"/></a>
 <a href="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api/?ref=repository-badge}" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://app.deepsource.com/gh/DogsTailFarmer/crypto-ws-api.svg/?label=active+issues&token=TXghPzbi0YWhkCLU8Q1tmDyQ"/></a>
 <a href="https://sonarcloud.io/summary/new_code?id=DogsTailFarmer_crypto-ws-api" target="_blank"><img alt="sonarcloud" title="sonarcloud" src="https://sonarcloud.io/api/project_badges/measure?project=DogsTailFarmer_crypto-ws-api&metric=alert_status"/></a>
 <a href="https://pepy.tech/project/crypto-ws-api" target="_blank"><img alt="Downloads" title="Downloads" src="https://static.pepy.tech/badge/crypto-ws-api"/></a>
+</h1>
+
 ***
 For :heavy_check_mark:[Binance](https://accounts.binance.com/en/register?ref=FXQ6HY5O), :heavy_check_mark:[OKX](https://okx.com/join/2607649), :heavy_check_mark:[Bitfinex](https://www.bitfinex.com/sign-up?refcode=v_4az2nCP), :heavy_check_mark:[HTX](https://www.htx.com/invite/en-us/1f?invite_code=9uaw3223)
 ***

{crypto_ws_api-2.0.20 → crypto_ws_api-2.1.2}/crypto_ws_api/__init__.py

@@ -13,7 +13,7 @@ __maintainer__ = "Jerry Fedorenko"
 __contact__ = "https://github.com/DogsTailFarmer"
 __email__ = "jerry.fedorenko@yahoo.com"
 __credits__ = ["https://github.com/DanyaSWorlD"]
-__version__ = "2.0.20"
+__version__ = "2.1.2"
 
 from pathlib import Path
 import shutil

{crypto_ws_api-2.0.20 → crypto_ws_api-2.1.2}/crypto_ws_api/demo.py

@@ -43,8 +43,8 @@ async def main(account_name):
 
     # Demo method's calling
     await account_information(user_session, trade_id)
-    asyncio.ensure_future(demo_loop(user_session, get_time, trade_id, 2))
-    asyncio.ensure_future(demo_loop(user_session, current_average_price, trade_id, 3))
+    _t1 = asyncio.ensure_future(demo_loop(user_session, get_time, trade_id, 2))
+    _t2 = asyncio.ensure_future(demo_loop(user_session, current_average_price, trade_id, 3))
 
     await asyncio.sleep(20)
 
@@ -66,8 +66,6 @@ async def get_time(user_session: UserWSSession, _trade_id):
         )
         if res is None:
             logger.warning(CONST_1)
-    except asyncio.CancelledError:
-        pass  # Task cancellation should not be logged as an error
     except Exception as _ex:
         logger.error(CONST_2, _ex)
     else:
@@ -87,8 +85,6 @@ async def current_average_price(user_session: UserWSSession, _trade_id):
         )
         if res is None:
             logger.warning(CONST_1)
-    except asyncio.CancelledError:
-        pass  # Task cancellation should not be logged as an error
     except Exception as _ex:
         logger.error(CONST_2, _ex)
     else:
@@ -105,8 +101,6 @@ async def account_information(user_session: UserWSSession, _trade_id):
         )
         if res is None:
             logger.warning(CONST_1)
-    except asyncio.CancelledError:
-        pass  # Task cancellation should not be logged as an error
     except Exception as _ex:
         logger.error(CONST_2, _ex)
     else:

{crypto_ws_api-2.0.20 → crypto_ws_api-2.1.2}/crypto_ws_api/ws_api.toml.template

@@ -1,12 +1,12 @@
 # Parameters for crypto-ws-api connector
 # Copyright © 2023-2025 Jerry Fedorenko aka VM
-# __version__ = "2.0.20"
+# __version__ = "2.0.21"
 
 # region endpoint
 [endpoint]
     [endpoint.binance]
         ws_api = 'wss://ws-api.binance.com:443/ws-api/v3'
-        ws_api_test = 'wss://testnet.binance.vision/ws-api/v3'
+        ws_api_test = 'wss://ws-api.testnet.binance.vision:9443/ws-api/v3'
 # endregion
 
 # region Binance accounts

{crypto_ws_api-2.0.20 → crypto_ws_api-2.1.2}/crypto_ws_api/ws_session.py

@@ -16,6 +16,7 @@ import random
 from datetime import datetime, timezone
 from urllib.parse import urlencode, urlparse
 from cryptography.hazmat.primitives.serialization import load_pem_private_key
+import inspect
 
 from websockets.asyncio.client import connect
 from websockets import ConnectionClosed
@@ -102,6 +103,13 @@ def compose_htx_ws_auth(endpoint, exchange, api_key, api_secret):
         "params": _params
     }
 
+def tasks_manage(tasks_set: set, coro, name=None, add_done_callback=True):
+    _t = asyncio.create_task(coro, name=name or inspect.stack()[1][3])
+    tasks_set.add(_t)
+    if add_done_callback:
+        _t.add_done_callback(tasks_set.discard)
+
+
 # https://binance-docs.github.io/apidocs/websocket_api/en/#rate-limits
 class RateLimitInterval(Enum):
     SECOND = 1
@@ -159,13 +167,8 @@ class UserWSS:
         else:
             self.logger = logger
 
-    def tasks_manage(self, coro, name=None):
-        _t = asyncio.create_task(coro, name=name)
-        self.tasks.add(_t)
-        _t.add_done_callback(self.tasks.discard)
-
-    async def _ws_listener(self):
-        self.tasks_manage(self.ws_login())
+    async def _ws_listener(self):  #NOSONAR
+        tasks_manage(self.tasks, self.ws_login(), f"ws_login-{self.ws_id}")
         async for msg in self._ws:
             # logger.info(f"_ws_listener: ws_id: {self.ws_id} msg: {msg}")
             if isinstance(msg, str):
@@ -191,45 +194,47 @@ class UserWSS:
             else:
                 logger.warning(f"UserWSS: {self.ws_id}: {msg}")
                 await self.stop()
-        logger.warning(f"UserWSS: {self.ws_id}: _ws_listener stopped")
-        await self.stop()
 
     async def start_wss(self):
-        async for self._ws in connect(
-                self.endpoint,
-                logger=self.logger,
-                ping_interval=None if self.exchange in ('binance', 'huobi') else 20
-        ):
-            try:
-                await self._ws_listener()
-            except ConnectionClosed as ex:
-                if ex.rcvd and ex.rcvd.code == 4000:
-                    logger.info(f"WSS closed for {self.ws_id}")
-                    break
-                else:
-                    self.operational_status = False
-                    [task.cancel() for task in self.tasks if not task.done()]
-                    self.tasks.clear()
-                    logger.warning(f"Restart UserWSS for {self.ws_id}")
-                    continue
-            except Exception as ex:
-                logger.error(f"UserWSS start other exception: {ex}")
+        try:
+            async for self._ws in connect(
+                    self.endpoint,
+                    logger=self.logger,
+                    ping_interval=None if self.exchange in ('binance', 'huobi') else 20
+            ):
+                try:
+                    await self._ws_listener()
+                except ConnectionClosed as ex:
+                    if ex.rcvd and ex.rcvd.code == 4000:
+                        logger.info(f"WSS closed for {self.ws_id}")
+                        break
+                    else:
+                        self.operational_status = False
+                        [task.cancel() for task in self.tasks if not task.done()]
+                        self.tasks.clear()
+                        logger.warning(f"Restart UserWSS for {self.ws_id}")
+                        continue
+                except Exception as ex:
+                    logger.error(f"UserWSS start other exception: {ex}")
+        except asyncio.CancelledError:
+            await self.stop()
+            raise
 
     async def ws_login(self):
-        res = await self.request(CONST_WS_START, send_api_key=True)
+        res = await self.request(CONST_WS_START)
         if res is None:
             logger.warning(f"UserWSS: Not 'logged in' for {self.ws_id}")
             await self.stop()
         else:
             if self.exchange == 'huobi':
-                self.tasks_manage(self.htx_keepalive(), f"htx_keepalive-{self.ws_id}")
+                tasks_manage(self.tasks, self.htx_keepalive(), f"htx_keepalive-{self.ws_id}")
 
             self.operational_status = True
             self.order_handling = True
-            self.tasks_manage(self._keepalive(), f"keepalive-{self.ws_id}")
+            tasks_manage(self.tasks, self._keepalive(), f"keepalive-{self.ws_id}")
             logger.info(f"UserWSS: 'logged in' for {self.ws_id}")
 
-    async def request(self, method, _params=None, send_api_key=False, _signed=False):
+    async def request(self, method, _params=None, _signed=False):
         """
         Construct and handling request/response to WS API endpoint, use a description of the methods on
         https://developers.binance.com/docs/binance-spot-api-docs/websocket-api
@@ -245,13 +250,13 @@ class UserWSS:
             logger.warning("UserWSS: exceeded order placement limit, try later")
             return None
         params = _params.copy() if _params else None
-        r_id = f"{self.exchange}{method}{''.join(random.choices(ALPHABET, k=8))}"
+        r_id = f"{self.exchange}{method}{''.join(random.choices(ALPHABET, k=8))}"  #NOSONAR
         if self.exchange in ("okx", "bitfinex", "huobi") and method == CONST_WS_START:
             _id = self.ws_id
         else:
             _id = ''.join(e for e in r_id if e.isalnum())[-ID_LEN_LIMIT.get(self.exchange, 64):]
         await self._ws.send(
-            json.dumps(self.compose_request(_id, send_api_key, method, params, _signed))
+            json.dumps(self.compose_request(_id, method, params, _signed))
         )
         await asyncio.sleep(0)
         try:
@@ -260,8 +265,6 @@ class UserWSS:
             logger.warning(f"UserWSS: get response timeout error: {self.ws_id}")
             await self.stop()
             return None
-        except asyncio.CancelledError:
-            return None
         else:
             return res
 
@@ -275,7 +278,7 @@ class UserWSS:
                 return self._response_pool.pop(f"NoneResponse{self.ws_id}", None)
         return None
 
-    def compose_request(self, _id, send_api_key, method, params, signed):
+    def compose_request(self, _id, method, params, signed):
         if self.exchange == "binance":
             return self._compose_binance_request(_id, method, params, signed)
         elif self.exchange == "okx":
@@ -400,9 +403,10 @@ class UserWSS:
             if msg.get('code') == 200 or msg.get('status') == 'ok':
                 return msg
 
-            await self.htx_error_handle(msg)
+            self.htx_error_handle(msg)
+        return None
 
-    async def htx_error_handle(self, msg):
+    def htx_error_handle(self, msg):
         if msg.get('code') == 500:
             logger.warning(f"An issue occurred on exchange's side: {msg}")
         elif msg.get('code') in {429, 4000}:
@@ -526,7 +530,6 @@ class UserWSSession:
         trade_id: str,
         method: str,
         _params=None,
-        send_api_key=False,
         _signed=False,
     ):
 
@@ -553,9 +556,7 @@ class UserWSSession:
         if user_wss.init:
             user_wss.init = False
             user_wss.operational_status = False
-            _t = asyncio.create_task(user_wss.start_wss())
-            self.tasks_wss.add(_t)
-            _t.add_done_callback(self.tasks_wss.discard)
+            tasks_manage(self.tasks_wss, user_wss.start_wss(), f"start_wss-{ws_id}")
 
         duration = 0
         while not (user_wss.operational_status and user_wss.order_handling):
@@ -566,8 +567,8 @@ class UserWSSession:
             duration += DELAY
 
         try:
-            return await user_wss.request(method=method, _params=_params, send_api_key=send_api_key, _signed=_signed)
-        except asyncio.CancelledError:
+            return await user_wss.request(method=method, _params=_params, _signed=_signed)
+        except KeyboardInterrupt:
             pass  # Task cancellation should not be logged as an error
         except Exception as ex:
             logger.error(f"crypto_ws_api.ws_session.handle_request(): {ex}")

{crypto_ws_api-2.0.20 → crypto_ws_api-2.1.2}/pyproject.toml

@@ -18,11 +18,11 @@ requires-python = ">=3.10"
 
 dependencies = [
     "shortuuid~=1.0.13",
-    "platformdirs==4.3.6",
+    "platformdirs==4.3.8",
     "toml~=0.10.2",
     "websockets==15.0.1",
     "ujson~=5.10.0",
-    "cryptography~=44.0.2"
+    "cryptography~=45.0.6"
 ]
 
 [tool.flit.module]

{crypto_ws_api-2.0.20 → crypto_ws_api-2.1.2}/requirements.txt

@@ -1,6 +1,6 @@
 shortuuid~=1.0.13
-platformdirs==4.3.6
+platformdirs==4.3.8
 toml~=0.10.2
 websockets==15.0.1
 ujson~=5.10.0
-cryptography~=44.0.2
+cryptography~=45.0.6