unicex 0.13.17__py3-none-any.whl

unicex/_abc/uni_client.py

@@ -0,0 +1,329 @@
+__all__ = ["IUniClient"]
+
+from abc import ABC, abstractmethod
+from typing import Generic, Self, TypeVar, overload
+
+import aiohttp
+
+from unicex._base import BaseClient
+from unicex.enums import Timeframe
+from unicex.types import KlineDict, LoggerLike, OpenInterestDict, OpenInterestItem, TickerDailyDict
+from unicex.utils import batched_list
+
+TClient = TypeVar("TClient", bound="BaseClient")
+
+
+class IUniClient(ABC, Generic[TClient]):
+    """Интерфейс для реализации асинхронного унифицированного клиента."""
+
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        api_key: str | None = None,
+        api_secret: str | None = None,
+        api_passphrase: str | None = None,
+        logger: LoggerLike | None = None,
+        max_retries: int = 3,
+        retry_delay: int | float = 0.1,
+        proxies: list[str] | None = None,
+        timeout: int = 10,
+    ) -> None:
+        """Инициализация клиента.
+
+        Параметры:
+            api_key (`str | None`): Ключ API для аутентификации.
+            api_secret (`str | None`): Секретный ключ API для аутентификации.
+            api_passphrase (`str | None`): Пароль API для аутентификации (Bitget).
+            session (`aiohttp.ClientSession`): Сессия для выполнения HTTP-запросов.
+            logger (`LoggerLike | None`): Логгер для вывода информации.
+            max_retries (`int`): Максимальное количество повторных попыток запроса.
+            retry_delay (`int | float`): Задержка между повторными попытками.
+            proxies (`list[str] | None`): Список HTTP(S) прокси для циклического использования.
+            timeout (`int`): Максимальное время ожидания ответа от сервера.
+        """
+        self._client: TClient = self._client_cls(
+            api_key=api_key,
+            api_secret=api_secret,
+            api_passphrase=api_passphrase,
+            session=session,
+            logger=logger,
+            max_retries=max_retries,
+            retry_delay=retry_delay,
+            proxies=proxies,
+            timeout=timeout,
+        )
+
+    @classmethod
+    async def create(
+        cls,
+        api_key: str | None = None,
+        api_secret: str | None = None,
+        api_passphrase: str | None = None,
+        session: aiohttp.ClientSession | None = None,
+        logger: LoggerLike | None = None,
+        max_retries: int = 3,
+        retry_delay: int | float = 0.1,
+        proxies: list[str] | None = None,
+        timeout: int = 10,
+    ) -> Self:
+        """Создает инстанцию клиента.
+        Создать клиент можно и через __init__, но в таком случае session: `aiohttp.ClientSession` - обязательный параметр.
+
+        Параметры:
+            api_key (`str | None`): Ключ API для аутентификации.
+            api_secret (`str | None`): Секретный ключ API для аутентификации.
+            api_passphrase (`str | None`): Пароль API для аутентификации (Bitget).
+            session (`aiohttp.ClientSession | None`): Сессия для выполнения HTTP-запросов.
+            logger (`LoggerLike | None`): Логгер для вывода информации.
+            max_retries (`int`): Максимальное количество повторных попыток запроса.
+            retry_delay (`int | float`): Задержка между повторными попытками.
+            proxies (`list[str] | None`): Список HTTP(S) прокси для циклического использования.
+            timeout (`int`): Максимальное время ожидания ответа от сервера.
+
+        Возвращает:
+            `IUniClient`: Созданный экземпляр клиента.
+        """
+        return cls(
+            session=session or aiohttp.ClientSession(),
+            api_key=api_key,
+            api_secret=api_secret,
+            api_passphrase=api_passphrase,
+            logger=logger,
+            max_retries=max_retries,
+            retry_delay=retry_delay,
+            proxies=proxies,
+            timeout=timeout,
+        )
+
+    @classmethod
+    def from_client(cls, client: TClient) -> Self:
+        """Создает UniClient из уже существующего Client.
+
+        Параметры:
+            client (`TClient`): Экземпляр Client.
+
+        Возвращает:
+            `Self`: Созданный экземпляр клиента.
+        """
+        instance = cls.__new__(cls)  # создаем пустой объект без вызова __init__
+        instance._client = client
+        return instance
+
+    def is_authorized(self) -> bool:
+        """Проверяет, наличие апи ключей в инстансе клиента.
+
+        Возвращает:
+            `bool`: True, если апи ключи присутствуют, иначе False.
+        """
+        return self._client.is_authorized()
+
+    async def close_connection(self) -> None:
+        """Закрывает сессию клиента."""
+        await self._client.close_connection()
+
+    async def __aenter__(self) -> Self:
+        """Вход в асинхронный контекст."""
+        return self
+
+    async def __aexit__(self, *_) -> None:
+        """Выход из асинхронного контекста."""
+        await self.close_connection()
+
+    @property
+    def client(self) -> TClient:
+        """Возвращает клиент биржи.
+
+        Возвращает:
+            `TClient`: Клиент биржи.
+        """
+        return self._client
+
+    @property
+    @abstractmethod
+    def _client_cls(self) -> type[TClient]:
+        """Возвращает класс клиента для конкретной биржи.
+
+        Возвращает:
+            `type[TClient]`: Класс клиента.
+        """
+        ...
+
+    @abstractmethod
+    async def tickers(self, only_usdt: bool = True) -> list[str]:
+        """Возвращает список тикеров.
+
+        Параметры:
+            only_usdt (`bool`): Если True, возвращает только тикеры в паре к USDT.
+
+        Возвращает:
+            `list[str]`: Список тикеров.
+        """
+        ...
+
+    async def tickers_batched(
+        self, only_usdt: bool = True, batch_size: int = 20
+    ) -> list[list[str]]:
+        """Возвращает список тикеров в чанках.
+
+        Параметры:
+            only_usdt (`bool`): Если True, возвращает только тикеры в паре к USDT.
+            batch_size (`int`): Размер чанка.
+
+        Возвращает:
+            `list[list[str]]`: Список тикеров в чанках.
+        """
+        tickers = await self.tickers(only_usdt)
+        return batched_list(tickers, batch_size)
+
+    @abstractmethod
+    async def futures_tickers(self, only_usdt: bool = True) -> list[str]:
+        """Возвращает список тикеров.
+
+        Параметры:
+            only_usdt (`bool`): Если True, возвращает только тикеры в паре к USDT.
+
+        Возвращает:
+            `list[str]`: Список тикеров.
+        """
+        ...
+
+    async def futures_tickers_batched(
+        self, only_usdt: bool = True, batch_size: int = 20
+    ) -> list[list[str]]:
+        """Возвращает список тикеров в чанках.
+
+        Параметры:
+            only_usdt (`bool`): Если True, возвращает только тикеры в паре к USDT.
+            batch_size (`int`): Размер чанка.
+
+        Возвращает:
+            `list[list[str]]`: Список тикеров в чанках.
+        """
+        tickers = await self.futures_tickers(only_usdt)
+        return batched_list(tickers, batch_size)
+
+    @abstractmethod
+    async def last_price(self) -> dict[str, float]:
+        """Возвращает последнюю цену для каждого тикера.
+
+        Возвращает:
+            `dict[str, float]`: Словарь с последними ценами для каждого тикера.
+        """
+        ...
+
+    @abstractmethod
+    async def futures_last_price(self) -> dict[str, float]:
+        """Возвращает последнюю цену для каждого тикера.
+
+        Возвращает:
+            `dict[str, float]`: Словарь с последними ценами для каждого тикера.
+        """
+        ...
+
+    @abstractmethod
+    async def ticker_24hr(self) -> TickerDailyDict:
+        """Возвращает статистику за последние 24 часа для каждого тикера.
+
+        Возвращает:
+            `TickerDailyDict`: Словарь с статистикой за последние 24 часа для каждого тикера.
+        """
+        ...
+
+    @abstractmethod
+    async def futures_ticker_24hr(self) -> TickerDailyDict:
+        """Возвращает статистику за последние 24 часа для каждого тикера.
+
+        Возвращает:
+            `TickerDailyDict`: Словарь с статистикой за последние 24 часа для каждого тикера.
+        """
+        ...
+
+    @abstractmethod
+    async def klines(
+        self,
+        symbol: str,
+        interval: Timeframe | str,
+        limit: int | None = None,
+        start_time: int | None = None,
+        end_time: int | None = None,
+    ) -> list[KlineDict]:
+        """Возвращает список свечей.
+
+        Параметры:
+            symbol (`str`): Название тикера.
+            interval (`Timeframe`): Таймфрейм свечей.
+            limit (`int`): Количество свечей.
+            start_time (`int`): Время начала периода в миллисекундах.
+            end_time (`int`): Время окончания периода в миллисекундах.
+
+        Возвращает:
+            `list[KlineDict]`: Список свечей.
+        """
+        ...
+
+    @abstractmethod
+    async def futures_klines(
+        self,
+        symbol: str,
+        interval: Timeframe | str,
+        limit: int | None = None,
+        start_time: int | None = None,
+        end_time: int | None = None,
+    ) -> list[KlineDict]:
+        """Возвращает список свечей.
+
+        Параметры:
+            symbol (`str`): Название тикера.
+            interval (`Timeframe`): Таймфрейм свечей.
+            limit (`int`): Количество свечей.
+            start_time (`int`): Время начала периода в миллисекундах.
+            end_time (`int`): Время окончания периода в миллисекундах.
+
+        Возвращает:
+            `list[KlineDict]`: Список свечей.
+        """
+        ...
+
+    @overload
+    async def funding_rate(self, symbol: str) -> float: ...
+
+    @overload
+    async def funding_rate(self, symbol: None) -> dict[str, float]: ...
+
+    @overload
+    async def funding_rate(self) -> dict[str, float]: ...
+
+    @abstractmethod
+    async def funding_rate(self, symbol: str | None = None) -> dict[str, float] | float:
+        """Возвращает ставку финансирования для тикера или всех тикеров, если тикер не указан.
+
+        Параметры:
+            symbol (`str | None`): Название тикера (Опционально).
+
+        Возвращает:
+            `dict[str, float] | float`: Ставка финансирования для тикера или словарь со ставками для всех тикеров.
+        """
+        ...
+
+    @overload
+    async def open_interest(self, symbol: str) -> OpenInterestItem: ...
+
+    @overload
+    async def open_interest(self, symbol: None) -> OpenInterestDict: ...
+
+    @overload
+    async def open_interest(self) -> OpenInterestDict: ...
+
+    @abstractmethod
+    async def open_interest(self, symbol: str | None = None) -> OpenInterestItem | OpenInterestDict:
+        """Возвращает объем открытого интереса для тикера или всех тикеров, если тикер не указан.
+
+        Параметры:
+            symbol (`str | None`): Название тикера (Опционально, но обязателен для следующих бирж: BINANCE).
+
+        Возвращает:
+            `OpenInterestItem | OpenInterestDict`: Если тикер передан - словарь со временем и объемом
+                открытого интереса в монетах. Если нет передан - то словарь, в котором ключ - тикер,
+                а значение - словарь с временем и объемом открытого интереса в монетах.
+        """
+        ...

