pincer.core.http.HTTPClient.__send() - Code Metrics - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

pincer.core.http.HTTPClient.__send() A
last analyzed 2022-12-26 13:13 UTC

↳ Parent: pincer.core.http

Complexity

Conditions

Size

Total Lines	75
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	30
dl	0
loc	75
rs	9.16
c	0
b	0
f	0
cc	4
nop	9

How to fix Long Method Many Parameters

# Copyright Pincer 2021-Present

# Full MIT License can be found in `LICENSE` at the project root.
from __future__ import annotations

import logging
from asyncio import sleep
from json import dumps
from typing import Protocol, TYPE_CHECKING

from aiohttp import ClientSession, ClientResponse


# I'm open for ideas on how to get __version__ without doing this
import pincer
from . import __package__
from .ratelimiter import RateLimiter
from .._config import GatewayConfig
from ..exceptions import (
    NotFoundError,
    BadRequestError,
    NotModifiedError,
    UnauthorizedError,
    ForbiddenError,
    MethodNotAllowedError,
    RateLimitError,
    ServerError,
    HTTPError,
)
from ..utils.conversion import remove_none

if TYPE_CHECKING:
    from typing import Any, Dict, Optional, Union

    from aiohttp.client import _RequestContextManager

    from aiohttp.payload import Payload

    from aiohttp.typedefs import StrOrURL



_log = logging.getLogger(__package__)


class HttpCallable(Protocol):
    """Aiohttp HTTP method."""

    __name__: str

    def __call__(
        self,

        url: StrOrURL,

        *,

        allow_redirects: bool = True,

        method: Optional[Union[Dict, str, Payload]] = None,

        **kwargs: Any,

    ) -> _RequestContextManager:
        ...


