From 903f68c6e3da739f7288950388947ceb2d387bb4 Mon Sep 17 00:00:00 2001 From: Davide Casale Date: Fri, 13 Jan 2023 18:15:29 +0100 Subject: [PATCH 1/6] Add support for SimpleNamespace (instead of TypedDict) in bfxapi/labeler.py and bfxapi/notifications.py. Add generics Notification type in notifications.py. Add support for new changes in bfxapi/rest/BfxRestInterface.py. --- bfxapi/labeler.py | 4 ++- bfxapi/notification.py | 26 +++++++++-------- bfxapi/rest/BfxRestInterface.py | 30 ++++++++++---------- bfxapi/rest/typings.py | 50 +++++++++++++++++---------------- 4 files changed, 59 insertions(+), 51 deletions(-) diff --git a/bfxapi/labeler.py b/bfxapi/labeler.py index 4575146..8a5845e 100644 --- a/bfxapi/labeler.py +++ b/bfxapi/labeler.py @@ -2,6 +2,8 @@ from .exceptions import LabelerSerializerException from typing import Generic, TypeVar, Iterable, Optional, List, Tuple, Any, cast +from types import SimpleNamespace + T = TypeVar("T") class _Serializer(Generic[T]): @@ -19,4 +21,4 @@ class _Serializer(Generic[T]): yield label, args[index] def parse(self, *values: Any, skip: Optional[List[str]] = None) -> T: - return cast(T, dict(self._serialize(*values, skip=skip))) \ No newline at end of file + return cast(T, SimpleNamespace(**dict(self._serialize(*values, skip=skip)))) \ No newline at end of file diff --git a/bfxapi/notification.py b/bfxapi/notification.py index 90d2f12..413f1b6 100644 --- a/bfxapi/notification.py +++ b/bfxapi/notification.py @@ -1,17 +1,21 @@ -from typing import List, Dict, Union, Optional, Any, TypedDict, cast +from typing import List, Dict, Union, Optional, Any, TypedDict, Generic, TypeVar, cast + +from types import SimpleNamespace from .labeler import _Serializer -class Notification(TypedDict): +T = TypeVar("T") + +class Notification(SimpleNamespace, Generic[T]): MTS: int TYPE: str MESSAGE_ID: Optional[int] - NOTIFY_INFO: Union[Dict[str, Any], List[Dict[str, Any]]] + NOTIFY_INFO: T CODE: Optional[int] STATUS: str TEXT: str -class _Notification(_Serializer): +class _Notification(_Serializer, Generic[T]): __LABELS = [ "MTS", "TYPE", "MESSAGE_ID", "_PLACEHOLDER", "NOTIFY_INFO", "CODE", "STATUS", "TEXT" ] def __init__(self, serializer: Optional[_Serializer] = None, iterate: bool = False): @@ -19,17 +23,17 @@ class _Notification(_Serializer): self.serializer, self.iterate = serializer, iterate - def parse(self, *values: Any, skip: Optional[List[str]] = None) -> Notification: - notification = dict(self._serialize(*values)) + def parse(self, *values: Any, skip: Optional[List[str]] = None) -> Notification[T]: + notification = cast(Notification[T], SimpleNamespace(**dict(self._serialize(*values)))) if isinstance(self.serializer, _Serializer): - if self.iterate == False: - NOTIFY_INFO = notification["NOTIFY_INFO"] + NOTIFY_INFO = cast(List[Any], notification.NOTIFY_INFO) + if self.iterate == False: if len(NOTIFY_INFO) == 1 and isinstance(NOTIFY_INFO[0], list): NOTIFY_INFO = NOTIFY_INFO[0] - notification["NOTIFY_INFO"] = dict(self.serializer._serialize(*NOTIFY_INFO, skip=skip)) - else: notification["NOTIFY_INFO"] = [ dict(self.serializer._serialize(*data, skip=skip)) for data in notification["NOTIFY_INFO"] ] + notification.NOTIFY_INFO = cast(T, SimpleNamespace(**dict(self.serializer._serialize(*NOTIFY_INFO, skip=skip)))) + else: notification.NOTIFY_INFO = cast(T, [ SimpleNamespace(**dict(self.serializer._serialize(*data, skip=skip))) for data in NOTIFY_INFO ]) - return cast(Notification, notification) \ No newline at end of file + return notification \ No newline at end of file diff --git a/bfxapi/rest/BfxRestInterface.py b/bfxapi/rest/BfxRestInterface.py index 3a02593..b967775 100644 --- a/bfxapi/rest/BfxRestInterface.py +++ b/bfxapi/rest/BfxRestInterface.py @@ -97,11 +97,11 @@ class _RestPublicEndpoints(_Requests): parsers = { "t": serializers.TradingPairTicker.parse, "f": serializers.FundingCurrencyTicker.parse } - return [ parsers[subdata[0][0]](*subdata) for subdata in data ] + return [ cast(Union[TradingPairTicker, FundingCurrencyTicker], parsers[subdata[0][0]](*subdata)) for subdata in data ] def get_t_tickers(self, pairs: Union[List[str], Literal["ALL"]]) -> List[TradingPairTicker]: if isinstance(pairs, str) and pairs == "ALL": - return [ cast(TradingPairTicker, subdata) for subdata in self.get_tickers([ "ALL" ]) if cast(str, subdata["SYMBOL"]).startswith("t") ] + return [ cast(TradingPairTicker, subdata) for subdata in self.get_tickers([ "ALL" ]) if cast(str, subdata.SYMBOL).startswith("t") ] data = self.get_tickers([ "t" + pair for pair in pairs ]) @@ -109,7 +109,7 @@ class _RestPublicEndpoints(_Requests): def get_f_tickers(self, currencies: Union[List[str], Literal["ALL"]]) -> List[FundingCurrencyTicker]: if isinstance(currencies, str) and currencies == "ALL": - return [ cast(FundingCurrencyTicker, subdata) for subdata in self.get_tickers([ "ALL" ]) if cast(str, subdata["SYMBOL"]).startswith("f") ] + return [ cast(FundingCurrencyTicker, subdata) for subdata in self.get_tickers([ "ALL" ]) if cast(str, subdata.SYMBOL).startswith("f") ] data = self.get_tickers([ "f" + currency for currency in currencies ]) @@ -262,7 +262,7 @@ class _RestAuthenticatedEndpoints(_Requests): price: Optional[Union[Decimal, str]] = None, lev: Optional[int] = None, price_trailing: Optional[Union[Decimal, str]] = None, price_aux_limit: Optional[Union[Decimal, str]] = None, price_oco_stop: Optional[Union[Decimal, str]] = None, gid: Optional[int] = None, cid: Optional[int] = None, - flags: Optional[int] = 0, tif: Optional[Union[datetime, str]] = None, meta: Optional[JSON] = None) -> Notification: + flags: Optional[int] = 0, tif: Optional[Union[datetime, str]] = None, meta: Optional[JSON] = None) -> Notification[Order]: data = { "type": type, "symbol": symbol, "amount": amount, "price": price, "lev": lev, @@ -271,12 +271,12 @@ class _RestAuthenticatedEndpoints(_Requests): "flags": flags, "tif": tif, "meta": meta } - return serializers._Notification(serializer=serializers.Order).parse(*self._POST("auth/w/order/submit", data=data)) + return serializers._Notification[Order](serializer=serializers.Order).parse(*self._POST("auth/w/order/submit", data=data)) def update_order(self, id: int, amount: Optional[Union[Decimal, str]] = None, price: Optional[Union[Decimal, str]] = None, cid: Optional[int] = None, cid_date: Optional[str] = None, gid: Optional[int] = None, flags: Optional[int] = 0, lev: Optional[int] = None, delta: Optional[Union[Decimal, str]] = None, - price_aux_limit: Optional[Union[Decimal, str]] = None, price_trailing: Optional[Union[Decimal, str]] = None, tif: Optional[Union[datetime, str]] = None) -> Notification: + price_aux_limit: Optional[Union[Decimal, str]] = None, price_trailing: Optional[Union[Decimal, str]] = None, tif: Optional[Union[datetime, str]] = None) -> Notification[Order]: data = { "id": id, "amount": amount, "price": price, "cid": cid, "cid_date": cid_date, "gid": gid, @@ -284,18 +284,18 @@ class _RestAuthenticatedEndpoints(_Requests): "price_aux_limit": price_aux_limit, "price_trailing": price_trailing, "tif": tif } - return serializers._Notification(serializer=serializers.Order).parse(*self._POST("auth/w/order/update", data=data)) + return serializers._Notification[Order](serializer=serializers.Order).parse(*self._POST("auth/w/order/update", data=data)) - def cancel_order(self, id: Optional[int] = None, cid: Optional[int] = None, cid_date: Optional[str] = None) -> Notification: + def cancel_order(self, id: Optional[int] = None, cid: Optional[int] = None, cid_date: Optional[str] = None) -> Notification[Order]: data = { "id": id, "cid": cid, "cid_date": cid_date } - return serializers._Notification(serializer=serializers.Order).parse(*self._POST("auth/w/order/cancel", data=data)) + return serializers._Notification[Order](serializer=serializers.Order).parse(*self._POST("auth/w/order/cancel", data=data)) - def cancel_order_multi(self, ids: Optional[List[int]] = None, cids: Optional[List[Tuple[int, str]]] = None, gids: Optional[List[int]] = None, all: bool = False) -> Notification: + def cancel_order_multi(self, ids: Optional[List[int]] = None, cids: Optional[List[Tuple[int, str]]] = None, gids: Optional[List[int]] = None, all: bool = False) -> Notification[List[Order]]: data = { "ids": ids, "cids": cids, @@ -304,7 +304,7 @@ class _RestAuthenticatedEndpoints(_Requests): "all": int(all) } - return serializers._Notification(serializer=serializers.Order, iterate=True).parse(*self._POST("auth/w/order/cancel/multi", data=data)) + return serializers._Notification[List[Order]](serializer=serializers.Order, iterate=True).parse(*self._POST("auth/w/order/cancel/multi", data=data)) def get_orders_history(self, symbol: Optional[str] = None, ids: Optional[List[int]] = None, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[Order]: if symbol == None: @@ -354,17 +354,17 @@ class _RestAuthenticatedEndpoints(_Requests): def submit_funding_offer(self, type: FundingOfferType, symbol: str, amount: Union[Decimal, str], rate: Union[Decimal, str], period: int, - flags: Optional[int] = 0) -> Notification: + flags: Optional[int] = 0) -> Notification[FundingOffer]: data = { "type": type, "symbol": symbol, "amount": amount, "rate": rate, "period": period, "flags": flags } - return serializers._Notification(serializer=serializers.FundingOffer).parse(*self._POST("auth/w/funding/offer/submit", data=data)) + return serializers._Notification[FundingOffer](serializer=serializers.FundingOffer).parse(*self._POST("auth/w/funding/offer/submit", data=data)) - def cancel_funding_offer(self, id: int) -> Notification: - return serializers._Notification(serializer=serializers.FundingOffer).parse(*self._POST("auth/w/funding/offer/cancel", data={ "id": id })) + def cancel_funding_offer(self, id: int) -> Notification[FundingOffer]: + return serializers._Notification[FundingOffer](serializer=serializers.FundingOffer).parse(*self._POST("auth/w/funding/offer/cancel", data={ "id": id })) def get_funding_offers_history(self, symbol: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[FundingOffer]: if symbol == None: diff --git a/bfxapi/rest/typings.py b/bfxapi/rest/typings.py index d9d37a7..1685b04 100644 --- a/bfxapi/rest/typings.py +++ b/bfxapi/rest/typings.py @@ -1,15 +1,17 @@ from typing import Type, Tuple, List, Dict, TypedDict, Union, Optional, Any +from types import SimpleNamespace + from .. notification import Notification JSON = Union[Dict[str, "JSON"], List["JSON"], bool, int, float, str, Type[None]] #region Type hinting for Rest Public Endpoints -class PlatformStatus(TypedDict): +class PlatformStatus(SimpleNamespace): OPERATIVE: int -class TradingPairTicker(TypedDict): +class TradingPairTicker(SimpleNamespace): SYMBOL: Optional[str] BID: float BID_SIZE: float @@ -22,7 +24,7 @@ class TradingPairTicker(TypedDict): HIGH: float LOW: float -class FundingCurrencyTicker(TypedDict): +class FundingCurrencyTicker(SimpleNamespace): SYMBOL: Optional[str] FRR: float BID: float @@ -39,52 +41,52 @@ class FundingCurrencyTicker(TypedDict): LOW: float FRR_AMOUNT_AVAILABLE: float -class TickersHistory(TypedDict): +class TickersHistory(SimpleNamespace): SYMBOL: str BID: float ASK: float MTS: int -class TradingPairTrade(TypedDict): +class TradingPairTrade(SimpleNamespace): ID: int MTS: int AMOUNT: float PRICE: float -class FundingCurrencyTrade(TypedDict): +class FundingCurrencyTrade(SimpleNamespace): ID: int MTS: int AMOUNT: float RATE: float PERIOD: int -class TradingPairBook(TypedDict): +class TradingPairBook(SimpleNamespace): PRICE: float COUNT: int AMOUNT: float -class FundingCurrencyBook(TypedDict): +class FundingCurrencyBook(SimpleNamespace): RATE: float PERIOD: int COUNT: int AMOUNT: float -class TradingPairRawBook(TypedDict): +class TradingPairRawBook(SimpleNamespace): ORDER_ID: int PRICE: float AMOUNT: float -class FundingCurrencyRawBook(TypedDict): +class FundingCurrencyRawBook(SimpleNamespace): OFFER_ID: int PERIOD: int RATE: float AMOUNT: float -class Statistic(TypedDict): +class Statistic(SimpleNamespace): MTS: int VALUE: float -class Candle(TypedDict): +class Candle(SimpleNamespace): MTS: int OPEN: float CLOSE: float @@ -92,7 +94,7 @@ class Candle(TypedDict): LOW: float VOLUME: float -class DerivativesStatus(TypedDict): +class DerivativesStatus(SimpleNamespace): KEY: Optional[str] MTS: int DERIV_PRICE: float @@ -107,7 +109,7 @@ class DerivativesStatus(TypedDict): CLAMP_MIN: float CLAMP_MAX: float -class Liquidation(TypedDict): +class Liquidation(SimpleNamespace): POS_ID: int MTS: int SYMBOL: str @@ -117,14 +119,14 @@ class Liquidation(TypedDict): IS_MARKET_SOLD: int PRICE_ACQUIRED: float -class Leaderboard(TypedDict): +class Leaderboard(SimpleNamespace): MTS: int USERNAME: str RANKING: int VALUE: float TWITTER_HANDLE: Optional[str] -class FundingStatistic(TypedDict): +class FundingStatistic(SimpleNamespace): TIMESTAMP: int FRR: float AVG_PERIOD: float @@ -136,7 +138,7 @@ class FundingStatistic(TypedDict): #region Type hinting for Rest Authenticated Endpoints -class Wallet(TypedDict): +class Wallet(SimpleNamespace): WALLET_TYPE: str CURRENCY: str BALANCE: float @@ -145,7 +147,7 @@ class Wallet(TypedDict): LAST_CHANGE: str TRADE_DETAILS: JSON -class Order(TypedDict): +class Order(SimpleNamespace): ID: int GID: int CID: int @@ -169,7 +171,7 @@ class Order(TypedDict): ROUTING: str META: JSON -class Position(TypedDict): +class Position(SimpleNamespace): SYMBOL: str STATUS: str AMOUNT: float @@ -188,7 +190,7 @@ class Position(TypedDict): COLLATERAL_MIN: float META: JSON -class FundingOffer(TypedDict): +class FundingOffer(SimpleNamespace): ID: int SYMBOL: str MTS_CREATE: int @@ -204,7 +206,7 @@ class FundingOffer(TypedDict): HIDDEN: int RENEW: bool -class Trade(TypedDict): +class Trade(SimpleNamespace): ID: int SYMBOL: str MTS_CREATE: int @@ -218,7 +220,7 @@ class Trade(TypedDict): FEE_CURRENCY: str CID: int -class OrderTrade(TypedDict): +class OrderTrade(SimpleNamespace): ID: int SYMBOL: str MTS_CREATE: int @@ -230,7 +232,7 @@ class OrderTrade(TypedDict): FEE_CURRENCY: str CID: int -class Ledger(TypedDict): +class Ledger(SimpleNamespace): ID: int CURRENCY: str MTS: int @@ -238,7 +240,7 @@ class Ledger(TypedDict): BALANCE: float description: str -class FundingCredit(TypedDict): +class FundingCredit(SimpleNamespace): ID: int SYMBOL: str SIDE: int From 0bb9f65a190656d1707f9a0cedf6ee98f5a2c401 Mon Sep 17 00:00:00 2001 From: Davide Casale Date: Mon, 16 Jan 2023 16:30:06 +0100 Subject: [PATCH 2/6] Replace SimpleNamespaces with dataclasses. Add base class _Typing in labeler.py to convert dictionaries to dataclasses. Remove SimpleNamespace references. --- bfxapi/labeler.py | 9 +++-- bfxapi/notification.py | 13 +++---- bfxapi/rest/typings.py | 80 ++++++++++++++++++++++++++++-------------- 3 files changed, 66 insertions(+), 36 deletions(-) diff --git a/bfxapi/labeler.py b/bfxapi/labeler.py index 8a5845e..160e054 100644 --- a/bfxapi/labeler.py +++ b/bfxapi/labeler.py @@ -2,10 +2,13 @@ from .exceptions import LabelerSerializerException from typing import Generic, TypeVar, Iterable, Optional, List, Tuple, Any, cast -from types import SimpleNamespace - T = TypeVar("T") +class _Typing(object): + def __init__(self, **kwargs): + for key, value in kwargs.items(): + self.__setattr__(key,value) + class _Serializer(Generic[T]): def __init__(self, name: str, labels: List[str], IGNORE: List[str] = [ "_PLACEHOLDER" ]): self.name, self.__labels, self.__IGNORE = name, labels, IGNORE @@ -21,4 +24,4 @@ class _Serializer(Generic[T]): yield label, args[index] def parse(self, *values: Any, skip: Optional[List[str]] = None) -> T: - return cast(T, SimpleNamespace(**dict(self._serialize(*values, skip=skip)))) \ No newline at end of file + return cast(T, _Typing(**dict(self._serialize(*values, skip=skip)))) \ No newline at end of file diff --git a/bfxapi/notification.py b/bfxapi/notification.py index 413f1b6..b8cdb37 100644 --- a/bfxapi/notification.py +++ b/bfxapi/notification.py @@ -1,12 +1,13 @@ from typing import List, Dict, Union, Optional, Any, TypedDict, Generic, TypeVar, cast -from types import SimpleNamespace +from dataclasses import dataclass -from .labeler import _Serializer +from .labeler import _Typing, _Serializer T = TypeVar("T") -class Notification(SimpleNamespace, Generic[T]): +@dataclass +class Notification(_Typing, Generic[T]): MTS: int TYPE: str MESSAGE_ID: Optional[int] @@ -24,7 +25,7 @@ class _Notification(_Serializer, Generic[T]): self.serializer, self.iterate = serializer, iterate def parse(self, *values: Any, skip: Optional[List[str]] = None) -> Notification[T]: - notification = cast(Notification[T], SimpleNamespace(**dict(self._serialize(*values)))) + notification = cast(Notification[T], _Typing(**dict(self._serialize(*values)))) if isinstance(self.serializer, _Serializer): NOTIFY_INFO = cast(List[Any], notification.NOTIFY_INFO) @@ -33,7 +34,7 @@ class _Notification(_Serializer, Generic[T]): if len(NOTIFY_INFO) == 1 and isinstance(NOTIFY_INFO[0], list): NOTIFY_INFO = NOTIFY_INFO[0] - notification.NOTIFY_INFO = cast(T, SimpleNamespace(**dict(self.serializer._serialize(*NOTIFY_INFO, skip=skip)))) - else: notification.NOTIFY_INFO = cast(T, [ SimpleNamespace(**dict(self.serializer._serialize(*data, skip=skip))) for data in NOTIFY_INFO ]) + notification.NOTIFY_INFO = cast(T, _Typing(**dict(self.serializer._serialize(*NOTIFY_INFO, skip=skip)))) + else: notification.NOTIFY_INFO = cast(T, [ _Typing(**dict(self.serializer._serialize(*data, skip=skip))) for data in NOTIFY_INFO ]) return notification \ No newline at end of file diff --git a/bfxapi/rest/typings.py b/bfxapi/rest/typings.py index 1685b04..ef397a9 100644 --- a/bfxapi/rest/typings.py +++ b/bfxapi/rest/typings.py @@ -1,6 +1,8 @@ from typing import Type, Tuple, List, Dict, TypedDict, Union, Optional, Any -from types import SimpleNamespace +from dataclasses import dataclass + +from .. labeler import _Typing from .. notification import Notification @@ -8,10 +10,12 @@ JSON = Union[Dict[str, "JSON"], List["JSON"], bool, int, float, str, Type[None]] #region Type hinting for Rest Public Endpoints -class PlatformStatus(SimpleNamespace): +@dataclass +class PlatformStatus(_Typing): OPERATIVE: int -class TradingPairTicker(SimpleNamespace): +@dataclass +class TradingPairTicker(_Typing): SYMBOL: Optional[str] BID: float BID_SIZE: float @@ -24,7 +28,8 @@ class TradingPairTicker(SimpleNamespace): HIGH: float LOW: float -class FundingCurrencyTicker(SimpleNamespace): +@dataclass +class FundingCurrencyTicker(_Typing): SYMBOL: Optional[str] FRR: float BID: float @@ -41,52 +46,61 @@ class FundingCurrencyTicker(SimpleNamespace): LOW: float FRR_AMOUNT_AVAILABLE: float -class TickersHistory(SimpleNamespace): +@dataclass +class TickersHistory(_Typing): SYMBOL: str BID: float ASK: float MTS: int -class TradingPairTrade(SimpleNamespace): +@dataclass +class TradingPairTrade(_Typing): ID: int MTS: int AMOUNT: float PRICE: float -class FundingCurrencyTrade(SimpleNamespace): +@dataclass +class FundingCurrencyTrade(_Typing): ID: int MTS: int AMOUNT: float RATE: float PERIOD: int -class TradingPairBook(SimpleNamespace): +@dataclass +class TradingPairBook(_Typing): PRICE: float COUNT: int AMOUNT: float -class FundingCurrencyBook(SimpleNamespace): +@dataclass +class FundingCurrencyBook(_Typing): RATE: float PERIOD: int COUNT: int AMOUNT: float - -class TradingPairRawBook(SimpleNamespace): + +@dataclass +class TradingPairRawBook(_Typing): ORDER_ID: int PRICE: float AMOUNT: float - -class FundingCurrencyRawBook(SimpleNamespace): + +@dataclass +class FundingCurrencyRawBook(_Typing): OFFER_ID: int PERIOD: int RATE: float AMOUNT: float -class Statistic(SimpleNamespace): +@dataclass +class Statistic(_Typing): MTS: int VALUE: float -class Candle(SimpleNamespace): +@dataclass +class Candle(_Typing): MTS: int OPEN: float CLOSE: float @@ -94,7 +108,8 @@ class Candle(SimpleNamespace): LOW: float VOLUME: float -class DerivativesStatus(SimpleNamespace): +@dataclass +class DerivativesStatus(_Typing): KEY: Optional[str] MTS: int DERIV_PRICE: float @@ -109,7 +124,8 @@ class DerivativesStatus(SimpleNamespace): CLAMP_MIN: float CLAMP_MAX: float -class Liquidation(SimpleNamespace): +@dataclass +class Liquidation(_Typing): POS_ID: int MTS: int SYMBOL: str @@ -119,14 +135,16 @@ class Liquidation(SimpleNamespace): IS_MARKET_SOLD: int PRICE_ACQUIRED: float -class Leaderboard(SimpleNamespace): +@dataclass +class Leaderboard(_Typing): MTS: int USERNAME: str RANKING: int VALUE: float TWITTER_HANDLE: Optional[str] -class FundingStatistic(SimpleNamespace): +@dataclass +class FundingStatistic(_Typing): TIMESTAMP: int FRR: float AVG_PERIOD: float @@ -138,7 +156,8 @@ class FundingStatistic(SimpleNamespace): #region Type hinting for Rest Authenticated Endpoints -class Wallet(SimpleNamespace): +@dataclass +class Wallet(_Typing): WALLET_TYPE: str CURRENCY: str BALANCE: float @@ -147,7 +166,8 @@ class Wallet(SimpleNamespace): LAST_CHANGE: str TRADE_DETAILS: JSON -class Order(SimpleNamespace): +@dataclass +class Order(_Typing): ID: int GID: int CID: int @@ -171,7 +191,8 @@ class Order(SimpleNamespace): ROUTING: str META: JSON -class Position(SimpleNamespace): +@dataclass +class Position(_Typing): SYMBOL: str STATUS: str AMOUNT: float @@ -190,7 +211,8 @@ class Position(SimpleNamespace): COLLATERAL_MIN: float META: JSON -class FundingOffer(SimpleNamespace): +@dataclass +class FundingOffer(_Typing): ID: int SYMBOL: str MTS_CREATE: int @@ -206,7 +228,8 @@ class FundingOffer(SimpleNamespace): HIDDEN: int RENEW: bool -class Trade(SimpleNamespace): +@dataclass +class Trade(_Typing): ID: int SYMBOL: str MTS_CREATE: int @@ -220,7 +243,8 @@ class Trade(SimpleNamespace): FEE_CURRENCY: str CID: int -class OrderTrade(SimpleNamespace): +@dataclass +class OrderTrade(_Typing): ID: int SYMBOL: str MTS_CREATE: int @@ -232,7 +256,8 @@ class OrderTrade(SimpleNamespace): FEE_CURRENCY: str CID: int -class Ledger(SimpleNamespace): +@dataclass +class Ledger(_Typing): ID: int CURRENCY: str MTS: int @@ -240,7 +265,8 @@ class Ledger(SimpleNamespace): BALANCE: float description: str -class FundingCredit(SimpleNamespace): +@dataclass +class FundingCredit(_Typing): ID: int SYMBOL: str SIDE: int From 1613a56d813e1195e1c01fb5b3e3299a33224e50 Mon Sep 17 00:00:00 2001 From: Davide Casale Date: Mon, 16 Jan 2023 16:40:14 +0100 Subject: [PATCH 3/6] Rename bfxapi/rest/typings.py to bfxapi/rest/types.py. --- bfxapi/labeler.py | 4 +-- bfxapi/notification.py | 10 +++--- bfxapi/rest/BfxRestInterface.py | 2 +- bfxapi/rest/serializers.py | 50 ++++++++++++++-------------- bfxapi/rest/{typings.py => types.py} | 50 ++++++++++++++-------------- 5 files changed, 58 insertions(+), 58 deletions(-) rename bfxapi/rest/{typings.py => types.py} (85%) diff --git a/bfxapi/labeler.py b/bfxapi/labeler.py index 160e054..9714b5c 100644 --- a/bfxapi/labeler.py +++ b/bfxapi/labeler.py @@ -4,7 +4,7 @@ from typing import Generic, TypeVar, Iterable, Optional, List, Tuple, Any, cast T = TypeVar("T") -class _Typing(object): +class _Type(object): def __init__(self, **kwargs): for key, value in kwargs.items(): self.__setattr__(key,value) @@ -24,4 +24,4 @@ class _Serializer(Generic[T]): yield label, args[index] def parse(self, *values: Any, skip: Optional[List[str]] = None) -> T: - return cast(T, _Typing(**dict(self._serialize(*values, skip=skip)))) \ No newline at end of file + return cast(T, _Type(**dict(self._serialize(*values, skip=skip)))) \ No newline at end of file diff --git a/bfxapi/notification.py b/bfxapi/notification.py index b8cdb37..e66ba60 100644 --- a/bfxapi/notification.py +++ b/bfxapi/notification.py @@ -2,12 +2,12 @@ from typing import List, Dict, Union, Optional, Any, TypedDict, Generic, TypeVar from dataclasses import dataclass -from .labeler import _Typing, _Serializer +from .labeler import _Type, _Serializer T = TypeVar("T") @dataclass -class Notification(_Typing, Generic[T]): +class Notification(_Type, Generic[T]): MTS: int TYPE: str MESSAGE_ID: Optional[int] @@ -25,7 +25,7 @@ class _Notification(_Serializer, Generic[T]): self.serializer, self.iterate = serializer, iterate def parse(self, *values: Any, skip: Optional[List[str]] = None) -> Notification[T]: - notification = cast(Notification[T], _Typing(**dict(self._serialize(*values)))) + notification = cast(Notification[T], _Type(**dict(self._serialize(*values)))) if isinstance(self.serializer, _Serializer): NOTIFY_INFO = cast(List[Any], notification.NOTIFY_INFO) @@ -34,7 +34,7 @@ class _Notification(_Serializer, Generic[T]): if len(NOTIFY_INFO) == 1 and isinstance(NOTIFY_INFO[0], list): NOTIFY_INFO = NOTIFY_INFO[0] - notification.NOTIFY_INFO = cast(T, _Typing(**dict(self.serializer._serialize(*NOTIFY_INFO, skip=skip)))) - else: notification.NOTIFY_INFO = cast(T, [ _Typing(**dict(self.serializer._serialize(*data, skip=skip))) for data in NOTIFY_INFO ]) + notification.NOTIFY_INFO = cast(T, _Type(**dict(self.serializer._serialize(*NOTIFY_INFO, skip=skip)))) + else: notification.NOTIFY_INFO = cast(T, [ _Type(**dict(self.serializer._serialize(*data, skip=skip))) for data in NOTIFY_INFO ]) return notification \ No newline at end of file diff --git a/bfxapi/rest/BfxRestInterface.py b/bfxapi/rest/BfxRestInterface.py index b967775..33f5657 100644 --- a/bfxapi/rest/BfxRestInterface.py +++ b/bfxapi/rest/BfxRestInterface.py @@ -8,7 +8,7 @@ from typing import List, Union, Literal, Optional, Any, cast from . import serializers -from .typings import * +from .types import * from .enums import Config, Sort, OrderType, FundingOfferType, Error from .exceptions import ResourceNotFound, RequestParametersError, InvalidAuthenticationCredentials, UnknownGenericError diff --git a/bfxapi/rest/serializers.py b/bfxapi/rest/serializers.py index 9e2612a..4196b52 100644 --- a/bfxapi/rest/serializers.py +++ b/bfxapi/rest/serializers.py @@ -1,4 +1,4 @@ -from . import typings +from . import types from .. labeler import _Serializer @@ -6,11 +6,11 @@ from .. notification import _Notification #region Serializers definition for Rest Public Endpoints -PlatformStatus = _Serializer[typings.PlatformStatus]("PlatformStatus", labels=[ +PlatformStatus = _Serializer[types.PlatformStatus]("PlatformStatus", labels=[ "OPERATIVE" ]) -TradingPairTicker = _Serializer[typings.TradingPairTicker]("TradingPairTicker", labels=[ +TradingPairTicker = _Serializer[types.TradingPairTicker]("TradingPairTicker", labels=[ "SYMBOL", "BID", "BID_SIZE", @@ -24,7 +24,7 @@ TradingPairTicker = _Serializer[typings.TradingPairTicker]("TradingPairTicker", "LOW" ]) -FundingCurrencyTicker = _Serializer[typings.FundingCurrencyTicker]("FundingCurrencyTicker", labels=[ +FundingCurrencyTicker = _Serializer[types.FundingCurrencyTicker]("FundingCurrencyTicker", labels=[ "SYMBOL", "FRR", "BID", @@ -44,7 +44,7 @@ FundingCurrencyTicker = _Serializer[typings.FundingCurrencyTicker]("FundingCurre "FRR_AMOUNT_AVAILABLE" ]) -TickersHistory = _Serializer[typings.TickersHistory]("TickersHistory", labels=[ +TickersHistory = _Serializer[types.TickersHistory]("TickersHistory", labels=[ "SYMBOL", "BID", "_PLACEHOLDER", @@ -60,14 +60,14 @@ TickersHistory = _Serializer[typings.TickersHistory]("TickersHistory", labels=[ "MTS" ]) -TradingPairTrade = _Serializer[typings.TradingPairTrade]("TradingPairTrade", labels=[ +TradingPairTrade = _Serializer[types.TradingPairTrade]("TradingPairTrade", labels=[ "ID", "MTS", "AMOUNT", "PRICE" ]) -FundingCurrencyTrade = _Serializer[typings.FundingCurrencyTrade]("FundingCurrencyTrade", labels=[ +FundingCurrencyTrade = _Serializer[types.FundingCurrencyTrade]("FundingCurrencyTrade", labels=[ "ID", "MTS", "AMOUNT", @@ -75,38 +75,38 @@ FundingCurrencyTrade = _Serializer[typings.FundingCurrencyTrade]("FundingCurrenc "PERIOD" ]) -TradingPairBook = _Serializer[typings.TradingPairBook]("TradingPairBook", labels=[ +TradingPairBook = _Serializer[types.TradingPairBook]("TradingPairBook", labels=[ "PRICE", "COUNT", "AMOUNT" ]) -FundingCurrencyBook = _Serializer[typings.FundingCurrencyBook]("FundingCurrencyBook", labels=[ +FundingCurrencyBook = _Serializer[types.FundingCurrencyBook]("FundingCurrencyBook", labels=[ "RATE", "PERIOD", "COUNT", "AMOUNT" ]) -TradingPairRawBook = _Serializer[typings.TradingPairRawBook]("TradingPairRawBook", labels=[ +TradingPairRawBook = _Serializer[types.TradingPairRawBook]("TradingPairRawBook", labels=[ "ORDER_ID", "PRICE", "AMOUNT" ]) -FundingCurrencyRawBook = _Serializer[typings.FundingCurrencyRawBook]("FundingCurrencyRawBook", labels=[ +FundingCurrencyRawBook = _Serializer[types.FundingCurrencyRawBook]("FundingCurrencyRawBook", labels=[ "OFFER_ID", "PERIOD", "RATE", "AMOUNT" ]) -Statistic = _Serializer[typings.Statistic]("Statistic", labels=[ +Statistic = _Serializer[types.Statistic]("Statistic", labels=[ "MTS", "VALUE" ]) -Candle = _Serializer[typings.Candle]("Candle", labels=[ +Candle = _Serializer[types.Candle]("Candle", labels=[ "MTS", "OPEN", "CLOSE", @@ -115,7 +115,7 @@ Candle = _Serializer[typings.Candle]("Candle", labels=[ "VOLUME" ]) -DerivativesStatus = _Serializer[typings.DerivativesStatus]("DerivativesStatus", labels=[ +DerivativesStatus = _Serializer[types.DerivativesStatus]("DerivativesStatus", labels=[ "KEY", "MTS", "_PLACEHOLDER", @@ -142,7 +142,7 @@ DerivativesStatus = _Serializer[typings.DerivativesStatus]("DerivativesStatus", "CLAMP_MAX" ]) -Liquidation = _Serializer[typings.Liquidation]("Liquidation", labels=[ +Liquidation = _Serializer[types.Liquidation]("Liquidation", labels=[ "_PLACEHOLDER", "POS_ID", "MTS", @@ -157,7 +157,7 @@ Liquidation = _Serializer[typings.Liquidation]("Liquidation", labels=[ "PRICE_ACQUIRED" ]) -Leaderboard = _Serializer[typings.Leaderboard]("Leaderboard", labels=[ +Leaderboard = _Serializer[types.Leaderboard]("Leaderboard", labels=[ "MTS", "_PLACEHOLDER", "USERNAME", @@ -170,7 +170,7 @@ Leaderboard = _Serializer[typings.Leaderboard]("Leaderboard", labels=[ "TWITTER_HANDLE" ]) -FundingStatistic = _Serializer[typings.FundingStatistic]("FundingStatistic", labels=[ +FundingStatistic = _Serializer[types.FundingStatistic]("FundingStatistic", labels=[ "TIMESTAMP", "_PLACEHOLDER", "_PLACEHOLDER", @@ -189,7 +189,7 @@ FundingStatistic = _Serializer[typings.FundingStatistic]("FundingStatistic", lab #region Serializers definition for Rest Authenticated Endpoints -Wallet = _Serializer[typings.Wallet]("Wallet", labels=[ +Wallet = _Serializer[types.Wallet]("Wallet", labels=[ "WALLET_TYPE", "CURRENCY", "BALANCE", @@ -199,7 +199,7 @@ Wallet = _Serializer[typings.Wallet]("Wallet", labels=[ "TRADE_DETAILS" ]) -Order = _Serializer[typings.Order]("Order", labels=[ +Order = _Serializer[types.Order]("Order", labels=[ "ID", "GID", "CID", @@ -234,7 +234,7 @@ Order = _Serializer[typings.Order]("Order", labels=[ "META" ]) -Position = _Serializer[typings.Position]("Position", labels=[ +Position = _Serializer[types.Position]("Position", labels=[ "SYMBOL", "STATUS", "AMOUNT", @@ -257,7 +257,7 @@ Position = _Serializer[typings.Position]("Position", labels=[ "META" ]) -FundingOffer = _Serializer[typings.FundingOffer]("FundingOffer", labels=[ +FundingOffer = _Serializer[types.FundingOffer]("FundingOffer", labels=[ "ID", "SYMBOL", "MTS_CREATED", @@ -281,7 +281,7 @@ FundingOffer = _Serializer[typings.FundingOffer]("FundingOffer", labels=[ "_PLACEHOLDER" ]) -Trade = _Serializer[typings.Trade]("Trade", labels=[ +Trade = _Serializer[types.Trade]("Trade", labels=[ "ID", "PAIR", "MTS_CREATE", @@ -296,7 +296,7 @@ Trade = _Serializer[typings.Trade]("Trade", labels=[ "CID" ]) -OrderTrade = _Serializer[typings.OrderTrade]("OrderTrade", labels=[ +OrderTrade = _Serializer[types.OrderTrade]("OrderTrade", labels=[ "ID", "PAIR", "MTS_CREATE", @@ -311,7 +311,7 @@ OrderTrade = _Serializer[typings.OrderTrade]("OrderTrade", labels=[ "CID" ]) -Ledger = _Serializer[typings.Ledger]("Ledger", labels=[ +Ledger = _Serializer[types.Ledger]("Ledger", labels=[ "ID", "CURRENCY", "_PLACEHOLDER", @@ -323,7 +323,7 @@ Ledger = _Serializer[typings.Ledger]("Ledger", labels=[ "DESCRIPTION" ]) -FundingCredit = _Serializer[typings.FundingCredit]("FundingCredit", labels=[ +FundingCredit = _Serializer[types.FundingCredit]("FundingCredit", labels=[ "ID", "SYMBOL", "SIDE", diff --git a/bfxapi/rest/typings.py b/bfxapi/rest/types.py similarity index 85% rename from bfxapi/rest/typings.py rename to bfxapi/rest/types.py index ef397a9..a27a404 100644 --- a/bfxapi/rest/typings.py +++ b/bfxapi/rest/types.py @@ -2,7 +2,7 @@ from typing import Type, Tuple, List, Dict, TypedDict, Union, Optional, Any from dataclasses import dataclass -from .. labeler import _Typing +from .. labeler import _Type from .. notification import Notification @@ -11,11 +11,11 @@ JSON = Union[Dict[str, "JSON"], List["JSON"], bool, int, float, str, Type[None]] #region Type hinting for Rest Public Endpoints @dataclass -class PlatformStatus(_Typing): +class PlatformStatus(_Type): OPERATIVE: int @dataclass -class TradingPairTicker(_Typing): +class TradingPairTicker(_Type): SYMBOL: Optional[str] BID: float BID_SIZE: float @@ -29,7 +29,7 @@ class TradingPairTicker(_Typing): LOW: float @dataclass -class FundingCurrencyTicker(_Typing): +class FundingCurrencyTicker(_Type): SYMBOL: Optional[str] FRR: float BID: float @@ -47,21 +47,21 @@ class FundingCurrencyTicker(_Typing): FRR_AMOUNT_AVAILABLE: float @dataclass -class TickersHistory(_Typing): +class TickersHistory(_Type): SYMBOL: str BID: float ASK: float MTS: int @dataclass -class TradingPairTrade(_Typing): +class TradingPairTrade(_Type): ID: int MTS: int AMOUNT: float PRICE: float @dataclass -class FundingCurrencyTrade(_Typing): +class FundingCurrencyTrade(_Type): ID: int MTS: int AMOUNT: float @@ -69,38 +69,38 @@ class FundingCurrencyTrade(_Typing): PERIOD: int @dataclass -class TradingPairBook(_Typing): +class TradingPairBook(_Type): PRICE: float COUNT: int AMOUNT: float @dataclass -class FundingCurrencyBook(_Typing): +class FundingCurrencyBook(_Type): RATE: float PERIOD: int COUNT: int AMOUNT: float @dataclass -class TradingPairRawBook(_Typing): +class TradingPairRawBook(_Type): ORDER_ID: int PRICE: float AMOUNT: float @dataclass -class FundingCurrencyRawBook(_Typing): +class FundingCurrencyRawBook(_Type): OFFER_ID: int PERIOD: int RATE: float AMOUNT: float @dataclass -class Statistic(_Typing): +class Statistic(_Type): MTS: int VALUE: float @dataclass -class Candle(_Typing): +class Candle(_Type): MTS: int OPEN: float CLOSE: float @@ -109,7 +109,7 @@ class Candle(_Typing): VOLUME: float @dataclass -class DerivativesStatus(_Typing): +class DerivativesStatus(_Type): KEY: Optional[str] MTS: int DERIV_PRICE: float @@ -125,7 +125,7 @@ class DerivativesStatus(_Typing): CLAMP_MAX: float @dataclass -class Liquidation(_Typing): +class Liquidation(_Type): POS_ID: int MTS: int SYMBOL: str @@ -136,7 +136,7 @@ class Liquidation(_Typing): PRICE_ACQUIRED: float @dataclass -class Leaderboard(_Typing): +class Leaderboard(_Type): MTS: int USERNAME: str RANKING: int @@ -144,7 +144,7 @@ class Leaderboard(_Typing): TWITTER_HANDLE: Optional[str] @dataclass -class FundingStatistic(_Typing): +class FundingStatistic(_Type): TIMESTAMP: int FRR: float AVG_PERIOD: float @@ -157,7 +157,7 @@ class FundingStatistic(_Typing): #region Type hinting for Rest Authenticated Endpoints @dataclass -class Wallet(_Typing): +class Wallet(_Type): WALLET_TYPE: str CURRENCY: str BALANCE: float @@ -167,7 +167,7 @@ class Wallet(_Typing): TRADE_DETAILS: JSON @dataclass -class Order(_Typing): +class Order(_Type): ID: int GID: int CID: int @@ -192,7 +192,7 @@ class Order(_Typing): META: JSON @dataclass -class Position(_Typing): +class Position(_Type): SYMBOL: str STATUS: str AMOUNT: float @@ -212,7 +212,7 @@ class Position(_Typing): META: JSON @dataclass -class FundingOffer(_Typing): +class FundingOffer(_Type): ID: int SYMBOL: str MTS_CREATE: int @@ -229,7 +229,7 @@ class FundingOffer(_Typing): RENEW: bool @dataclass -class Trade(_Typing): +class Trade(_Type): ID: int SYMBOL: str MTS_CREATE: int @@ -244,7 +244,7 @@ class Trade(_Typing): CID: int @dataclass -class OrderTrade(_Typing): +class OrderTrade(_Type): ID: int SYMBOL: str MTS_CREATE: int @@ -257,7 +257,7 @@ class OrderTrade(_Typing): CID: int @dataclass -class Ledger(_Typing): +class Ledger(_Type): ID: int CURRENCY: str MTS: int @@ -266,7 +266,7 @@ class Ledger(_Typing): description: str @dataclass -class FundingCredit(_Typing): +class FundingCredit(_Type): ID: int SYMBOL: str SIDE: int From e185da4cc998fae0ab504bb5e445cb0a075983aa Mon Sep 17 00:00:00 2001 From: Davide Casale Date: Mon, 16 Jan 2023 17:07:16 +0100 Subject: [PATCH 4/6] Rename bfxapi/websocket/typings.py to types.py. Replace TypedDicts with dataclasses (with _Type as base class). Update demos in examples/websocket to use new implementation. --- bfxapi/websocket/_BfxWebsocketInputs.py | 2 +- bfxapi/websocket/handlers.py | 14 +++-- bfxapi/websocket/serializers.py | 40 ++++++------- bfxapi/websocket/{typings.py => types.py} | 70 +++++++++++++++-------- 4 files changed, 77 insertions(+), 49 deletions(-) rename bfxapi/websocket/{typings.py => types.py} (83%) diff --git a/bfxapi/websocket/_BfxWebsocketInputs.py b/bfxapi/websocket/_BfxWebsocketInputs.py index fda6e19..85e29b0 100644 --- a/bfxapi/websocket/_BfxWebsocketInputs.py +++ b/bfxapi/websocket/_BfxWebsocketInputs.py @@ -2,7 +2,7 @@ from decimal import Decimal from datetime import datetime from typing import Union, Optional, List, Tuple -from .typings import JSON +from .types import JSON from .enums import OrderType, FundingOfferType def _strip(dictionary): diff --git a/bfxapi/websocket/handlers.py b/bfxapi/websocket/handlers.py index 83c1408..33c2654 100644 --- a/bfxapi/websocket/handlers.py +++ b/bfxapi/websocket/handlers.py @@ -1,3 +1,7 @@ +from typing import List + +from .types import * + from . import serializers from .enums import Channels from .exceptions import BfxWebsocketException @@ -174,13 +178,15 @@ class AuthenticatedChannelsHandler(object): raise BfxWebsocketException(f"Event of type <{type}> not found in self.__handlers.") def __notification(self, stream): + type, serializer = "notification", serializers._Notification(serializer=None) + if stream[1] == "on-req" or stream[1] == "ou-req" or stream[1] == "oc-req": - return self.event_emitter.emit(f"{stream[1]}-notification", serializers._Notification(serializer=serializers.Order).parse(*stream)) + type, serializer = f"{stream[1]}-notification", serializers._Notification[Order](serializer=serializers.Order) if stream[1] == "oc_multi-req": - return self.event_emitter.emit(f"{stream[1]}-notification", serializers._Notification(serializer=serializers.Order, iterate=True).parse(*stream)) + type, serializer = f"{stream[1]}-notification", serializers._Notification[List[Order]](serializer=serializers.Order, iterate=True) if stream[1] == "fon-req" or stream[1] == "foc-req": - return self.event_emitter.emit(f"{stream[1]}-notification", serializers._Notification(serializer=serializers.FundingOffer).parse(*stream)) + type, serializer = f"{stream[1]}-notification", serializers._Notification[FundingOffer](serializer=serializers.FundingOffer) - return self.event_emitter.emit("notification", serializers._Notification(serializer=None).parse(*stream)) \ No newline at end of file + return self.event_emitter.emit(type, serializer.parse(*stream)) \ No newline at end of file diff --git a/bfxapi/websocket/serializers.py b/bfxapi/websocket/serializers.py index a9dd805..6bd56c1 100644 --- a/bfxapi/websocket/serializers.py +++ b/bfxapi/websocket/serializers.py @@ -1,4 +1,4 @@ -from . import typings +from . import types from .. labeler import _Serializer @@ -6,7 +6,7 @@ from .. notification import _Notification #region Serializers definition for Websocket Public Channels -TradingPairTicker = _Serializer[typings.TradingPairTicker]("TradingPairTicker", labels=[ +TradingPairTicker = _Serializer[types.TradingPairTicker]("TradingPairTicker", labels=[ "BID", "BID_SIZE", "ASK", @@ -19,7 +19,7 @@ TradingPairTicker = _Serializer[typings.TradingPairTicker]("TradingPairTicker", "LOW" ]) -FundingCurrencyTicker = _Serializer[typings.FundingCurrencyTicker]("FundingCurrencyTicker", labels=[ +FundingCurrencyTicker = _Serializer[types.FundingCurrencyTicker]("FundingCurrencyTicker", labels=[ "FRR", "BID", "BID_PERIOD", @@ -38,14 +38,14 @@ FundingCurrencyTicker = _Serializer[typings.FundingCurrencyTicker]("FundingCurre "FRR_AMOUNT_AVAILABLE" ]) -TradingPairTrade = _Serializer[typings.TradingPairTrade]("TradingPairTrade", labels=[ +TradingPairTrade = _Serializer[types.TradingPairTrade]("TradingPairTrade", labels=[ "ID", "MTS", "AMOUNT", "PRICE" ]) -FundingCurrencyTrade = _Serializer[typings.FundingCurrencyTrade]("FundingCurrencyTrade", labels=[ +FundingCurrencyTrade = _Serializer[types.FundingCurrencyTrade]("FundingCurrencyTrade", labels=[ "ID", "MTS", "AMOUNT", @@ -53,33 +53,33 @@ FundingCurrencyTrade = _Serializer[typings.FundingCurrencyTrade]("FundingCurrenc "PERIOD" ]) -TradingPairBook = _Serializer[typings.TradingPairBook]("TradingPairBook", labels=[ +TradingPairBook = _Serializer[types.TradingPairBook]("TradingPairBook", labels=[ "PRICE", "COUNT", "AMOUNT" ]) -FundingCurrencyBook = _Serializer[typings.FundingCurrencyBook]("FundingCurrencyBook", labels=[ +FundingCurrencyBook = _Serializer[types.FundingCurrencyBook]("FundingCurrencyBook", labels=[ "RATE", "PERIOD", "COUNT", "AMOUNT" ]) -TradingPairRawBook = _Serializer[typings.TradingPairRawBook]("TradingPairRawBook", labels=[ +TradingPairRawBook = _Serializer[types.TradingPairRawBook]("TradingPairRawBook", labels=[ "ORDER_ID", "PRICE", "AMOUNT" ]) -FundingCurrencyRawBook = _Serializer[typings.FundingCurrencyRawBook]("FundingCurrencyRawBook", labels=[ +FundingCurrencyRawBook = _Serializer[types.FundingCurrencyRawBook]("FundingCurrencyRawBook", labels=[ "OFFER_ID", "PERIOD", "RATE", "AMOUNT" ]) -Candle = _Serializer[typings.Candle]("Candle", labels=[ +Candle = _Serializer[types.Candle]("Candle", labels=[ "MTS", "OPEN", "CLOSE", @@ -88,7 +88,7 @@ Candle = _Serializer[typings.Candle]("Candle", labels=[ "VOLUME" ]) -DerivativesStatus = _Serializer[typings.DerivativesStatus]("DerivativesStatus", labels=[ +DerivativesStatus = _Serializer[types.DerivativesStatus]("DerivativesStatus", labels=[ "TIME_MS", "_PLACEHOLDER", "DERIV_PRICE", @@ -118,7 +118,7 @@ DerivativesStatus = _Serializer[typings.DerivativesStatus]("DerivativesStatus", #region Serializers definition for Websocket Authenticated Channels -Order = _Serializer[typings.Order]("Order", labels=[ +Order = _Serializer[types.Order]("Order", labels=[ "ID", "GID", "CID", @@ -153,7 +153,7 @@ Order = _Serializer[typings.Order]("Order", labels=[ "META" ]) -Position = _Serializer[typings.Position]("Position", labels=[ +Position = _Serializer[types.Position]("Position", labels=[ "SYMBOL", "STATUS", "AMOUNT", @@ -176,7 +176,7 @@ Position = _Serializer[typings.Position]("Position", labels=[ "META" ]) -TradeExecuted = _Serializer[typings.TradeExecuted]("TradeExecuted", labels=[ +TradeExecuted = _Serializer[types.TradeExecuted]("TradeExecuted", labels=[ "ID", "SYMBOL", "MTS_CREATE", @@ -191,7 +191,7 @@ TradeExecuted = _Serializer[typings.TradeExecuted]("TradeExecuted", labels=[ "CID" ]) -TradeExecutionUpdate = _Serializer[typings.TradeExecutionUpdate]("TradeExecutionUpdate", labels=[ +TradeExecutionUpdate = _Serializer[types.TradeExecutionUpdate]("TradeExecutionUpdate", labels=[ "ID", "SYMBOL", "MTS_CREATE", @@ -206,7 +206,7 @@ TradeExecutionUpdate = _Serializer[typings.TradeExecutionUpdate]("TradeExecution "CID" ]) -FundingOffer = _Serializer[typings.FundingOffer]("FundingOffer", labels=[ +FundingOffer = _Serializer[types.FundingOffer]("FundingOffer", labels=[ "ID", "SYMBOL", "MTS_CREATED", @@ -230,7 +230,7 @@ FundingOffer = _Serializer[typings.FundingOffer]("FundingOffer", labels=[ "_PLACEHOLDER" ]) -FundingCredit = _Serializer[typings.FundingCredit]("FundingCredit", labels=[ +FundingCredit = _Serializer[types.FundingCredit]("FundingCredit", labels=[ "ID", "SYMBOL", "SIDE", @@ -255,7 +255,7 @@ FundingCredit = _Serializer[typings.FundingCredit]("FundingCredit", labels=[ "POSITION_PAIR" ]) -FundingLoan = _Serializer[typings.FundingLoan]("FundingLoan", labels=[ +FundingLoan = _Serializer[types.FundingLoan]("FundingLoan", labels=[ "ID", "SYMBOL", "SIDE", @@ -279,7 +279,7 @@ FundingLoan = _Serializer[typings.FundingLoan]("FundingLoan", labels=[ "NO_CLOSE" ]) -Wallet = _Serializer[typings.Wallet]("Wallet", labels=[ +Wallet = _Serializer[types.Wallet]("Wallet", labels=[ "WALLET_TYPE", "CURRENCY", "BALANCE", @@ -289,7 +289,7 @@ Wallet = _Serializer[typings.Wallet]("Wallet", labels=[ "META" ]) -BalanceInfo = _Serializer[typings.BalanceInfo]("BalanceInfo", labels=[ +BalanceInfo = _Serializer[types.BalanceInfo]("BalanceInfo", labels=[ "AUM", "AUM_NET", ]) diff --git a/bfxapi/websocket/typings.py b/bfxapi/websocket/types.py similarity index 83% rename from bfxapi/websocket/typings.py rename to bfxapi/websocket/types.py index ced6aaa..41838d5 100644 --- a/bfxapi/websocket/typings.py +++ b/bfxapi/websocket/types.py @@ -1,6 +1,10 @@ from typing import Type, Tuple, List, Dict, TypedDict, Union, Optional, Any -from .. notification import Notification +from dataclasses import dataclass + +from ..labeler import _Type + +from ..notification import Notification JSON = Union[Dict[str, "JSON"], List["JSON"], bool, int, float, str, Type[None]] @@ -48,7 +52,8 @@ class Subscriptions: #region Type hinting for Websocket Public Channels -class TradingPairTicker(TypedDict): +@dataclass +class TradingPairTicker(_Type): BID: float BID_SIZE: float ASK: float @@ -60,7 +65,8 @@ class TradingPairTicker(TypedDict): HIGH: float LOW: float -class FundingCurrencyTicker(TypedDict): +@dataclass +class FundingCurrencyTicker(_Type): FRR: float BID: float BID_PERIOD: int @@ -76,42 +82,49 @@ class FundingCurrencyTicker(TypedDict): LOW: float FRR_AMOUNT_AVAILABLE: float -class TradingPairTrade(TypedDict): +@dataclass +class TradingPairTrade(_Type): ID: int MTS: int AMOUNT: float PRICE: float -class FundingCurrencyTrade(TypedDict): +@dataclass +class FundingCurrencyTrade(_Type): ID: int MTS: int AMOUNT: float RATE: float PERIOD: int -class TradingPairBook(TypedDict): +@dataclass +class TradingPairBook(_Type): PRICE: float COUNT: int AMOUNT: float - -class FundingCurrencyBook(TypedDict): + +@dataclass +class FundingCurrencyBook(_Type): RATE: float PERIOD: int COUNT: int AMOUNT: float - -class TradingPairRawBook(TypedDict): + +@dataclass +class TradingPairRawBook(_Type): ORDER_ID: int PRICE: float AMOUNT: float - -class FundingCurrencyRawBook(TypedDict): + +@dataclass +class FundingCurrencyRawBook(_Type): OFFER_ID: int PERIOD: int RATE: float AMOUNT: float -class Candle(TypedDict): +@dataclass +class Candle(_Type): MTS: int OPEN: float CLOSE: float @@ -119,7 +132,8 @@ class Candle(TypedDict): LOW: float VOLUME: float -class DerivativesStatus(TypedDict): +@dataclass +class DerivativesStatus(_Type): TIME_MS: int DERIV_PRICE: float SPOT_PRICE: float @@ -136,8 +150,8 @@ class DerivativesStatus(TypedDict): #endregion #region Type hinting for Websocket Authenticated Channels - -class Order(TypedDict): +@dataclass +class Order(_Type): ID: int GID: int CID: int @@ -161,7 +175,8 @@ class Order(TypedDict): ROUTING: str META: JSON -class Position(TypedDict): +@dataclass +class Position(_Type): SYMBOL: str STATUS: str AMOUNT: float @@ -180,7 +195,8 @@ class Position(TypedDict): COLLATERAL_MIN: float META: JSON -class TradeExecuted(TypedDict): +@dataclass +class TradeExecuted(_Type): ID: int SYMBOL: str MTS_CREATE: int @@ -192,7 +208,8 @@ class TradeExecuted(TypedDict): MAKER:int CID: int -class TradeExecutionUpdate(TypedDict): +@dataclass +class TradeExecutionUpdate(_Type): ID: int SYMBOL: str MTS_CREATE: int @@ -206,7 +223,8 @@ class TradeExecutionUpdate(TypedDict): FEE_CURRENCY: str CID: int -class FundingOffer(TypedDict): +@dataclass +class FundingOffer(_Type): ID: int SYMBOL: str MTS_CREATED: int @@ -222,7 +240,8 @@ class FundingOffer(TypedDict): HIDDEN: int RENEW: int -class FundingCredit(TypedDict): +@dataclass +class FundingCredit(_Type): ID: int SYMBOL: str SIDE: int @@ -242,7 +261,8 @@ class FundingCredit(TypedDict): NO_CLOSE: int POSITION_PAIR: str -class FundingLoan(TypedDict): +@dataclass +class FundingLoan(_Type): ID: int SYMBOL: str SIDE: int @@ -261,7 +281,8 @@ class FundingLoan(TypedDict): RATE_REAL: float NO_CLOSE: int -class Wallet(TypedDict): +@dataclass +class Wallet(_Type): WALLET_TYPE: str CURRENCY: str BALANCE: float @@ -270,7 +291,8 @@ class Wallet(TypedDict): DESCRIPTION: str META: JSON -class BalanceInfo(TypedDict): +@dataclass +class BalanceInfo(_Type): AUM: float AUM_NET: float From 2afcc766476d3e5d0af623fa0e1cb33de7c616c5 Mon Sep 17 00:00:00 2001 From: Davide Casale Date: Mon, 16 Jan 2023 18:18:12 +0100 Subject: [PATCH 5/6] Fix bug regarding new typing with dataclasses. --- bfxapi/labeler.py | 13 +++++---- bfxapi/notification.py | 8 +++--- bfxapi/rest/serializers.py | 50 ++++++++++++++++----------------- bfxapi/websocket/serializers.py | 40 +++++++++++++------------- 4 files changed, 57 insertions(+), 54 deletions(-) diff --git a/bfxapi/labeler.py b/bfxapi/labeler.py index 9714b5c..38b527b 100644 --- a/bfxapi/labeler.py +++ b/bfxapi/labeler.py @@ -1,17 +1,17 @@ from .exceptions import LabelerSerializerException -from typing import Generic, TypeVar, Iterable, Optional, List, Tuple, Any, cast +from typing import Type, Generic, TypeVar, Iterable, Optional, List, Tuple, Any, cast T = TypeVar("T") class _Type(object): def __init__(self, **kwargs): for key, value in kwargs.items(): - self.__setattr__(key,value) + self.__setattr__(key, value) class _Serializer(Generic[T]): - def __init__(self, name: str, labels: List[str], IGNORE: List[str] = [ "_PLACEHOLDER" ]): - self.name, self.__labels, self.__IGNORE = name, labels, IGNORE + def __init__(self, name: str, klass: Type[_Type], labels: List[str], IGNORE: List[str] = [ "_PLACEHOLDER" ]): + self.name, self.klass, self.__labels, self.__IGNORE = name, klass, labels, IGNORE def _serialize(self, *args: Any, skip: Optional[List[str]] = None) -> Iterable[Tuple[str, Any]]: labels = list(filter(lambda label: label not in (skip or list()), self.__labels)) @@ -24,4 +24,7 @@ class _Serializer(Generic[T]): yield label, args[index] def parse(self, *values: Any, skip: Optional[List[str]] = None) -> T: - return cast(T, _Type(**dict(self._serialize(*values, skip=skip)))) \ No newline at end of file + return cast(T, self.klass(**dict(self._serialize(*values, skip=skip)))) + +def generate_labeler_serializer(name: str, klass: T, labels: List[str], IGNORE: List[str] = [ "_PLACEHOLDER" ]) -> _Serializer[T]: + return _Serializer[T](name, klass, labels, IGNORE) \ No newline at end of file diff --git a/bfxapi/notification.py b/bfxapi/notification.py index e66ba60..b2f90b8 100644 --- a/bfxapi/notification.py +++ b/bfxapi/notification.py @@ -20,12 +20,12 @@ class _Notification(_Serializer, Generic[T]): __LABELS = [ "MTS", "TYPE", "MESSAGE_ID", "_PLACEHOLDER", "NOTIFY_INFO", "CODE", "STATUS", "TEXT" ] def __init__(self, serializer: Optional[_Serializer] = None, iterate: bool = False): - super().__init__("Notification", _Notification.__LABELS, IGNORE = [ "_PLACEHOLDER" ]) + super().__init__("Notification", Notification, _Notification.__LABELS, IGNORE = [ "_PLACEHOLDER" ]) self.serializer, self.iterate = serializer, iterate def parse(self, *values: Any, skip: Optional[List[str]] = None) -> Notification[T]: - notification = cast(Notification[T], _Type(**dict(self._serialize(*values)))) + notification = cast(Notification[T], Notification(**dict(self._serialize(*values)))) if isinstance(self.serializer, _Serializer): NOTIFY_INFO = cast(List[Any], notification.NOTIFY_INFO) @@ -34,7 +34,7 @@ class _Notification(_Serializer, Generic[T]): if len(NOTIFY_INFO) == 1 and isinstance(NOTIFY_INFO[0], list): NOTIFY_INFO = NOTIFY_INFO[0] - notification.NOTIFY_INFO = cast(T, _Type(**dict(self.serializer._serialize(*NOTIFY_INFO, skip=skip)))) - else: notification.NOTIFY_INFO = cast(T, [ _Type(**dict(self.serializer._serialize(*data, skip=skip))) for data in NOTIFY_INFO ]) + notification.NOTIFY_INFO = cast(T, self.serializer.klass(**dict(self.serializer._serialize(*NOTIFY_INFO, skip=skip)))) + else: notification.NOTIFY_INFO = cast(T, [ self.serializer.klass(**dict(self.serializer._serialize(*data, skip=skip))) for data in NOTIFY_INFO ]) return notification \ No newline at end of file diff --git a/bfxapi/rest/serializers.py b/bfxapi/rest/serializers.py index 4196b52..35df8ae 100644 --- a/bfxapi/rest/serializers.py +++ b/bfxapi/rest/serializers.py @@ -1,16 +1,16 @@ from . import types -from .. labeler import _Serializer +from .. labeler import generate_labeler_serializer from .. notification import _Notification #region Serializers definition for Rest Public Endpoints -PlatformStatus = _Serializer[types.PlatformStatus]("PlatformStatus", labels=[ +PlatformStatus = generate_labeler_serializer("PlatformStatus", klass=types.PlatformStatus, labels=[ "OPERATIVE" ]) -TradingPairTicker = _Serializer[types.TradingPairTicker]("TradingPairTicker", labels=[ +TradingPairTicker = generate_labeler_serializer("TradingPairTicker", klass=types.TradingPairTicker, labels=[ "SYMBOL", "BID", "BID_SIZE", @@ -24,7 +24,7 @@ TradingPairTicker = _Serializer[types.TradingPairTicker]("TradingPairTicker", la "LOW" ]) -FundingCurrencyTicker = _Serializer[types.FundingCurrencyTicker]("FundingCurrencyTicker", labels=[ +FundingCurrencyTicker = generate_labeler_serializer("FundingCurrencyTicker", klass=types.FundingCurrencyTicker, labels=[ "SYMBOL", "FRR", "BID", @@ -44,7 +44,7 @@ FundingCurrencyTicker = _Serializer[types.FundingCurrencyTicker]("FundingCurrenc "FRR_AMOUNT_AVAILABLE" ]) -TickersHistory = _Serializer[types.TickersHistory]("TickersHistory", labels=[ +TickersHistory = generate_labeler_serializer("TickersHistory", klass=types.TickersHistory, labels=[ "SYMBOL", "BID", "_PLACEHOLDER", @@ -60,14 +60,14 @@ TickersHistory = _Serializer[types.TickersHistory]("TickersHistory", labels=[ "MTS" ]) -TradingPairTrade = _Serializer[types.TradingPairTrade]("TradingPairTrade", labels=[ +TradingPairTrade = generate_labeler_serializer("TradingPairTrade", klass=types.TradingPairTrade, labels=[ "ID", "MTS", "AMOUNT", "PRICE" ]) -FundingCurrencyTrade = _Serializer[types.FundingCurrencyTrade]("FundingCurrencyTrade", labels=[ +FundingCurrencyTrade = generate_labeler_serializer("FundingCurrencyTrade", klass=types.FundingCurrencyTrade, labels=[ "ID", "MTS", "AMOUNT", @@ -75,38 +75,38 @@ FundingCurrencyTrade = _Serializer[types.FundingCurrencyTrade]("FundingCurrencyT "PERIOD" ]) -TradingPairBook = _Serializer[types.TradingPairBook]("TradingPairBook", labels=[ +TradingPairBook = generate_labeler_serializer("TradingPairBook", klass=types.TradingPairBook, labels=[ "PRICE", "COUNT", "AMOUNT" ]) -FundingCurrencyBook = _Serializer[types.FundingCurrencyBook]("FundingCurrencyBook", labels=[ +FundingCurrencyBook = generate_labeler_serializer("FundingCurrencyBook", klass=types.FundingCurrencyBook, labels=[ "RATE", "PERIOD", "COUNT", "AMOUNT" ]) -TradingPairRawBook = _Serializer[types.TradingPairRawBook]("TradingPairRawBook", labels=[ +TradingPairRawBook = generate_labeler_serializer("TradingPairRawBook", klass=types.TradingPairRawBook, labels=[ "ORDER_ID", "PRICE", "AMOUNT" ]) -FundingCurrencyRawBook = _Serializer[types.FundingCurrencyRawBook]("FundingCurrencyRawBook", labels=[ +FundingCurrencyRawBook = generate_labeler_serializer("FundingCurrencyRawBook", klass=types.FundingCurrencyRawBook, labels=[ "OFFER_ID", "PERIOD", "RATE", "AMOUNT" ]) -Statistic = _Serializer[types.Statistic]("Statistic", labels=[ +Statistic = generate_labeler_serializer("Statistic", klass=types.Statistic, labels=[ "MTS", "VALUE" ]) -Candle = _Serializer[types.Candle]("Candle", labels=[ +Candle = generate_labeler_serializer("Candle", klass=types.Candle, labels=[ "MTS", "OPEN", "CLOSE", @@ -115,7 +115,7 @@ Candle = _Serializer[types.Candle]("Candle", labels=[ "VOLUME" ]) -DerivativesStatus = _Serializer[types.DerivativesStatus]("DerivativesStatus", labels=[ +DerivativesStatus = generate_labeler_serializer("DerivativesStatus", klass=types.DerivativesStatus, labels=[ "KEY", "MTS", "_PLACEHOLDER", @@ -142,7 +142,7 @@ DerivativesStatus = _Serializer[types.DerivativesStatus]("DerivativesStatus", la "CLAMP_MAX" ]) -Liquidation = _Serializer[types.Liquidation]("Liquidation", labels=[ +Liquidation = generate_labeler_serializer("Liquidation", klass=types.Liquidation, labels=[ "_PLACEHOLDER", "POS_ID", "MTS", @@ -157,7 +157,7 @@ Liquidation = _Serializer[types.Liquidation]("Liquidation", labels=[ "PRICE_ACQUIRED" ]) -Leaderboard = _Serializer[types.Leaderboard]("Leaderboard", labels=[ +Leaderboard = generate_labeler_serializer("Leaderboard", klass=types.Leaderboard, labels=[ "MTS", "_PLACEHOLDER", "USERNAME", @@ -170,7 +170,7 @@ Leaderboard = _Serializer[types.Leaderboard]("Leaderboard", labels=[ "TWITTER_HANDLE" ]) -FundingStatistic = _Serializer[types.FundingStatistic]("FundingStatistic", labels=[ +FundingStatistic = generate_labeler_serializer("FundingStatistic", klass=types.FundingStatistic, labels=[ "TIMESTAMP", "_PLACEHOLDER", "_PLACEHOLDER", @@ -189,7 +189,7 @@ FundingStatistic = _Serializer[types.FundingStatistic]("FundingStatistic", label #region Serializers definition for Rest Authenticated Endpoints -Wallet = _Serializer[types.Wallet]("Wallet", labels=[ +Wallet = generate_labeler_serializer("Wallet", klass=types.Wallet, labels=[ "WALLET_TYPE", "CURRENCY", "BALANCE", @@ -199,7 +199,7 @@ Wallet = _Serializer[types.Wallet]("Wallet", labels=[ "TRADE_DETAILS" ]) -Order = _Serializer[types.Order]("Order", labels=[ +Order = generate_labeler_serializer("Order", klass=types.Order, labels=[ "ID", "GID", "CID", @@ -234,7 +234,7 @@ Order = _Serializer[types.Order]("Order", labels=[ "META" ]) -Position = _Serializer[types.Position]("Position", labels=[ +Position = generate_labeler_serializer("Position", klass=types.Position, labels=[ "SYMBOL", "STATUS", "AMOUNT", @@ -257,7 +257,7 @@ Position = _Serializer[types.Position]("Position", labels=[ "META" ]) -FundingOffer = _Serializer[types.FundingOffer]("FundingOffer", labels=[ +FundingOffer = generate_labeler_serializer("FundingOffer", klass=types.FundingOffer, labels=[ "ID", "SYMBOL", "MTS_CREATED", @@ -281,7 +281,7 @@ FundingOffer = _Serializer[types.FundingOffer]("FundingOffer", labels=[ "_PLACEHOLDER" ]) -Trade = _Serializer[types.Trade]("Trade", labels=[ +Trade = generate_labeler_serializer("Trade", klass=types.Trade, labels=[ "ID", "PAIR", "MTS_CREATE", @@ -296,7 +296,7 @@ Trade = _Serializer[types.Trade]("Trade", labels=[ "CID" ]) -OrderTrade = _Serializer[types.OrderTrade]("OrderTrade", labels=[ +OrderTrade = generate_labeler_serializer("OrderTrade", klass=types.OrderTrade, labels=[ "ID", "PAIR", "MTS_CREATE", @@ -311,7 +311,7 @@ OrderTrade = _Serializer[types.OrderTrade]("OrderTrade", labels=[ "CID" ]) -Ledger = _Serializer[types.Ledger]("Ledger", labels=[ +Ledger = generate_labeler_serializer("Ledger", klass=types.Ledger, labels=[ "ID", "CURRENCY", "_PLACEHOLDER", @@ -323,7 +323,7 @@ Ledger = _Serializer[types.Ledger]("Ledger", labels=[ "DESCRIPTION" ]) -FundingCredit = _Serializer[types.FundingCredit]("FundingCredit", labels=[ +FundingCredit = generate_labeler_serializer("FundingCredit", klass=types.FundingCredit, labels=[ "ID", "SYMBOL", "SIDE", diff --git a/bfxapi/websocket/serializers.py b/bfxapi/websocket/serializers.py index 6bd56c1..1e14dbc 100644 --- a/bfxapi/websocket/serializers.py +++ b/bfxapi/websocket/serializers.py @@ -1,12 +1,12 @@ from . import types -from .. labeler import _Serializer +from .. labeler import generate_labeler_serializer from .. notification import _Notification #region Serializers definition for Websocket Public Channels -TradingPairTicker = _Serializer[types.TradingPairTicker]("TradingPairTicker", labels=[ +TradingPairTicker = generate_labeler_serializer("TradingPairTicker", klass=types.TradingPairTicker, labels=[ "BID", "BID_SIZE", "ASK", @@ -19,7 +19,7 @@ TradingPairTicker = _Serializer[types.TradingPairTicker]("TradingPairTicker", la "LOW" ]) -FundingCurrencyTicker = _Serializer[types.FundingCurrencyTicker]("FundingCurrencyTicker", labels=[ +FundingCurrencyTicker = generate_labeler_serializer("FundingCurrencyTicker", klass=types.FundingCurrencyTicker, labels=[ "FRR", "BID", "BID_PERIOD", @@ -38,14 +38,14 @@ FundingCurrencyTicker = _Serializer[types.FundingCurrencyTicker]("FundingCurrenc "FRR_AMOUNT_AVAILABLE" ]) -TradingPairTrade = _Serializer[types.TradingPairTrade]("TradingPairTrade", labels=[ +TradingPairTrade = generate_labeler_serializer("TradingPairTrade", klass=types.TradingPairTrade, labels=[ "ID", "MTS", "AMOUNT", "PRICE" ]) -FundingCurrencyTrade = _Serializer[types.FundingCurrencyTrade]("FundingCurrencyTrade", labels=[ +FundingCurrencyTrade = generate_labeler_serializer("FundingCurrencyTrade", klass=types.FundingCurrencyTrade, labels=[ "ID", "MTS", "AMOUNT", @@ -53,33 +53,33 @@ FundingCurrencyTrade = _Serializer[types.FundingCurrencyTrade]("FundingCurrencyT "PERIOD" ]) -TradingPairBook = _Serializer[types.TradingPairBook]("TradingPairBook", labels=[ +TradingPairBook = generate_labeler_serializer("TradingPairBook", klass=types.TradingPairBook, labels=[ "PRICE", "COUNT", "AMOUNT" ]) -FundingCurrencyBook = _Serializer[types.FundingCurrencyBook]("FundingCurrencyBook", labels=[ +FundingCurrencyBook = generate_labeler_serializer("FundingCurrencyBook", klass=types.FundingCurrencyBook, labels=[ "RATE", "PERIOD", "COUNT", "AMOUNT" ]) -TradingPairRawBook = _Serializer[types.TradingPairRawBook]("TradingPairRawBook", labels=[ +TradingPairRawBook = generate_labeler_serializer("TradingPairRawBook", klass=types.TradingPairRawBook, labels=[ "ORDER_ID", "PRICE", "AMOUNT" ]) -FundingCurrencyRawBook = _Serializer[types.FundingCurrencyRawBook]("FundingCurrencyRawBook", labels=[ +FundingCurrencyRawBook = generate_labeler_serializer("FundingCurrencyRawBook", klass=types.FundingCurrencyRawBook, labels=[ "OFFER_ID", "PERIOD", "RATE", "AMOUNT" ]) -Candle = _Serializer[types.Candle]("Candle", labels=[ +Candle = generate_labeler_serializer("Candle", klass=types.Candle, labels=[ "MTS", "OPEN", "CLOSE", @@ -88,7 +88,7 @@ Candle = _Serializer[types.Candle]("Candle", labels=[ "VOLUME" ]) -DerivativesStatus = _Serializer[types.DerivativesStatus]("DerivativesStatus", labels=[ +DerivativesStatus = generate_labeler_serializer("DerivativesStatus", klass=types.DerivativesStatus, labels=[ "TIME_MS", "_PLACEHOLDER", "DERIV_PRICE", @@ -118,7 +118,7 @@ DerivativesStatus = _Serializer[types.DerivativesStatus]("DerivativesStatus", la #region Serializers definition for Websocket Authenticated Channels -Order = _Serializer[types.Order]("Order", labels=[ +Order = generate_labeler_serializer("Order", klass=types.Order, labels=[ "ID", "GID", "CID", @@ -153,7 +153,7 @@ Order = _Serializer[types.Order]("Order", labels=[ "META" ]) -Position = _Serializer[types.Position]("Position", labels=[ +Position = generate_labeler_serializer("Position", klass=types.Position, labels=[ "SYMBOL", "STATUS", "AMOUNT", @@ -176,7 +176,7 @@ Position = _Serializer[types.Position]("Position", labels=[ "META" ]) -TradeExecuted = _Serializer[types.TradeExecuted]("TradeExecuted", labels=[ +TradeExecuted = generate_labeler_serializer("TradeExecuted", klass=types.TradeExecuted, labels=[ "ID", "SYMBOL", "MTS_CREATE", @@ -191,7 +191,7 @@ TradeExecuted = _Serializer[types.TradeExecuted]("TradeExecuted", labels=[ "CID" ]) -TradeExecutionUpdate = _Serializer[types.TradeExecutionUpdate]("TradeExecutionUpdate", labels=[ +TradeExecutionUpdate = generate_labeler_serializer("TradeExecutionUpdate", klass=types.TradeExecutionUpdate, labels=[ "ID", "SYMBOL", "MTS_CREATE", @@ -206,7 +206,7 @@ TradeExecutionUpdate = _Serializer[types.TradeExecutionUpdate]("TradeExecutionUp "CID" ]) -FundingOffer = _Serializer[types.FundingOffer]("FundingOffer", labels=[ +FundingOffer = generate_labeler_serializer("FundingOffer", klass=types.FundingOffer, labels=[ "ID", "SYMBOL", "MTS_CREATED", @@ -230,7 +230,7 @@ FundingOffer = _Serializer[types.FundingOffer]("FundingOffer", labels=[ "_PLACEHOLDER" ]) -FundingCredit = _Serializer[types.FundingCredit]("FundingCredit", labels=[ +FundingCredit = generate_labeler_serializer("FundingCredit", klass=types.FundingCredit, labels=[ "ID", "SYMBOL", "SIDE", @@ -255,7 +255,7 @@ FundingCredit = _Serializer[types.FundingCredit]("FundingCredit", labels=[ "POSITION_PAIR" ]) -FundingLoan = _Serializer[types.FundingLoan]("FundingLoan", labels=[ +FundingLoan = generate_labeler_serializer("FundingLoan", klass=types.FundingLoan, labels=[ "ID", "SYMBOL", "SIDE", @@ -279,7 +279,7 @@ FundingLoan = _Serializer[types.FundingLoan]("FundingLoan", labels=[ "NO_CLOSE" ]) -Wallet = _Serializer[types.Wallet]("Wallet", labels=[ +Wallet = generate_labeler_serializer("Wallet", klass=types.Wallet, labels=[ "WALLET_TYPE", "CURRENCY", "BALANCE", @@ -289,7 +289,7 @@ Wallet = _Serializer[types.Wallet]("Wallet", labels=[ "META" ]) -BalanceInfo = _Serializer[types.BalanceInfo]("BalanceInfo", labels=[ +BalanceInfo = generate_labeler_serializer("BalanceInfo", klass=types.BalanceInfo, labels=[ "AUM", "AUM_NET", ]) From 6f8e37cad0d70edce37441bd6f1cfd3137d107ac Mon Sep 17 00:00:00 2001 From: Davide Casale Date: Mon, 16 Jan 2023 18:27:03 +0100 Subject: [PATCH 6/6] Fix all mypy errors and warnings due to new dataclass implementation. --- bfxapi/labeler.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bfxapi/labeler.py b/bfxapi/labeler.py index 38b527b..87889e2 100644 --- a/bfxapi/labeler.py +++ b/bfxapi/labeler.py @@ -2,7 +2,7 @@ from .exceptions import LabelerSerializerException from typing import Type, Generic, TypeVar, Iterable, Optional, List, Tuple, Any, cast -T = TypeVar("T") +T = TypeVar("T", bound="_Type") class _Type(object): def __init__(self, **kwargs): @@ -26,5 +26,5 @@ class _Serializer(Generic[T]): def parse(self, *values: Any, skip: Optional[List[str]] = None) -> T: return cast(T, self.klass(**dict(self._serialize(*values, skip=skip)))) -def generate_labeler_serializer(name: str, klass: T, labels: List[str], IGNORE: List[str] = [ "_PLACEHOLDER" ]) -> _Serializer[T]: +def generate_labeler_serializer(name: str, klass: Type[T], labels: List[str], IGNORE: List[str] = [ "_PLACEHOLDER" ]) -> _Serializer[T]: return _Serializer[T](name, klass, labels, IGNORE) \ No newline at end of file