crypticorn 2.4.6__py3-none-any.whl → 2.5.0__py3-none-any.whl

crypticorn/klines/client/rest.py

@@ -16,23 +16,16 @@ import io
 import json
 import re
 import ssl
+from typing import Optional, Union
 
-import urllib3
+import aiohttp
+import aiohttp_retry
 
 from crypticorn.klines.client.exceptions import ApiException, ApiValueError
 
-SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
-RESTResponseType = urllib3.HTTPResponse
+RESTResponseType = aiohttp.ClientResponse
 
-
-def is_socks_proxy_url(url):
-    if url is None:
-        return False
-    split_section = url.split("://")
-    if len(split_section) < 2:
-        return False
-    else:
-        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+ALLOW_RETRY_METHODS = frozenset({"DELETE", "GET", "HEAD", "OPTIONS", "PUT", "TRACE"})
 
 
 class RESTResponse(io.IOBase):
@@ -43,13 +36,13 @@ class RESTResponse(io.IOBase):
         self.reason = resp.reason
         self.data = None
 
-    def read(self):
+    async def read(self):
         if self.data is None:
-            self.data = self.response.data
+            self.data = await self.response.read()
         return self.data
 
     def getheaders(self):
-        """Returns a dictionary of the response headers."""
+        """Returns a CIMultiDictProxy of the response headers."""
         return self.response.headers
 
     def getheader(self, name, default=None):
@@ -60,56 +53,38 @@ class RESTResponse(io.IOBase):
 class RESTClientObject:
 
     def __init__(self, configuration) -> None:
-        # urllib3.PoolManager will pass all kw parameters to connectionpool
-        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
-        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
-        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
-
-        # cert_reqs
-        if configuration.verify_ssl:
-            cert_reqs = ssl.CERT_REQUIRED
-        else:
-            cert_reqs = ssl.CERT_NONE
-
-        pool_args = {
-            "cert_reqs": cert_reqs,
-            "ca_certs": configuration.ssl_ca_cert,
-            "cert_file": configuration.cert_file,
-            "key_file": configuration.key_file,
-        }
-        if configuration.assert_hostname is not None:
-            pool_args["assert_hostname"] = configuration.assert_hostname
-
-        if configuration.retries is not None:
-            pool_args["retries"] = configuration.retries
-
-        if configuration.tls_server_name:
-            pool_args["server_hostname"] = configuration.tls_server_name
-
-        if configuration.socket_options is not None:
-            pool_args["socket_options"] = configuration.socket_options
-
-        if configuration.connection_pool_maxsize is not None:
-            pool_args["maxsize"] = configuration.connection_pool_maxsize
 
-        # https pool manager
-        self.pool_manager: urllib3.PoolManager
+        # maxsize is number of requests to host that are allowed in parallel
+        self.maxsize = configuration.connection_pool_maxsize
 
-        if configuration.proxy:
-            if is_socks_proxy_url(configuration.proxy):
-                from urllib3.contrib.socks import SOCKSProxyManager
+        self.ssl_context = ssl.create_default_context(
+            cafile=configuration.ssl_ca_cert,
+            cadata=configuration.ca_cert_data,
+        )
+        if configuration.cert_file:
+            self.ssl_context.load_cert_chain(
+                configuration.cert_file, keyfile=configuration.key_file
+            )
 
-                pool_args["proxy_url"] = configuration.proxy
-                pool_args["headers"] = configuration.proxy_headers
-                self.pool_manager = SOCKSProxyManager(**pool_args)
-            else:
-                pool_args["proxy_url"] = configuration.proxy
-                pool_args["proxy_headers"] = configuration.proxy_headers
-                self.pool_manager = urllib3.ProxyManager(**pool_args)
-        else:
-            self.pool_manager = urllib3.PoolManager(**pool_args)
+        if not configuration.verify_ssl:
+            self.ssl_context.check_hostname = False
+            self.ssl_context.verify_mode = ssl.CERT_NONE
+
+        self.proxy = configuration.proxy
+        self.proxy_headers = configuration.proxy_headers
+
+        self.retries = configuration.retries
+
+        self.pool_manager: Optional[aiohttp.ClientSession] = None
+        self.retry_client: Optional[aiohttp_retry.RetryClient] = None
 
