trd-utils 0.0.32__py3-none-any.whl → 0.0.33__py3-none-any.whl

trd_utils/__init__.py

@@ -1,3 +1,3 @@
 
-__version__ = "0.0.32"
+__version__ = "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/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({
@@ -309,48 +324,53 @@ class BXUltraClient(ExchangeBase):
                 try:
                     decompressed_message = gzip.decompress(msg)
                     str_msg = decompressed_message.decode("utf-8")
-                    if str_msg.lower() == "ping":
-                        await ws.send("Pong")
-                        continue
-
-                    data: dict = json.loads(str_msg, 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}")
+                    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/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/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.32.dist-info → trd_utils-0.0.33.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: trd_utils
-Version: 0.0.32
+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.32.dist-info → trd_utils-0.0.33.dist-info}/RECORD

@@ -1,4 +1,4 @@
-trd_utils/__init__.py,sha256=5mjXdrdRYpXTN4Y1ocvl6aDC56jkrCDAO1vGFM9PsPw,25
+trd_utils/__init__.py,sha256=nSoM18hDJ2GE427yOVowkSYX38d1GPSj8rG7RKp-egI,25
 trd_utils/cipher/__init__.py,sha256=V05KNuzQwCic-ihMVHlC8sENaJGc3I8MCb4pg4849X8,1765
 trd_utils/common_utils/float_utils.py,sha256=aYPwJ005LmrRhXAngojwvdDdtRgeb1FfR6hKeQ5ndMU,470
 trd_utils/common_utils/wallet_utils.py,sha256=OX9q2fymP0VfIWTRIRBP8W33cfyjLXimxMgPOsZe-3g,727
@@ -11,11 +11,11 @@ trd_utils/exchanges/blofin/__init__.py,sha256=X4r9o4Nyjla4UeOBG8lrgtnGYO2aErFMKa
 trd_utils/exchanges/blofin/blofin_client.py,sha256=RJcyET62cjxczEdHqQ-Cy6CT8veJYio_efublNBvEo8,12378
 trd_utils/exchanges/blofin/blofin_types.py,sha256=ZlHX1ClYTd2pDRTQIlZYyBu5ReGpMgxXxKASsPeBQug,4090
 trd_utils/exchanges/bx_ultra/__init__.py,sha256=8Ssy-eOemQR32Nv1-FoPHm87nRqRO4Fm2PU5GHEFKfQ,80
-trd_utils/exchanges/bx_ultra/bx_types.py,sha256=qg_MoaZRpfRf29Eh-W0JXUklQWt5ckoP-Ktk4faX9io,34985
-trd_utils/exchanges/bx_ultra/bx_ultra_client.py,sha256=w4VNjNjp5h-GLRMheWl8uU_KPWL7FrhV5TwbfQiyo3A,34432
+trd_utils/exchanges/bx_ultra/bx_types.py,sha256=hRe8DfF3sdXlMdk-knwWx4XpZUp1rITpXPnUDtiy93o,34715
+trd_utils/exchanges/bx_ultra/bx_ultra_client.py,sha256=Wdfg34goiMeJEGd5T-thouXEC_2Gacs8ixiSJ0rcojg,34726
 trd_utils/exchanges/bx_ultra/bx_utils.py,sha256=PwapomwDW33arVmKIDj6cL-aP0ptu4BYy_lOCqSAPOo,1392
 trd_utils/exchanges/errors.py,sha256=P_NTuc389XL7rFegomP59BydWmHv8ckiGyNU-_l5qNQ,167
-trd_utils/exchanges/exchange_base.py,sha256=c9SV-XyZNonbPa8DDujHGSF4CR-iweGUojsPGvphjlU,7909
+trd_utils/exchanges/exchange_base.py,sha256=wJV966YYw6BQnB7hr9Cgy3a4FHg8_jyWeaidJgzCA7Q,7772
 trd_utils/exchanges/hyperliquid/README.md,sha256=-qaxmDt_9NTus2xRuzyFGkKgYDWgWk7ufHVTSkyn3t4,105
 trd_utils/exchanges/hyperliquid/__init__.py,sha256=QhwGRcneGFHREM-MMdYpbcx-aWdsWsu2WznHzx7LaUM,92
 trd_utils/exchanges/hyperliquid/hyperliquid_client.py,sha256=FOOEDY1wOvyDlUcnSHf0Vp-8KNK2_AkI6Z7h3lls3Co,6832
@@ -23,6 +23,7 @@ trd_utils/exchanges/hyperliquid/hyperliquid_types.py,sha256=MiGG5fRU7wHqOMtCzQXD
 trd_utils/exchanges/okx/__init__.py,sha256=OjVpvcwB9mrCTofLt14JRHV2-fMAzGz9-YkJAMwl6dM,67
 trd_utils/exchanges/okx/okx_client.py,sha256=lUf507ovd4D3fI7Z3Iy1fGvxNJWdm4wTcdzTCkMw13U,7146
 trd_utils/exchanges/okx/okx_types.py,sha256=IkFOfgivcvvIw950jyGHAVfFFGbGqfZcYGfZLWfNLvc,5013
+trd_utils/exchanges/price_fetcher.py,sha256=Jjrlnis-9fFOYR-7T8T0Dkzi63gSN7gSLkehjbbldEg,1074
 trd_utils/html_utils/__init__.py,sha256=1WWs8C7JszRjTkmzIRLHpxWECHur_DrulTPGIeX88oM,426
 trd_utils/html_utils/html_formats.py,sha256=unKsvOiiDmYTTaM0DYZEUNLEUzWQKKrqASJXvY54kvU,2299
 trd_utils/tradingview/__init__.py,sha256=H0QYb-O5qvy7qC3yswtlcSWLmeBnaS6oJ3JtjvmaV_Y,154
@@ -30,7 +31,7 @@ trd_utils/tradingview/tradingview_client.py,sha256=g_eWYaCRQAL8Kvd-r6AnAdbH7Jha6
 trd_utils/tradingview/tradingview_types.py,sha256=z21MXPVdWHAduEl3gSeMIRhxtBN9yK-jPYHfZSMIbSA,6144
 trd_utils/types_helper/__init__.py,sha256=lLbUiW1jUV1gjzTMFLthwkvF0hwauH-F_J2JZq--1U0,67
 trd_utils/types_helper/base_model.py,sha256=Q2KK0r4UXP9PlWeIl6nxdAeCGB5InU5IkTNGAfJasfM,11808
-trd_utils-0.0.32.dist-info/LICENSE,sha256=J1EP2xt87RjjmsTV1jTjHDQMLIM9FjdwEftTpw8hyv4,1067
-trd_utils-0.0.32.dist-info/METADATA,sha256=iqiiINJSXF-3P6x455gGj8HLQYJ-Qx6mKXl-HFBMe_A,1179
-trd_utils-0.0.32.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-trd_utils-0.0.32.dist-info/RECORD,,
+trd_utils-0.0.33.dist-info/LICENSE,sha256=J1EP2xt87RjjmsTV1jTjHDQMLIM9FjdwEftTpw8hyv4,1067
+trd_utils-0.0.33.dist-info/METADATA,sha256=6L4kyCagWXrwlvxY_4mSpmd2c-8bqpBSVBu72_d7LJI,1179
+trd_utils-0.0.33.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+trd_utils-0.0.33.dist-info/RECORD,,