trd-utils 0.0.31__tar.gz → 0.0.33__tar.gz

{trd_utils-0.0.31 → trd_utils-0.0.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: trd_utils
-Version: 0.0.31
+Version: 0.0.33
 Summary: Common Basic Utils for Python3. By ALiwoto.
 Keywords: utils,trd_utils,basic-utils,common-utils
 Author: ALiwoto

{trd_utils-0.0.31 → trd_utils-0.0.33}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "trd_utils"
-version = "0.0.31"
+version = "0.0.33"
 description = "Common Basic Utils for Python3. By ALiwoto."
 authors = ["ALiwoto <aminnimaj@gmail.com>"]
 packages = [

trd_utils-0.0.33/trd_utils/__init__.py

@@ -0,0 +1,3 @@
+
+__version__ = "0.0.33"
+

{trd_utils-0.0.31 → trd_utils-0.0.33}/trd_utils/exchanges/bx_ultra/bx_types.py

@@ -4,6 +4,7 @@ from datetime import datetime, timedelta
 import pytz
 
 from trd_utils.exchanges.errors import ExchangeError
+from trd_utils.exchanges.price_fetcher import MinimalCandleInfo
 from trd_utils.types_helper import BaseModel
 
 from trd_utils.common_utils.float_utils import (
@@ -1239,22 +1240,7 @@ class CreateOrderDelegationResponse(BxApiResponse):
 # region candle types
 
 
-class SingleCandleInfo(BaseModel):
-    # The pair in format of BTC/USDT.
-    pair: str = None
-
-    # This candle's open price.
-    open_price: Decimal = None
-
-    # The close price.
-    close_price: Decimal = None
-
-    # volume in the first pair (e.g. BTC).
-    volume: Decimal = None
-
-    # volume in the second part of the pair (e.g. USDT).
-    quote_volume: Decimal = None
-
+class SingleCandleInfo(MinimalCandleInfo):
     @staticmethod
     def deserialize_short(data: dict) -> "SingleCandleInfo":
         info = SingleCandleInfo()

{trd_utils-0.0.31 → trd_utils-0.0.33}/trd_utils/exchanges/bx_ultra/bx_ultra_client.py

@@ -52,6 +52,7 @@ from trd_utils.cipher import AESCipher
 
 from trd_utils.exchanges.errors import ExchangeError
 from trd_utils.exchanges.exchange_base import ExchangeBase, JWTManager
+from trd_utils.exchanges.price_fetcher import IPriceFetcher
 
 PLATFORM_ID_ANDROID = "10"
 PLATFORM_ID_WEB = "30"
@@ -78,7 +79,7 @@ logger = logging.getLogger(__name__)
 user_api_identity_cache: dict[int, int] = {}
 
 
-class BXUltraClient(ExchangeBase):
+class BXUltraClient(ExchangeBase, IPriceFetcher):
     ###########################################################
     # region client parameters
     we_api_base_host: str = "\u0061pi-\u0061pp.w\u0065-\u0061pi.com"
@@ -295,9 +296,23 @@ class BXUltraClient(ExchangeBase):
             "traceId": self.trace_id,
         }
         url = f"{self.ws_we_api_base_url}?{urlencode(params, doseq=True)}"
+        while True:
+            try:
+                await self._do_price_ws(
+                    url=url,
+                )
+            except Exception as ex:
+                err_str = f"{ex}"
+                if err_str.find("Event loop is closed") != -1:
+                    # just return
+                    return
+
+                logger.warning(f"error at _do_price_ws: {err_str}")
+
+    async def _do_price_ws(self, url: str):
         async with websockets.connect(url, ping_interval=None) as ws:
             await self._internal_lock.acquire()
-            self.ws_connections.append(ws)
+            self.price_ws_connection = ws
             self._internal_lock.release()
 
             await ws.send(json.dumps({
@@ -308,48 +323,54 @@ class BXUltraClient(ExchangeBase):
             async for msg in ws:
                 try:
                     decompressed_message = gzip.decompress(msg)
-                    if decompressed_message.lower() == "ping":
-                        await ws.send("Pong")
-                        continue
-
-                    data: dict = json.loads(decompressed_message, parse_float=Decimal)
-                    if not isinstance(data, dict):
-                        logger.warning(f"invalid data instance: {type(data)}")
-                        continue
-
-                    if data.get("code", 0) == 0 and data.get("data", None) is None:
-                        # it's all fine
-                        continue
-
-                    if data.get("ping", None):
-                        target_id = data["ping"]
-                        target_time = data.get(
-                            "time",
-                            datetime.now(
-                                timezone(timedelta(hours=8))
-                            ).isoformat(timespec="seconds")
-                        )
-                        await ws.send(json.dumps({
-                            "pong": target_id,
-                            "time": target_time,
-                        }))
-                        continue
-
-                    inner_data = data.get("data", None)
-                    if isinstance(inner_data, dict):
-                        if data.get("dataType", None) == "swap.market.v2.contracts":
-                            list_data = inner_data.get("l", None)
-                            await self.__last_candle_lock.acquire()
-                            for current in list_data:
-                                info = SingleCandleInfo.deserialize_short(current)
-                                if info:
-                                    self.__last_candle_storage[info.pair.lower()] = info
-                            self.__last_candle_lock.release()
-                        continue
-
-                    logger.info(f"we got some unknown data: {data}")
+                    str_msg = decompressed_message.decode("utf-8")
+                    await self._handle_price_ws_msg(
+                        str_msg=str_msg,
+                    )
                 except Exception as ex:
                     logger.info(f"failed to handle ws message from exchange: {msg}; {ex}")
+
+    async def _handle_price_ws_msg(self, str_msg: str):
+        if str_msg.lower() == "ping":
+            await self.price_ws_connection.send("Pong")
+            return
+
+        data: dict = json.loads(str_msg, parse_float=Decimal)
+        if not isinstance(data, dict):
+            logger.warning(f"invalid data instance: {type(data)}")
+            return
+
+        if data.get("code", 0) == 0 and data.get("data", None) is None:
+            # it's all fine
+            return
+
+        if data.get("ping", None):
+            target_id = data["ping"]
+            target_time = data.get(
+                "time",
+                datetime.now(
+                    timezone(timedelta(hours=8))
+                ).isoformat(timespec="seconds")
+            )
+            await self.price_ws_connection.send(json.dumps({
+                "pong": target_id,
+                "time": target_time,
+            }))
+            return
+
+        inner_data = data.get("data", None)
+        if isinstance(inner_data, dict):
+            if data.get("dataType", None) == "swap.market.v2.contracts":
+                list_data = inner_data.get("l", None)
+                await self.__last_candle_lock.acquire()
+                for current in list_data:
+                    info = SingleCandleInfo.deserialize_short(current)
+                    if info:
+                        self.__last_candle_storage[info.pair.lower()] = info
+                self.__last_candle_lock.release()
+            return
+
+        logger.info(f"we got some unknown data: {data}")
     
     async def get_last_candle(self, pair: str) -> SingleCandleInfo:
         """

{trd_utils-0.0.31 → trd_utils-0.0.33}/trd_utils/exchanges/exchange_base.py

@@ -62,8 +62,8 @@ class ExchangeBase(ABC):
     # extra tasks to be cancelled when the client closes.
     extra_tasks: list[asyncio.Task] = None
 
-    # the ws connections to be closed when this client is closed.
-    ws_connections: list[WSConnection] = None
+    # the price ws connection to be closed when this client is closed.
+    price_ws_connection: WSConnection = None
     # endregion
     ###########################################################
     # region constructor method
@@ -71,7 +71,6 @@ class ExchangeBase(ABC):
     def __init__(self):
         self._internal_lock = asyncio.Lock()
         self.extra_tasks = []
-        self.ws_connections = []
 
     # endregion
     ###########################################################
@@ -228,14 +227,11 @@ class ExchangeBase(ABC):
         await self._internal_lock.acquire()
         await self.httpx_client.aclose()
 
-        if self.ws_connections:
-            for current in self.ws_connections:
-                try:
-                    await current.close()
-                except Exception as ex:
-                    logger.warning(f"failed to close ws connection: {ex}")
-                    continue
-            self.ws_connections = []
+        if self.price_ws_connection:
+            try:
+                await self.price_ws_connection.close()
+            except Exception as ex:
+                logger.warning(f"failed to close ws connection: {ex}")
 
         self._internal_lock.release()
 

trd_utils-0.0.33/trd_utils/exchanges/price_fetcher.py

@@ -0,0 +1,38 @@
+
+
+from decimal import Decimal
+from trd_utils.types_helper import BaseModel
+
+
+class MinimalCandleInfo(BaseModel):
+    # The pair in format of BTC/USDT.
+    pair: str = None
+
+    # This candle's open price.
+    open_price: Decimal = None
+
+    # The close price.
+    close_price: Decimal = None
+
+    # volume in the first pair (e.g. BTC).
+    volume: Decimal = None
+
+    # volume in the second part of the pair (e.g. USDT).
+    quote_volume: Decimal = None
+
+
+class IPriceFetcher:
+    """
+    The IPriceFetcher class acts as an interface for classes that support
+    fetching last candle of a specific pair, without any specific floodwait or
+    ratelimit applied on the method itself (because e.g. they are fetching it
+    through a background websocket connection).
+    Please do not use this class directly, instead use a class that inherits
+    and implements the methods of this class (e.g. one of the exchange classes).
+    """
+
+    async def do_price_subscribe(self) -> None:
+        pass
+
+    async def get_last_candle(self, pair: str) -> MinimalCandleInfo:
+        pass

trd_utils-0.0.31/trd_utils/__init__.py

@@ -1,3 +0,0 @@
-
-__version__ = "0.0.31"
-