trd-utils 0.0.40__tar.gz → 0.0.42__tar.gz

{trd_utils-0.0.40 → trd_utils-0.0.42}/PKG-INFO

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

{trd_utils-0.0.40 → trd_utils-0.0.42}/pyproject.toml

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

trd_utils-0.0.42/trd_utils/__init__.py

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

{trd_utils-0.0.40 → trd_utils-0.0.42}/trd_utils/exchanges/base_types.py

@@ -50,6 +50,34 @@ class UnifiedPositionInfo(BaseModel):
     # not all exchanges support this yet, so use it with caution.
     last_volume: Decimal | None = None
 
+    def recalculate_pnl(self) -> tuple[Decimal, Decimal]:
+        """
+        Recalculates the PnL based on the available data.
+        This requires `last_price`, `open_price`, `initial_margin`,
+        and `position_leverage` to be set.
+
+        Returns:
+            The recalculated (PnL, percentage) as a Decimal, or None if calculation
+            is not possible with the current data.
+        """
+        if not self.position_leverage:
+            self.position_leverage = 1
+
+        if not all([self.last_price, self.open_price, self.initial_margin]):
+            # Not enough data to calculate PnL.
+            return None
+
+        price_change_percentage = (self.last_price - self.open_price) / self.open_price
+        if self.position_side == "SHORT":
+            # For a short position, profit is made when the price goes down.
+            price_change_percentage *= -1
+
+        pnl_percentage = self.position_leverage * price_change_percentage
+        # PnL = Initial Margin * Leverage * Price Change %
+        pnl = self.initial_margin * pnl_percentage
+        self.position_pnl = pnl
+        return (pnl, pnl_percentage)
+
     def __str__(self):
         parts = []
 

{trd_utils-0.0.40 → trd_utils-0.0.42}/trd_utils/exchanges/blofin/blofin_client.py