class HTTPClient:
    """Interacts with Discord API through HTTP protocol

    Parameters
    ----------
    Instantiate a new HttpApi object.

    token:
        Discord API token

    Keyword Arguments:

    version:
        The discord API version.
        See `<https://discord.com/developers/docs/reference#api-versioning>`_.
    ttl:
        Max amount of attempts after error code 5xx

    Attributes
    ----------
    url: :class:`str`
        ``f"https://discord.com/api/v{version}"``
        "Base url for all HTTP requests"
    max_tts: :class:`int`
        Max amount of attempts after error code 5xx
    """

    def __init__(self, token: str, *, version: int = None, ttl: int = 5):
        version = version or GatewayConfig.version
        self.url: str = f"https://discord.com/api/v{version}"
        self.max_ttl: int = ttl

        headers: Dict[str, str] = {
            "Authorization": f"Bot {token}",
            "User-Agent": f"DiscordBot (https://github.com/Pincer-org/Pincer, {pincer.__version__})",  # noqa: E501

        }
        self.__rate_limiter = RateLimiter()
        self.__session: ClientSession = ClientSession(headers=headers)

        self.__http_exceptions: Dict[int, HTTPError] = {
            304: NotModifiedError(),
            400: BadRequestError(),
            401: UnauthorizedError(),
            403: ForbiddenError(),
            404: NotFoundError(),
            405: MethodNotAllowedError(),
            429: RateLimitError(),
        }

    # for with block
    async def __aenter__(self):
        return self

    async def __aexit__(self, exc_type, exc, tb):
        await self.close()

    async def close(self):
        """|coro|

        Closes the aiohttp session
        """
        await self.__session.close()

    async def __send(
        self,

        method: HttpCallable,

        endpoint: str,

        *,

        content_type: str = "application/json",

        data: Optional[Union[Dict, str, Payload]] = None,

        headers: Optional[Dict[str, Any]] = None,

        _ttl: Optional[int] = None,

        params: Optional[Dict] = None,

    ) -> Optional[Dict]:
        """
        Send an api request to the Discord REST API.

        Parameters
        ----------

        method: :class:`aiohttp.ClientSession.request`
            The method for the request. (e.g. GET or POST)

        endpoint: :class:`str`
            The endpoint to which the request will be sent.

        content_type: :class:`str`
            The request's content type.

        data: Optional[Union[:class:`Dict`, :class:`str`, :class:`aiohttp.payload.Payload`]]
            The data which will be added to the request.
            |default| :data:`None`

        headers: Optional[:class:`Dict`]
            The request headers.
            |default| :data:`None`

        params: Optional[:class:`Dict`]
            The query parameters to add to the request.
            |default| :data:`None`

        _ttl: Optional[:class:`int`]
            Private param used for recursively setting the retry amount.
            (Eg set to 1 for 1 max retry)
            |default| :data:`None`
        """
        ttl = _ttl or self.max_ttl

        if ttl == 0:
            logging.error(

                # TODO: print better method name

                f"{method.__name__.upper()} {endpoint} has reached the "
                f"maximum retry count of {self.max_ttl}."
            )

            raise ServerError(f"Maximum amount of retries for `{endpoint}`.")

        if isinstance(data, dict):
            data = dumps(data)

        # TODO: print better method name

        # TODO: Adjust to work non-json types

        _log.debug(f"{method.__name__.upper()} {endpoint} | {data}")


        await self.__rate_limiter.wait_until_not_ratelimited(endpoint, method)

        url = f"{self.url}/{endpoint}"
        async with method(
            url,

            data=data,

            headers={

                "Content-Type": content_type,
                **(remove_none(headers) or {}),
            },
            params=remove_none(params),

        ) as res:
            return await self.__handle_response(
                res, method, endpoint, content_type, data, ttl
            )

    async def __handle_response(

        self,

        res: ClientResponse,

        method: HttpCallable,

        endpoint: str,

        content_type: str,

        data: Optional[str],

        _ttl: int,

    ) -> Optional[Dict]:
        """
        Handle responses from the discord API.

        Side effects:
            If a 5xx error code is returned it will retry the request.

        Parameters
        ----------

        res: :class:`aiohttp.ClientResponse`
            The response from the discord API.

        method: :class:`aiohttp.ClientSession.request`
            The method which was used to call the endpoint.

        endpoint: :class:`str`
            The endpoint to which the request was sent.

        content_type: :class:`str`
            The request's content type.

        data: Optional[:class:`str`]
            The data which was added to the request.

        _ttl: :class:`int`
            Private param used for recursively setting the retry amount.
            (Eg set to 1 for 1 max retry)
        """
        _log.debug(f"Received response for {endpoint} | {await res.text()}")


        self.__rate_limiter.save_response_bucket(endpoint, method, res.headers)

        if res.ok:
            if res.status == 204:
                _log.debug("Request has been sent successfully. ")
                return

            _log.debug(
                "Request has been sent successfully. "
                "Returning json response."
            )

            return await res.json()

        exception = self.__http_exceptions.get(res.status)

        if exception:
            if isinstance(exception, RateLimitError):
                timeout = (await res.json()).get("retry_after", 40)

                _log.exception(

                    f"RateLimitError: {res.reason}."
                    f" The scope is {res.headers.get('X-RateLimit-Scope')}."
                    f" Retrying in {timeout} seconds"
                )
                await sleep(timeout)
                return await self.__send(
                    method, endpoint, content_type=content_type, data=data
                )

            _log.error(

                f"An http exception occurred while trying to send "
                f"a request to {endpoint}. ({res.status}, {res.reason})"
            )

            exception.__init__(res.reason)
            raise exception

        # status code is guaranteed to be 5xx
        retry_in = 1 + (self.max_ttl - _ttl) * 2

        _log.debug(

            "Server side error occurred with status code "
            f"{res.status}. Retrying in {retry_in}s."
        )

        await sleep(retry_in)

        # try sending it again
        return await self.__send(
            method,
            endpoint,
            content_type=content_type,
            _ttl=_ttl - 1,
            data=data,
        )

    async def delete(
        self, route: str, headers: Optional[Dict[str, Any]] = None

    ) -> Optional[Dict]:
        """|coro|

        Sends a delete request to a Discord REST endpoint.

        Parameters
        ----------
        route : :class:`str`
            The Discord REST endpoint to send a delete request to.
        headers: Optional[Dict[:class:`str`, Any]]
            The request headers.
            |default| :data:`None`

        Returns
        -------
        Optional[:class:`Dict`]
            The response from discord.
        """
        return await self.__send(self.__session.delete, route, headers=headers)

    async def get(
        self, route: str, params: Optional[Dict] = None

    ) -> Optional[Dict]:
        """|coro|

        Sends a get request to a Discord REST endpoint.

        Parameters
        ----------
        route : :class:`str`
            The Discord REST endpoint to send a get request to.
        params: Optional[:class:`Dict`]
            The query parameters to add to the request.
            |default| :data:`None`

        Returns
        -------
        Optional[:class:`Dict`]
            The response from discord.
        """
        return await self.__send(self.__session.get, route, params=params)

    async def head(self, route: str) -> Optional[Dict]:
        """|coro|

        Sends a head request to a Discord REST endpoint.

        Parameters
        ----------
        route : :class:`str`
            The Discord REST endpoint to send a head request to.

        Returns
        -------
        Optional[:class:`Dict`]
            The response from discord.
        """
        return await self.__send(self.__session.head, route)

    async def options(self, route: str) -> Optional[Dict]:
        """|coro|

        Sends an options request to a Discord REST endpoint.

        Parameters
        ----------
        route : :class:`str`
            The Discord REST endpoint to send an options request to.

        Returns
        -------
        Optional[:class:`Dict`]
            The response from discord.
        """
        return await self.__send(self.__session.options, route)

    async def patch(
        self,

        route: str,

        data: Optional[Dict] = None,

        content_type: str = "application/json",

        headers: Optional[Dict[str, Any]] = None,

    ) -> Optional[Dict]:
        """|coro|

        Sends a patch request to a Discord REST endpoint.

        Parameters
        ----------
        route : :class:`str`
            The Discord REST endpoint to send a patch request to.
        data : :class:`Dict`
            The update data for the patch request.
        content_type: :class:`str`
            Body content type.
            |default| ``application/json``
        headers: Optional[Dict[:class:`str`, Any]]
            The request headers.

        Returns
        -------
        Optional[:class:`Dict`]
            JSON response from the discord API.
        """
        return await self.__send(
            self.__session.patch,
            route,
            content_type=content_type,
            data=data,
            headers=headers,
        )

    async def post(

        self,

        route: str,

        data: Optional[Dict] = None,

        content_type: str = "application/json",

        headers: Optional[Dict[str, Any]] = None,

    ) -> Optional[Dict]:
        """|coro|

        Sends a post request to a Discord REST endpoint

        Parameters
        ----------
        route : :class:`str`
            The Discord REST endpoint to send a patch request to.
        data : Dict
            The update data for the patch request.
        content_type : :class:`str`
            Body content type. |default| ``application/json``
        headers: Optional[Dict[:class:`str`, Any]]
            The request headers.

        Returns
        -------
        Optional[:class:`Dict`]
            JSON response from the discord API.
        """
        return await self.__send(
            self.__session.post,
            route,
            content_type=content_type,
            data=data,
            headers=headers,
        )

    async def put(

        self,

        route: str,

        data: Optional[Dict] = None,

        content_type: str = "application/json",

        headers: Optional[Dict[str, Any]] = None,

    ) -> Optional[Dict]:
        """|coro|

        Sends a put request to a Discord REST endpoint

        Parameters
        ----------
        route : :class:`str`
            The Discord REST endpoint to send a patch request to.
        data : Dict
            The update data for the patch request.
        content_type : :class:`str`
            Body content type. |default| ``application/json``
        headers: Optional[Dict[:class:`str`, Any]]
            The request headers.

        Returns
        -------
        Optional[:class:`Dict`]
            JSON response from the discord API.
        """
        return await self.__send(
            self.__session.put,
            route,
            content_type=content_type,
            data=data,
            headers=headers,
        )


