Skip to content

requests

This module contains classes used internally for sending requests to Luduvo endpoints.

CleanAsyncClient

Bases: AsyncClient

This is a clean-on-delete version of httpx.AsyncClient.

Source code in luduvo/utilities/requests.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
class CleanAsyncClient(AsyncClient):
    """
    This is a clean-on-delete version of httpx.AsyncClient.
    """

    def __init__(self):
        super().__init__()

    def __del__(self):
        try:
            asyncio.get_event_loop().create_task(self.aclose())
        except RuntimeError:
            pass

Requests

A special request object that implements special functionality required to connect to some Luduvo endpoints.

Attributes:

Name Type Description
session CleanAsyncClient

Base session object to use when sending requests.
Source code in luduvo/utilities/requests.py 
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
class Requests:
    """
    A special request object that implements special functionality required to connect to some Luduvo endpoints.

    Attributes:
        session: Base session object to use when sending requests.
    """

    def __init__(
        self,
        session: CleanAsyncClient = None,  # ty:ignore[invalid-parameter-default]
    ):
        """
        Arguments:
            session: A custom session object to use for sending requests, compatible with httpx.AsyncClient.
        """
        self.session: CleanAsyncClient

        if session is None:
            self.session = CleanAsyncClient()
        else:
            self.session = session

        # self.session.headers["User-Agent"] = "Python/luduvo-api-wrapper"
        # self.session.headers["Referer"] = "luduvo.com"

    async def request(self, method: str, *args, **kwargs) -> Response:
        """
        Arguments:
            method: The request method.

        Returns:
            An HTTP response.
        """

        url = (
            kwargs.get("url") if "url" in kwargs else (args[0] if args else "<unknown>")
        )
        logger.debug("Sending HTTP request: %s %s", method.upper(), url)

        response = await self.session.request(method, *args, **kwargs)

        method = method.lower()

        if response.is_error:
            # Something went wrong, parse an error
            logger.error(
                "HTTP request failed: %s %s %s",
                response.status_code,
                response.reason_phrase,
                response.url,
            )

            content_type = response.headers.get("Content-Type")
            errors = None
            if content_type and content_type.startswith("application/json"):
                data = None
                try:
                    data = response.json()
                except JSONDecodeError:
                    logger.debug(
                        "Failed to decode JSON error response from %s",
                        response.url,
                    )
                errors = data and data.get("errors")
                if errors:
                    logger.debug("Parsed error payload: %s", errors)

            exception = get_exception_from_status_code(response.status_code)(
                response=response, errors=errors
            )
            raise exception
        else:
            logger.debug(
                "HTTP request succeeded: %s %s",
                response.status_code,
                response.url,
            )
            return response

    async def get(self, *args, **kwargs) -> Response:
        """
        Sends a GET request.

        Returns:
            An HTTP response.
        """

        return await self.request("GET", *args, **kwargs)

    async def post(self, *args, **kwargs) -> Response:
        """
        Sends a POST request.

        Returns:
            An HTTP response.
        """

        return await self.request("POST", *args, **kwargs)

    async def put(self, *args, **kwargs) -> Response:
        """
        Sends a PATCH request.

        Returns:
            An HTTP response.
        """

        return await self.request("PUT", *args, **kwargs)

    async def patch(self, *args, **kwargs) -> Response:
        """
        Sends a PATCH request.

        Returns:
            An HTTP response.
        """

        return await self.request("PATCH", *args, **kwargs)

    async def delete(self, *args, **kwargs) -> Response:
        """
        Sends a DELETE request.

        Returns:
            An HTTP response.
        """

        return await self.request("DELETE", *args, **kwargs)

__init__(session=None)

Parameters:

Name Type Description Default
session CleanAsyncClient

A custom session object to use for sending requests, compatible with httpx.AsyncClient.

 None
Source code in luduvo/utilities/requests.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def __init__(
    self,
    session: CleanAsyncClient = None,  # ty:ignore[invalid-parameter-default]
):
    """
    Arguments:
        session: A custom session object to use for sending requests, compatible with httpx.AsyncClient.
    """
    self.session: CleanAsyncClient

    if session is None:
        self.session = CleanAsyncClient()
    else:
        self.session = session

delete(*args, **kwargs) async

Sends a DELETE request.

Returns:

Type Description
Response

An HTTP response.
Source code in luduvo/utilities/requests.py 
155
156
157
158
159
160
161
162
163
async def delete(self, *args, **kwargs) -> Response:
    """
    Sends a DELETE request.

    Returns:
        An HTTP response.
    """

    return await self.request("DELETE", *args, **kwargs)

get(*args, **kwargs) async

Sends a GET request.

Returns:

Type Description
Response

An HTTP response.
Source code in luduvo/utilities/requests.py 
115
116
117
118
119
120
121
122
123
async def get(self, *args, **kwargs) -> Response:
    """
    Sends a GET request.

    Returns:
        An HTTP response.
    """

    return await self.request("GET", *args, **kwargs)

patch(*args, **kwargs) async

Sends a PATCH request.

Returns:

Type Description
Response

An HTTP response.
Source code in luduvo/utilities/requests.py 
145
146
147
148
149
150
151
152
153
async def patch(self, *args, **kwargs) -> Response:
    """
    Sends a PATCH request.

    Returns:
        An HTTP response.
    """

    return await self.request("PATCH", *args, **kwargs)

post(*args, **kwargs) async

Sends a POST request.

Returns:

Type Description
Response

An HTTP response.
Source code in luduvo/utilities/requests.py 
125
126
127
128
129
130
131
132
133
async def post(self, *args, **kwargs) -> Response:
    """
    Sends a POST request.

    Returns:
        An HTTP response.
    """

    return await self.request("POST", *args, **kwargs)

put(*args, **kwargs) async

Sends a PATCH request.

Returns:

Type Description
Response

An HTTP response.
Source code in luduvo/utilities/requests.py 
135
136
137
138
139
140
141
142
143
async def put(self, *args, **kwargs) -> Response:
    """
    Sends a PATCH request.

    Returns:
        An HTTP response.
    """

    return await self.request("PUT", *args, **kwargs)

request(method, *args, **kwargs) async

Parameters:

Name Type Description Default
method str

The request method.

 required

Returns:

Type Description
Response

An HTTP response.
Source code in luduvo/utilities/requests.py 
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
async def request(self, method: str, *args, **kwargs) -> Response:
    """
    Arguments:
        method: The request method.

    Returns:
        An HTTP response.
    """

    url = (
        kwargs.get("url") if "url" in kwargs else (args[0] if args else "<unknown>")
    )
    logger.debug("Sending HTTP request: %s %s", method.upper(), url)

    response = await self.session.request(method, *args, **kwargs)

    method = method.lower()

    if response.is_error:
        # Something went wrong, parse an error
        logger.error(
            "HTTP request failed: %s %s %s",
            response.status_code,
            response.reason_phrase,
            response.url,
        )

        content_type = response.headers.get("Content-Type")
        errors = None
        if content_type and content_type.startswith("application/json"):
            data = None
            try:
                data = response.json()
            except JSONDecodeError:
                logger.debug(
                    "Failed to decode JSON error response from %s",
                    response.url,
                )
            errors = data and data.get("errors")
            if errors:
                logger.debug("Parsed error payload: %s", errors)

        exception = get_exception_from_status_code(response.status_code)(
            response=response, errors=errors
        )
        raise exception
    else:
        logger.debug(
            "HTTP request succeeded: %s %s",
            response.status_code,
            response.url,
        )
        return response