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

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

@@ -1,3 +1,13 @@
+## 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.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: crypto-ws-api
-Version: 2.0.20
+Version: 2.1.0
 Summary: Crypto WS API connector for ASYNC requests
 Author-email: Jerry Fedorenko <jerry.fedorenko@yahoo.com>
 Requires-Python: >=3.10
@@ -26,12 +26,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.0}/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.0}/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.0"
 
 from pathlib import Path
 import shutil

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

@@ -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.0}/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.0}/crypto_ws_api/ws_session.py

@@ -191,32 +191,34 @@ 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()
@@ -229,7 +231,7 @@ class UserWSS:
             self.tasks_manage(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
@@ -251,7 +253,7 @@ class UserWSS:
         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 +262,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 +275,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 +400,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 +527,6 @@ class UserWSSession:
         trade_id: str,
         method: str,
         _params=None,
-        send_api_key=False,
         _signed=False,
     ):
 
@@ -566,8 +566,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}")