@@ -323,6 +323,8 @@ class BlofinClient(ExchangeBase):
     async def get_unified_trader_positions(
         self,
         uid: int | str,
+        no_warn: bool = False,
+        min_margin: Decimal = 0,
     ) -> UnifiedTraderPositions:
         result = await self.get_copy_trader_all_order_list(
             uid=uid,
@@ -343,6 +345,12 @@ class BlofinClient(ExchangeBase):
             unified_pos.open_price = position.avg_open_price
             unified_pos.open_price_unit = position.symbol.split("-")[-1]
             unified_pos.initial_margin = position.get_initial_margin()
+            if min_margin and (
+                not unified_pos.initial_margin
+                or unified_pos.initial_margin < min_margin
+            ):
+                continue
+
             unified_result.positions.append(unified_pos)
 
         return unified_result

{trd_utils-0.0.40 → trd_utils-0.0.42}/trd_utils/exchanges/bx_ultra/bx_ultra_client.py

@@ -83,7 +83,8 @@ class BXUltraClient(ExchangeBase, IPriceFetcher):
     # region client parameters
     we_api_base_host: str = "\u0061pi-\u0061pp.w\u0065-\u0061pi.com"
     we_api_base_url: str = "https://\u0061pi-\u0061pp.w\u0065-\u0061pi.com/\u0061pi"
-    ws_we_api_base_url: str = "wss://ws-market-swap.w\u0065-\u0061pi.com/ws"
+    ws_we_api_base_url: str = "wss://ws-market-sw\u0061p.w\u0065-\u0061pi.com/ws"
+    f_ws_we_api_base_url: str = "wss://f-ws-\u0061pp.w\u0065-\u0061pi.com/market"
     original_base_host: str = "https://\u0062ing\u0078.co\u006d"
     qq_os_base_host: str = "https://\u0061pi-\u0061pp.\u0071\u0071-os.com"
     qq_os_base_url: str = "https://\u0061pi-\u0061pp.\u0071\u0071-os.com/\u0061pi"
@@ -283,7 +284,7 @@ class BXUltraClient(ExchangeBase, IPriceFetcher):
 
     # endregion
     ###########################################################
-    # region ws-subscribes
+    # region ws last-candle methods
     async def do_price_subscribe(self) -> None:
         """
         Subscribes to the price changes coming from the exchange.
@@ -919,6 +920,7 @@ class BXUltraClient(ExchangeBase, IPriceFetcher):
         uid: int | str,
         api_identity: int | str | None = None,
         no_warn: bool = False,
+        min_margin: Decimal = 0,
     ) -> UnifiedTraderPositions:
         perp_positions = []
         std_positions = []
@@ -929,26 +931,38 @@ class BXUltraClient(ExchangeBase, IPriceFetcher):
             result = await self.get_unified_trader_positions_perp(
                 uid=uid,
                 api_identity=api_identity,
+                min_margin=min_margin,
             )
             perp_positions = result.positions
         except Exception as ex:
+            err_str = f"{ex}"
+            if err_str.find("as the client has been closed") != -1:
+                raise ex
+
             if not no_warn:
-                perp_ex = f"{ex}"
+                logger.warning(f"Failed to fetch perp positions of {uid}: {ex}")
+            perp_ex = ex
 
         try:
             result = await self.get_unified_trader_positions_std(
                 uid=uid,
+                min_margin=min_margin,
             )
             std_positions = result.positions
         except Exception as ex:
+            err_str = f"{ex}"
+            if err_str.find("as the client has been closed") != -1:
+                raise ex
+
             if not no_warn:
-                std_ex = f"{ex}"
+                logger.warning(f"Failed to fetch std positions of {uid}: {ex}")
+            std_ex = ex
 
         if not perp_positions and not std_positions:
-            if perp_ex:
-                logger.warning(f"Failed to fetch perp positions of {uid}: {perp_ex}")
-            if std_ex:
-                logger.warning(f"Failed to fetch std positions of {uid}: {std_ex}")
+            if perp_ex or std_ex:
+                raise RuntimeError(
+                    f"Failed to fetch both std and perp positions: perp: {perp_ex}; std: {std_ex}"
+                )
 
         unified_result = UnifiedTraderPositions()
         unified_result.positions = perp_positions + std_positions
@@ -959,6 +973,7 @@ class BXUltraClient(ExchangeBase, IPriceFetcher):
         uid: int | str,
         api_identity: int | str | None = None,
         sub_account_filter: str = "futures",
+        min_margin: Decimal = 0,
     ) -> UnifiedTraderPositions:
         if not api_identity:
             api_identity = await self.get_trader_api_identity(
@@ -987,6 +1002,9 @@ class BXUltraClient(ExchangeBase, IPriceFetcher):
         unified_result = UnifiedTraderPositions()
         unified_result.positions = []
         for position in result.data.positions:
+            if min_margin and (not position.margin or position.margin < min_margin):
+                continue
+
             unified_pos = UnifiedPositionInfo()
             unified_pos.position_id = position.position_no
             unified_pos.position_pnl = position.unrealized_pnl
@@ -1018,6 +1036,7 @@ class BXUltraClient(ExchangeBase, IPriceFetcher):
         page_offset: int = 0,
         page_size: int = 50,
         delay_amount: float = 1,
+        min_margin: Decimal = 0,
     ) -> UnifiedTraderPositions:
         unified_result = UnifiedTraderPositions()
         unified_result.positions = []
@@ -1040,6 +1059,9 @@ class BXUltraClient(ExchangeBase, IPriceFetcher):
                     )
 
                 for position in result.data.positions:
+                    if min_margin and (not position.margin or position.margin < min_margin):
+                        continue
+
                     unified_pos = UnifiedPositionInfo()
                     unified_pos.position_id = position.order_no
                     unified_pos.position_pnl = (

{trd_utils-0.0.40 → trd_utils-0.0.42}/trd_utils/exchanges/exchange_base.py

@@ -16,14 +16,15 @@ from trd_utils.types_helper.base_model import BaseModel
 
 logger = logging.getLogger(__name__)
 
-class JWTManager():
+
+class JWTManager:
     _jwt_string: str = None
 
     def __init__(self, jwt_string: str):
         self._jwt_string = jwt_string
         try:
-            payload_b64 = self._jwt_string.split('.')[1]
-            payload_bytes = base64.urlsafe_b64decode(payload_b64 + '==')
+            payload_b64 = self._jwt_string.split(".")[1]
+            payload_bytes = base64.urlsafe_b64decode(payload_b64 + "==")
             self.payload = json.loads(payload_bytes)
         except Exception:
             self.payload = {}
@@ -31,9 +32,10 @@ class JWTManager():
     def is_expired(self):
         if "exp" not in self.payload:
             return False
-        
+
         return time.time() > self.payload["exp"]
 
+
 class ExchangeBase(ABC):
     ###########################################################
     # region client parameters
@@ -82,6 +84,8 @@ class ExchangeBase(ABC):
     async def get_unified_trader_positions(
         self,
         uid: int | str,
+        no_warn: bool = False,
+        min_margin: Decimal = 0,
     ) -> UnifiedTraderPositions:
         """
         Returns the unified version of all currently open positions of the specific

{trd_utils-0.0.40 → trd_utils-0.0.42}/trd_utils/exchanges/hyperliquid/hyperliquid_client.py

@@ -1,4 +1,3 @@
-
 from datetime import datetime
 from decimal import Decimal
 import json
@@ -11,9 +10,15 @@ import pytz
 
 from trd_utils.cipher import AESCipher
 from trd_utils.common_utils.wallet_utils import shorten_wallet_address
-from trd_utils.exchanges.base_types import UnifiedPositionInfo, UnifiedTraderInfo, UnifiedTraderPositions
+from trd_utils.exchanges.base_types import (
+    UnifiedPositionInfo,
+    UnifiedTraderInfo,
+    UnifiedTraderPositions,
+)
 from trd_utils.exchanges.exchange_base import ExchangeBase
-from trd_utils.exchanges.hyperliquid.hyperliquid_types import TraderPositionsInfoResponse
+from trd_utils.exchanges.hyperliquid.hyperliquid_types import (
+    TraderPositionsInfoResponse,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -75,7 +80,7 @@ class HyperLiquidClient(ExchangeBase):
             model_type=TraderPositionsInfoResponse,
         )
 
-    #endregion
+    # endregion
     ###########################################################
     # region another-thing
     # async def get_another_thing_info(self, uid: int) -> AnotherThingInfoResponse:
@@ -151,6 +156,8 @@ class HyperLiquidClient(ExchangeBase):
     async def get_unified_trader_positions(
         self,
         uid: int | str,
+        no_warn: bool = False,
+        min_margin: Decimal = 0,
     ) -> UnifiedTraderPositions:
         result = await self.get_trader_positions_info(
             uid=uid,
@@ -159,6 +166,11 @@ class HyperLiquidClient(ExchangeBase):
         unified_result.positions = []
         for position_container in result.asset_positions:
             position = position_container.position
+            if min_margin and (
+                not position.margin_used or position.margin_used < min_margin
+            ):
+                continue
+
             unified_pos = UnifiedPositionInfo()
             unified_pos.position_id = position.get_position_id()
             unified_pos.position_pnl = round(position.unrealized_pnl, 3)
@@ -166,7 +178,9 @@ class HyperLiquidClient(ExchangeBase):
             unified_pos.margin_mode = position.leverage.type
             unified_pos.position_leverage = Decimal(position.leverage.value)
             unified_pos.position_pair = f"{position.coin}/USDT"
-            unified_pos.open_time = datetime.now(pytz.UTC) # hyperliquid doesn't provide this...
+            unified_pos.open_time = datetime.now(
+                pytz.UTC
+            )  # hyperliquid doesn't provide this...
             unified_pos.open_price = position.entry_px
             unified_pos.open_price_unit = "USDT"
             unified_pos.initial_margin = position.margin_used

trd_utils-0.0.42/trd_utils/types_helper/__init__.py

@@ -0,0 +1,11 @@
+
+from .ultra_list import UltraList
+from .base_model import BaseModel
+from .decorators import ignore_json_fields
+
+
+__all__ = [
+    "UltraList",
+    "BaseModel",
+    "ignore_json_fields",
+]

{trd_utils-0.0.40 → trd_utils-0.0.42}/trd_utils/types_helper/base_model.py

@@ -3,7 +3,6 @@ from decimal import Decimal
 import json
 from typing import (
     Union,
-    get_type_hints,
     Any,
     get_args as get_type_args,
 )
@@ -12,6 +11,9 @@ import dateutil.parser
 
 from trd_utils.date_utils.datetime_helpers import dt_from_ts, dt_to_ts
 from trd_utils.html_utils.html_formats import camel_to_snake
+from trd_utils.types_helper.model_config import ModelConfig
+from trd_utils.types_helper.ultra_list import convert_to_ultra_list
+from trd_utils.types_helper.utils import AbstractModel, get_my_field_types
 
 # Whether to use ultra-list instead of normal python list or not.
 # This might be convenient in some cases, but it is not recommended
@@ -24,27 +26,11 @@ ULTRA_LIST_ENABLED: bool = False
 # attribute names are converted to snake_case.
 SET_CAMEL_ATTR_NAMES = False
 
-
-def get_my_field_types(cls):
-    type_hints = {}
-    for current_cls in cls.__class__.__mro__:
-        if current_cls is object or current_cls is BaseModel:
-            break
-        type_hints.update(get_type_hints(current_cls))
-    return type_hints
-
-
-def get_real_attr(cls, attr_name):
-    if cls is None:
-        return None
-
-    if isinstance(cls, dict):
-        return cls.get(attr_name, None)
-
-    if hasattr(cls, attr_name):
-        return getattr(cls, attr_name)
-
-    return None
+# The _model_config is a special field which cannot get serialized
+# nor can it get deserialized.
+SPECIAL_FIELDS = [
+    "_model_config",
+]
 
 
 def is_base_model_type(expected_type: type) -> bool:
@@ -176,41 +162,13 @@ def generic_obj_to_value(
     raise TypeError(f"unsupported type: {type(value)}")
 
 
-class UltraList(list):
-    def __getattr__(self, attr):
-        if len(self) == 0:
-            return None
-        return UltraList([get_real_attr(item, attr) for item in self])
+class BaseModel(AbstractModel):
+    _model_config: ModelConfig = None
 
-
-def convert_to_ultra_list(value: Any) -> UltraList:
-    if not value:
-        return UltraList()
-
-    # Go through all fields of the value and convert them to
-    # UltraList if they are lists
-
-    try:
-        if isinstance(value, list):
-            return UltraList([convert_to_ultra_list(item) for item in value])
-        elif isinstance(value, dict):
-            return {k: convert_to_ultra_list(v) for k, v in value.items()}
-        elif isinstance(value, tuple):
-            return tuple(convert_to_ultra_list(v) for v in value)
-        elif isinstance(value, set):
-            return {convert_to_ultra_list(v) for v in value}
-
-        for attr, attr_value in get_my_field_types(value).items():
-            if isinstance(attr_value, list):
-                setattr(value, attr, convert_to_ultra_list(getattr(value, attr)))
-
-        return value
-    except Exception:
-        return value
-
-
-class BaseModel:
     def __init__(self, **kwargs):
+        if not self._model_config:
+            self._model_config = ModelConfig()
+
         annotations = get_my_field_types(self)
         for key, value in kwargs.items():
             corrected_key = key
@@ -222,6 +180,12 @@ class BaseModel:
                     annotations[key] = Any
                     annotations[corrected_key] = Any
 
+            if corrected_key in SPECIAL_FIELDS or (
+                self._model_config.ignored_fields
+                and corrected_key in self._model_config.ignored_fields
+            ):
+                continue
+
             expected_type = annotations[corrected_key]
             if hasattr(self, "_get_" + corrected_key + "_type"):
                 try:
@@ -344,13 +308,19 @@ class BaseModel:
         annotations = get_my_field_types(self)
         result_dict = {}
         for key, _ in annotations.items():
-            if not isinstance(key, str):
+            if not isinstance(key, str) or key in SPECIAL_FIELDS:
                 continue
 
             if key.startswith("__") or key.startswith(f"_{self.__class__.__name__}__"):
                 # ignore private attributes
                 continue
 
+            if (
+                self._model_config.ignored_fields
+                and key in self._model_config.ignored_fields
+            ):
+                continue
+
             normalized_value = value_to_normal_obj(
                 value=getattr(self, key),
                 omit_none=omit_none,

trd_utils-0.0.42/trd_utils/types_helper/decorators.py

@@ -0,0 +1,20 @@
+
+from typing import Type, TypeVar
+
+from trd_utils.types_helper.model_config import ModelConfig
+from trd_utils.types_helper.utils import AbstractModel
+
+
+T = TypeVar('T', bound=AbstractModel)
+
+def ignore_json_fields(fields: list[str]):
+    def wrapper(cls: Type[T]) -> Type[T]:
+        config = getattr(cls, "_model_config", None)
+        if not config:
+            config = ModelConfig()
+        
+        config.ignored_fields = fields.copy()
+        setattr(cls, "_model_config", config)
+        return cls
+    return wrapper
+

trd_utils-0.0.42/trd_utils/types_helper/model_config.py

@@ -0,0 +1,6 @@
+
+
+class ModelConfig:
+    ignored_fields: list[str] = None
+
+

trd_utils-0.0.42/trd_utils/types_helper/ultra_list.py

@@ -0,0 +1,40 @@
+
+
+from typing import Any
+from trd_utils.types_helper.utils import get_my_field_types, get_real_attr
+
+
+class UltraList(list):
+    def __getattr__(self, attr):
+        if len(self) == 0:
+            return None
+        return UltraList([get_real_attr(item, attr) for item in self])
+
+
+def convert_to_ultra_list(value: Any) -> UltraList:
+    if not value:
+        return UltraList()
+
+    # Go through all fields of the value and convert them to
+    # UltraList if they are lists
+
+    try:
+        if isinstance(value, list):
+            return UltraList([convert_to_ultra_list(item) for item in value])
+        elif isinstance(value, dict):
+            return {k: convert_to_ultra_list(v) for k, v in value.items()}
+        elif isinstance(value, tuple):
+            return tuple(convert_to_ultra_list(v) for v in value)
+        elif isinstance(value, set):
+            return {convert_to_ultra_list(v) for v in value}
+
+        for attr, attr_value in get_my_field_types(value).items():
+            if isinstance(attr_value, list):
+                setattr(value, attr, convert_to_ultra_list(getattr(value, attr)))
+
+        return value
+    except Exception:
+        return value
+
+
+

trd_utils-0.0.42/trd_utils/types_helper/utils.py

@@ -0,0 +1,28 @@
+from typing import (
+    get_type_hints,
+)
+
+class AbstractModel:
+    pass
+
+def get_real_attr(cls, attr_name):
+    if cls is None:
+        return None
+
+    if isinstance(cls, dict):
+        return cls.get(attr_name, None)
+
+    if hasattr(cls, attr_name):
+        return getattr(cls, attr_name)
+
+    return None
+
+def get_my_field_types(cls):
+    type_hints = {}
+    for current_cls in cls.__class__.__mro__:
+        if current_cls is object or current_cls is AbstractModel:
+            break
+        type_hints.update(get_type_hints(current_cls))
+    return type_hints
+
+

trd_utils-0.0.40/trd_utils/__init__.py

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

trd_utils-0.0.40/trd_utils/types_helper/__init__.py

@@ -1,6 +0,0 @@
-from .base_model import BaseModel
-
-
-__all__ = [
-    "BaseModel",
-]