Skip to content

requests

This module contains classes used internally by ro.py for sending requests to Roblox endpoints.

CleanAsyncClient

Bases: AsyncClient

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

Source code in roblox/utilities/requests.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
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 Roblox endpoints.

Attributes:

Name Type Description
session CleanAsyncClient

Base session object to use when sending requests.
xcsrf_token_name str

The header that will contain the Cross-Site Request Forgery token.
Source code in roblox/utilities/requests.py 
 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
164
165
166
167
class Requests:
    """
    A special request object that implements special functionality required to connect to some Roblox endpoints.

    Attributes:
        session: Base session object to use when sending requests.
        xcsrf_token_name: The header that will contain the Cross-Site Request Forgery token.
    """

    def __init__(
            self,
            session: CleanAsyncClient = None,
            xcsrf_token_name: str = "X-CSRF-Token"
    ):
        """
        Arguments:
            session: A custom session object to use for sending requests, compatible with httpx.AsyncClient.
            xcsrf_token_name: The header to place X-CSRF-Token data into.
        """
        self.session: CleanAsyncClient

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

        self.xcsrf_token_name: str = xcsrf_token_name

        self.session.headers["User-Agent"] = "Roblox/WinInet"
        self.session.headers["Referer"] = "www.roblox.com"

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

        Returns:
            An HTTP response.
        """

        handle_xcsrf_token = kwargs.pop("handle_xcsrf_token", True)
        skip_roblox = kwargs.pop("skip_roblox", False)

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

        if skip_roblox:
            return response

        method = method.lower()

        if handle_xcsrf_token and self.xcsrf_token_name in response.headers and _xcsrf_allowed_methods.get(method):
            self.session.headers[self.xcsrf_token_name] = response.headers[self.xcsrf_token_name]
            if response.status_code == 403:  # Request failed, send it again
                response = await self.session.request(method, *args, **kwargs)

        if kwargs.get("stream"):
            # Streamed responses should not be decoded, so we immediately return the response.
            return response

        if response.is_error:
            # Something went wrong, parse an error
            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:
                    pass
                errors = data and data.get("errors")

            exception = get_exception_from_status_code(response.status_code)(
                response=response,
                errors=errors
            )
            raise exception
        else:
            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, xcsrf_token_name='X-CSRF-Token')

Parameters:

Name Type Description Default
session CleanAsyncClient

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

 None
xcsrf_token_name str

The header to place X-CSRF-Token data into.

 'X-CSRF-Token'
Source code in roblox/utilities/requests.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def __init__(
        self,
        session: CleanAsyncClient = None,
        xcsrf_token_name: str = "X-CSRF-Token"
):
    """
    Arguments:
        session: A custom session object to use for sending requests, compatible with httpx.AsyncClient.
        xcsrf_token_name: The header to place X-CSRF-Token data into.
    """
    self.session: CleanAsyncClient

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

    self.xcsrf_token_name: str = xcsrf_token_name

    self.session.headers["User-Agent"] = "Roblox/WinInet"
    self.session.headers["Referer"] = "www.roblox.com"

delete(*args, **kwargs) async

Sends a DELETE request.

Returns:

Type Description
Response

An HTTP response.
Source code in roblox/utilities/requests.py 
159
160
161
162
163
164
165
166
167
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 roblox/utilities/requests.py 
119
120
121
122
123
124
125
126
127
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 roblox/utilities/requests.py 
149
150
151
152
153
154
155
156
157
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 roblox/utilities/requests.py 
129
130
131
132
133
134
135
136
137
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 roblox/utilities/requests.py 
139
140
141
142
143
144
145
146
147
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 roblox/utilities/requests.py 
 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
async def request(self, method: str, *args, **kwargs) -> Response:
    """
    Arguments:
        method: The request method.

    Returns:
        An HTTP response.
    """

    handle_xcsrf_token = kwargs.pop("handle_xcsrf_token", True)
    skip_roblox = kwargs.pop("skip_roblox", False)

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

    if skip_roblox:
        return response

    method = method.lower()

    if handle_xcsrf_token and self.xcsrf_token_name in response.headers and _xcsrf_allowed_methods.get(method):
        self.session.headers[self.xcsrf_token_name] = response.headers[self.xcsrf_token_name]
        if response.status_code == 403:  # Request failed, send it again
            response = await self.session.request(method, *args, **kwargs)

    if kwargs.get("stream"):
        # Streamed responses should not be decoded, so we immediately return the response.
        return response

    if response.is_error:
        # Something went wrong, parse an error
        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:
                pass
            errors = data and data.get("errors")

        exception = get_exception_from_status_code(response.status_code)(
            response=response,
            errors=errors
        )
        raise exception
    else:
        return response