1			# Copyright Pincer 2021-Present
			0 ignored issues – show introduced 2021-08-30 06:38 UTC by Report Bug Copy Issue Report Missing module docstring Loading history...
2			# Full MIT License can be found in `LICENSE` at the project root.
3			from __future__ import annotations
4
5			import logging
6			from asyncio import sleep
7			from json import dumps
8			from typing import Protocol, TYPE_CHECKING
9
10			from aiohttp import ClientSession, ClientResponse
			0 ignored issues – show introduced 2022-05-28 03:05 UTC by Report Bug Copy Issue Report Unable to import 'aiohttp' Loading history...
11
12			# I'm open for ideas on how to get __version__ without doing this
13			import pincer
14			from . import __package__
15			from .ratelimiter import RateLimiter
16			from .._config import GatewayConfig
17			from ..exceptions import (
18			NotFoundError,
19			BadRequestError,
20			NotModifiedError,
21			UnauthorizedError,
22			ForbiddenError,
23			MethodNotAllowedError,
24			RateLimitError,
25			ServerError,
26			HTTPError,
27			)
28			from ..utils.conversion import remove_none
29
30			if TYPE_CHECKING:
31			from typing import Any, Dict, Optional, Union
32
33			from aiohttp.client import _RequestContextManager
			0 ignored issues – show introduced 2022-05-28 03:05 UTC by Report Bug Copy Issue Report Unable to import 'aiohttp.client' Loading history... introduced 2021-11-30 01:43 UTC by Report Bug Copy Issue Report Imports from package aiohttp are not grouped Loading history...
34			from aiohttp.payload import Payload
			0 ignored issues – show introduced 2022-05-28 03:05 UTC by Report Bug Copy Issue Report Unable to import 'aiohttp.payload' Loading history...
35			from aiohttp.typedefs import StrOrURL
			0 ignored issues – show introduced 2022-05-28 03:05 UTC by Report Bug Copy Issue Report Unable to import 'aiohttp.typedefs' Loading history...

Pincer-org / Pincer

pincer.core.http.HTTPClient.__send() A last analyzed 2022-12-26 13:13 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Many Parameters

Long Method

Many Parameters

Duplication Side-by-Side

Filter issues like

pincer.core.http.HTTPClient.__send() A
last analyzed 2022-12-26 13:13 UTC