unicex/_abc/uni_websocket_manager.py

@@ -0,0 +1,294 @@
+__all__ = ["IUniWebsocketManager"]
+
+from abc import ABC, abstractmethod
+from collections.abc import Awaitable, Callable, Sequence
+from typing import Any, overload
+
+from loguru import logger as _logger
+
+from unicex._base import BaseClient, Websocket
+from unicex.enums import Timeframe
+from unicex.types import LoggerLike
+
+from .uni_client import IUniClient
+
+type CallbackType = Callable[[Any], Awaitable[None]]
+
+
+class IUniWebsocketManager(ABC):
+    """Интерфейс менеджера асинхронных унифицированных вебсокетов."""
+
+    def __init__(
+        self, client: BaseClient | IUniClient | None = None, logger: LoggerLike | None = None
+    ) -> None:
+        """Инициализирует унифицированный менеджер вебсокетов.
+
+        Параметры:
+            client (`BaseClient | IUniClient | None`): Клиент или унифицированный клиент. Нужен для подключения к приватным топикам.
+            logger (`LoggerLike | None`): Логгер для записи логов.
+        """
+        if isinstance(client, IUniClient):
+            client = client.client
+        self._client = client
+        self._logger = logger or _logger
+
+    def _make_wrapper(
+        self, adapter_func: Callable[[dict], Any], callback: CallbackType
+    ) -> CallbackType:
+        """Создает обертку над callback, применяя адаптер к сырым сообщениям."""
+
+        async def _wrapper(raw_msg: dict) -> None:
+            try:
+                adapted = adapter_func(raw_msg)
+            except Exception as e:
+                self._logger.warning(f"Failed to adapt message: {e}")
+                return
+            if isinstance(adapted, list):
+                for item in adapted:
+                    await callback(item)
+            else:
+                await callback(adapted)
+
+        return _wrapper
+
+    @overload
+    def klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    @abstractmethod
+    def klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим свечей (spot) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            timeframe (`Timeframe`): Временной интервал свечей.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета для управления соединением.
+        """
+        ...
+
+    @overload
+    def futures_klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def futures_klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    @abstractmethod
+    def futures_klines(
+        self,
+        callback: CallbackType,
+        timeframe: Timeframe,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим свечей (futures) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            timeframe (`Timeframe`): Временной интервал свечей.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета.
+        """
+        ...
+
+    @overload
+    def trades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def trades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    @abstractmethod
+    def trades(
+        self,
+        callback: CallbackType,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим сделок (spot) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета.
+        """
+        ...
+
+    @overload
+    def aggtrades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def aggtrades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    @abstractmethod
+    def aggtrades(
+        self,
+        callback: CallbackType,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим агрегированных сделок (spot) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета.
+        """
+        ...
+
+    @overload
+    def futures_trades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def futures_trades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    @abstractmethod
+    def futures_trades(
+        self,
+        callback: CallbackType,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим сделок (futures) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета.
+        """
+        ...
+
+    @overload
+    def futures_aggtrades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: str,
+        symbols: None = None,
+    ) -> Websocket: ...
+
+    @overload
+    def futures_aggtrades(
+        self,
+        callback: CallbackType,
+        *,
+        symbol: None = None,
+        symbols: Sequence[str],
+    ) -> Websocket: ...
+
+    @abstractmethod
+    def futures_aggtrades(
+        self,
+        callback: CallbackType,
+        symbol: str | None = None,
+        symbols: Sequence[str] | None = None,
+    ) -> Websocket:
+        """Открывает стрим агрегированных сделок (futures) с унификацией сообщений.
+
+        Параметры:
+            callback (`CallbackType`): Асинхронная функция обратного вызова для обработки сообщений.
+            symbol (`str | None`): Один символ для подписки.
+            symbols (`Sequence[str] | None`): Список символов для мультиплекс‑подключения.
+
+        Должен быть указан либо `symbol`, либо `symbols`.
+
+        Возвращает:
+            `Websocket`: Экземпляр вебсокета.
+        """
+        ...

unicex/_base/__init__.py

@@ -0,0 +1,9 @@
+"""Пакет с базовым клиентом для HTTP запросов и базовым вебсокетом."""
+
+__all__ = [
+    "BaseClient",
+    "Websocket",
+]
+
+from .client import BaseClient
+from .websocket import Websocket