-    def request(
+    async def close(self) -> None:
+        if self.pool_manager:
+            await self.pool_manager.close()
+        if self.retry_client is not None:
+            await self.retry_client.close()
+
+    async def request(
         self,
         method,
         url,
@@ -118,7 +93,7 @@ class RESTClientObject:
         post_params=None,
         _request_timeout=None,
     ):
-        """Perform requests.
+        """Execute request
 
         :param method: http request method
         :param url: http request url
@@ -142,105 +117,82 @@ class RESTClientObject:
 
         post_params = post_params or {}
         headers = headers or {}
+        # url already contains the URL query string
+        timeout = _request_timeout or 5 * 60
+
+        if "Content-Type" not in headers:
+            headers["Content-Type"] = "application/json"
+
+        args = {"method": method, "url": url, "timeout": timeout, "headers": headers}
+
+        if self.proxy:
+            args["proxy"] = self.proxy
+        if self.proxy_headers:
+            args["proxy_headers"] = self.proxy_headers
+
+        # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+        if method in ["POST", "PUT", "PATCH", "OPTIONS", "DELETE"]:
+            if re.search("json", headers["Content-Type"], re.IGNORECASE):
+                if body is not None:
+                    body = json.dumps(body)
+                args["data"] = body
+            elif headers["Content-Type"] == "application/x-www-form-urlencoded":
+                args["data"] = aiohttp.FormData(post_params)
+            elif headers["Content-Type"] == "multipart/form-data":
+                # must del headers['Content-Type'], or the correct
+                # Content-Type which generated by aiohttp
+                del headers["Content-Type"]
+                data = aiohttp.FormData()
+                for param in post_params:
+                    k, v = param
+                    if isinstance(v, tuple) and len(v) == 3:
+                        data.add_field(k, value=v[1], filename=v[0], content_type=v[2])
+                    else:
+                        # Ensures that dict objects are serialized
+                        if isinstance(v, dict):
+                            v = json.dumps(v)
+                        elif isinstance(v, int):
+                            v = str(v)
+                        data.add_field(k, v)
+                args["data"] = data
+
+            # Pass a `bytes` or `str` parameter directly in the body to support
+            # other content types than Json when `body` argument is provided
+            # in serialized form
+            elif isinstance(body, str) or isinstance(body, bytes):
+                args["data"] = body
+            else:
+                # Cannot generate the request from given parameters
+                msg = """Cannot prepare a request message for provided
+                         arguments. Please check that your arguments match
+                         declared content type."""
+                raise ApiException(status=0, reason=msg)
 
-        timeout = None
-        if _request_timeout:
-            if isinstance(_request_timeout, (int, float)):
-                timeout = urllib3.Timeout(total=_request_timeout)
-            elif isinstance(_request_timeout, tuple) and len(_request_timeout) == 2:
-                timeout = urllib3.Timeout(
-                    connect=_request_timeout[0], read=_request_timeout[1]
-                )
+        pool_manager: Union[aiohttp.ClientSession, aiohttp_retry.RetryClient]
 
-        try:
-            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
-            if method in ["POST", "PUT", "PATCH", "OPTIONS", "DELETE"]:
-
-                # no content type provided or payload is json
-                content_type = headers.get("Content-Type")
-                if not content_type or re.search("json", content_type, re.IGNORECASE):
-                    request_body = None
-                    if body is not None:
-                        request_body = json.dumps(body)
-                    r = self.pool_manager.request(
-                        method,
-                        url,
-                        body=request_body,
-                        timeout=timeout,
-                        headers=headers,
-                        preload_content=False,
-                    )
-                elif content_type == "application/x-www-form-urlencoded":
-                    r = self.pool_manager.request(
-                        method,
-                        url,
-                        fields=post_params,
-                        encode_multipart=False,
-                        timeout=timeout,
-                        headers=headers,
-                        preload_content=False,
-                    )
-                elif content_type == "multipart/form-data":
-                    # must del headers['Content-Type'], or the correct
-                    # Content-Type which generated by urllib3 will be
-                    # overwritten.
-                    del headers["Content-Type"]
-                    # Ensures that dict objects are serialized
-                    post_params = [
-                        (a, json.dumps(b)) if isinstance(b, dict) else (a, b)
-                        for a, b in post_params
-                    ]
-                    r = self.pool_manager.request(
-                        method,
-                        url,
-                        fields=post_params,
-                        encode_multipart=True,
-                        timeout=timeout,
-                        headers=headers,
-                        preload_content=False,
-                    )
-                # Pass a `string` parameter directly in the body to support
-                # other content types than JSON when `body` argument is
-                # provided in serialized form.
-                elif isinstance(body, str) or isinstance(body, bytes):
-                    r = self.pool_manager.request(
-                        method,
-                        url,
-                        body=body,
-                        timeout=timeout,
-                        headers=headers,
-                        preload_content=False,
-                    )
-                elif headers["Content-Type"].startswith("text/") and isinstance(
-                    body, bool
-                ):
-                    request_body = "true" if body else "false"
-                    r = self.pool_manager.request(
-                        method,
-                        url,
-                        body=request_body,
-                        preload_content=False,
-                        timeout=timeout,
-                        headers=headers,
-                    )
-                else:
-                    # Cannot generate the request from given parameters
-                    msg = """Cannot prepare a request message for provided
-                             arguments. Please check that your arguments match
-                             declared content type."""
-                    raise ApiException(status=0, reason=msg)
-            # For `GET`, `HEAD`
-            else:
-                r = self.pool_manager.request(
-                    method,
-                    url,
-                    fields={},
-                    timeout=timeout,
-                    headers=headers,
-                    preload_content=False,
+        # https pool manager
+        if self.pool_manager is None:
+            self.pool_manager = aiohttp.ClientSession(
+                connector=aiohttp.TCPConnector(
+                    limit=self.maxsize, ssl=self.ssl_context
+                ),
+                trust_env=True,
+            )
+        pool_manager = self.pool_manager
+
+        if self.retries is not None and method in ALLOW_RETRY_METHODS:
+            if self.retry_client is None:
+                self.retry_client = aiohttp_retry.RetryClient(
+                    client_session=self.pool_manager,
+                    retry_options=aiohttp_retry.ExponentialRetry(
+                        attempts=self.retries,
+                        factor=2.0,
+                        start_timeout=0.1,
+                        max_timeout=120.0,
+                    ),
                 )
-        except urllib3.exceptions.SSLError as e:
-            msg = "\n".join([type(e).__name__, str(e)])
-            raise ApiException(status=0, reason=msg)
+            pool_manager = self.retry_client
+
+        r = await pool_manager.request(**args)
 
         return RESTResponse(r)

crypticorn/klines/main.py

@@ -1,4 +1,4 @@
-import pandas as pd
+from __future__ import annotations
 from crypticorn.klines import (
     ApiClient,
     Configuration,
@@ -8,16 +8,22 @@ from crypticorn.klines import (
     SymbolsApi,
     UDFApi,
 )
+from crypticorn.common import optional_import
 
 
 class FundingRatesApiWrapper(FundingRatesApi):
     """
     A wrapper for the FundingRatesApi class.
     """
-
-    def get_funding_rates_fmt(self):
-        response = self.funding_rate_funding_rates_symbol_get()
-        return pd.DataFrame(response.json())
+    async def get_funding_rates_fmt(self, *args, **kwargs) -> pd.DataFrame:  # type: ignore
+        """
+        Get the funding rates in a pandas DataFrame.
+        """
+        pd = optional_import("pandas", "extra")
+        response = await self.get_funding_rates_without_preload_content(*args, **kwargs)
+        response.raise_for_status()
+        json_data = await response.json()
+        return pd.DataFrame(json_data)
 
 
 class OHLCVDataApiWrapper(OHLCVDataApi):
@@ -25,9 +31,22 @@ class OHLCVDataApiWrapper(OHLCVDataApi):
     A wrapper for the OHLCVDataApi class.
     """
 
-    def get_ohlcv_data_fmt(self):
-        response = self.get_ohlcv_market_timeframe_symbol_get()
-        return pd.DataFrame(response.json())
+    async def get_ohlcv_data_fmt(self, *args, **kwargs) -> pd.DataFrame:  # type: ignore
+        """
+        Get the OHLCV data in a pandas DataFrame.
+        """
+        pd = optional_import("pandas", "extra")
+        response = await self.get_ohlcv_without_preload_content(*args, **kwargs)
+        response.raise_for_status()
+        json_data = await response.json()
+        return pd.DataFrame({
+                    "timestamp": json_data["timestamp"],
+                    "open": json_data["open"],
+                    "high": json_data["high"],
+                    "low": json_data["low"],
+                    "close": json_data["close"],
+                    "volume": json_data["volume"]
+                })
 
 
 class SymbolsApiWrapper(SymbolsApi):
@@ -35,19 +54,15 @@ class SymbolsApiWrapper(SymbolsApi):
     A wrapper for the SymbolsApi class.
     """
 
-    def get_symbols_fmt(self):
-        response = self.symbols_symbols_market_get()
-        return pd.DataFrame(response.json())
-
-
-class UDFApiWrapper(UDFApi):
-    """
-    A wrapper for the UDFApi class.
-    """
-
-    def get_udf_fmt(self):
-        response = self.get_history_udf_history_get()
-        return pd.DataFrame(response.json())
+    async def get_symbols_fmt(self, *args, **kwargs) -> pd.DataFrame:  # type: ignore
+        """
+        Get the symbols in a pandas DataFrame.
+        """
+        pd = optional_import("pandas", "extra")
+        response = await self.get_klines_symbols_without_preload_content(*args, **kwargs)
+        response.raise_for_status()
+        json_data = await response.json()
+        return pd.DataFrame(json_data["data"], columns=["symbol"])
 
 
 class KlinesClient:
@@ -65,5 +80,5 @@ class KlinesClient:
         self.funding = FundingRatesApiWrapper(self.base_client)
         self.ohlcv = OHLCVDataApiWrapper(self.base_client)
         self.symbols = SymbolsApiWrapper(self.base_client)
-        self.udf = UDFApiWrapper(self.base_client)
+        self.udf = UDFApi(self.base_client)
         self.health = HealthCheckApi(self.base_client)

crypticorn/metrics/main.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from crypticorn.metrics import (
     ApiClient,
     Configuration,
@@ -10,12 +11,11 @@ from crypticorn.metrics import (
     TokensApi,
     MarketType,
 )
+from crypticorn.common import optional_import
 from pydantic import StrictStr, StrictInt, Field
 from typing_extensions import Annotated
 from typing import Optional
 
-import pandas as pd
-
 
 class MetricsClient:
     """
@@ -43,41 +43,16 @@ class MarketcapApiWrapper(MarketcapApi):
     A wrapper for the MarketcapApi class.
     """
 
-    async def get_marketcap_symbols_fmt(
-        self,
-        start_timestamp: Annotated[
-            Optional[StrictInt], Field(description="Start timestamp")
-        ] = None,
-        end_timestamp: Annotated[
-            Optional[StrictInt], Field(description="End timestamp")
-        ] = None,
-        interval: Annotated[
-            Optional[StrictStr],
-            Field(description="Interval for which to fetch symbols and marketcap data"),
-        ] = None,
-        market: Annotated[
-            Optional[MarketType],
-            Field(description="Market for which to fetch symbols and marketcap data"),
-        ] = None,
-        exchange: Annotated[
-            Optional[StrictStr],
-            Field(description="Exchange for which to fetch symbols and marketcap data"),
-        ] = None,
-    ) -> pd.DataFrame:
+    async def get_marketcap_symbols_fmt(self, *args, **kwargs) -> pd.DataFrame:  # type: ignore
         """
         Get the marketcap symbols in a pandas dataframe
         """
-        response = await self.get_marketcap_symbols_without_preload_content(
-            start_timestamp=start_timestamp,
-            end_timestamp=end_timestamp,
-            interval=interval,
-            market=market,
-            exchange=exchange,
-        )
+        pd = optional_import("pandas", "extra")
+        response = await self.get_marketcap_symbols_without_preload_content(*args, **kwargs)
+        response.raise_for_status()
         json_response = await response.json()
         df = pd.DataFrame(json_response["data"])
         df.rename(columns={df.columns[0]: "timestamp"}, inplace=True)
-        df["timestamp"] = pd.to_datetime(df["timestamp"]).astype("int64") // 10**9
         return df
 
 
@@ -86,18 +61,43 @@ class TokensApiWrapper(TokensApi):
     A wrapper for the TokensApi class.
     """
 
-    async def get_tokens_fmt(
-        self,
-        token_type: Annotated[
-            StrictStr,
-            Field(description="Type of tokens to fetch"),
-        ],
-    ) -> pd.DataFrame:
+    async def get_stable_and_wrapped_tokens_fmt(self, *args, **kwargs) -> pd.DataFrame:  # type: ignore
         """
         Get the tokens in a pandas dataframe
         """
-        response = await self.get_stable_and_wrapped_tokens_without_preload_content(
-            token_type=token_type
-        )
+        pd = optional_import("pandas", "extra")
+        response = await self.get_stable_and_wrapped_tokens_without_preload_content(*args, **kwargs)
+        response.raise_for_status()
+        json_data = await response.json()
+        return pd.DataFrame(json_data)
+
+class ExchangesApiWrapper(ExchangesApi):
+    """
+    A wrapper for the ExchangesApi class.
+    """
+
+    async def get_exchanges_fmt(self, *args, **kwargs) -> pd.DataFrame:  # type: ignore
+        """
+        Get the exchanges in a pandas dataframe
+        """
+        pd = optional_import("pandas", "extra")
+        response = await self.get_available_exchanges_without_preload_content(*args, **kwargs)
+        response.raise_for_status()
         json_data = await response.json()
-        return pd.DataFrame(json_data["data"])
+        processed_results = []
+        for row in json_data:
+            data = {'timestamp': row['timestamp']}
+            data.update(row['exchanges'])
+            processed_results.append(data)
+        
+        # Create DataFrame and sort columns
+        df = pd.DataFrame(processed_results)
+        cols = ['timestamp'] + sorted([col for col in df.columns if col != 'timestamp'])
+        df = df[cols]
+        
+        # Convert timestamp to unix timestamp
+        df['timestamp'] = pd.to_datetime(df['timestamp']).astype("int64") // 10 ** 9
+        
+        # Convert exchange availability to boolean integers (0/1)
+        df = df.astype({'timestamp': 'int64', **{col: 'int8' for col in df.columns if col != 'timestamp'}})
+        return df

crypticorn/pay/client/__init__.py

@@ -38,9 +38,6 @@ from crypticorn.pay.client.models.http_validation_error import HTTPValidationErr
 from crypticorn.pay.client.models.now_api_status_res import NowAPIStatusRes
 from crypticorn.pay.client.models.now_create_invoice_req import NowCreateInvoiceReq
 from crypticorn.pay.client.models.now_create_invoice_res import NowCreateInvoiceRes
-from crypticorn.pay.client.models.now_fee_structure import NowFeeStructure
-from crypticorn.pay.client.models.now_payment_status import NowPaymentStatus
-from crypticorn.pay.client.models.now_webhook_payload import NowWebhookPayload
 from crypticorn.pay.client.models.payment import Payment
 from crypticorn.pay.client.models.payment_status import PaymentStatus
 from crypticorn.pay.client.models.product_create import ProductCreate