Skip to content

rnet.blocking

The blocking (synchronous) client provides the same functionality as the async client but with a synchronous API.

rnet.blocking

Response

A blocking response from a request.

Source code in rnet/blocking.py 
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 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
class Response:
    r"""
    A blocking response from a request.
    """

    url: str
    r"""
    Get the URL of the response.
    """

    status: StatusCode
    r"""
    Get the status code of the response.
    """

    version: Version
    r"""
    Get the HTTP version of the response.
    """

    headers: HeaderMap
    r"""
    Get the headers of the response.
    """

    cookies: Sequence[Cookie]
    r"""
    Get the cookies of the response.
    """

    content_length: int | None
    r"""
    Get the content length of the response.
    """

    remote_addr: SocketAddr | None
    r"""
    Get the remote address of the response.
    """

    local_addr: SocketAddr | None
    r"""
    Get the local address of the response.
    """

    history: Sequence[History]
    r"""
    Get the redirect history of the Response.
    """

    tls_info: TlsInfo | None
    r"""
    Get the TLS information of the response.
    """

    def raise_for_status(self) -> None:
        r"""
        Turn a response into an error if the server returned an error.
        """

    def stream(self) -> Streamer:
        r"""
        Get the response into a `Streamer` of `bytes` from the body.
        """
        ...

    def text(self) -> str:
        r"""
        Get the text content of the response.
        """
        ...

    def text_with_charset(self, encoding: str) -> str:
        r"""
        Get the full response text given a specific encoding.
        """
        ...

    def json(self) -> Any:
        r"""
        Get the JSON content of the response.
        """

    def bytes(self) -> bytes:
        r"""
        Get the bytes content of the response.
        """
        ...

    def close(self) -> None:
        r"""
        Close the response connection.
        """

    def __enter__(self) -> "Response": ...
    def __exit__(self, _exc_type: Any, _exc_value: Any, _traceback: Any) -> None: ...
    def __str__(self) -> str: ...

url instance-attribute 

url

Get the URL of the response.

status instance-attribute 

status

Get the status code of the response.

version instance-attribute 

version

Get the HTTP version of the response.

headers instance-attribute 

headers

Get the headers of the response.

cookies instance-attribute 

cookies

Get the cookies of the response.

content_length instance-attribute 

content_length

Get the content length of the response.

remote_addr instance-attribute 

remote_addr

Get the remote address of the response.

local_addr instance-attribute 

local_addr

Get the local address of the response.

history instance-attribute 

history

Get the redirect history of the Response.

tls_info instance-attribute 

tls_info

Get the TLS information of the response.

raise_for_status 

raise_for_status()

Turn a response into an error if the server returned an error.

Source code in rnet/blocking.py 
80
81
82
83
def raise_for_status(self) -> None:
    r"""
    Turn a response into an error if the server returned an error.
    """

stream 

stream()

Get the response into a Streamer of bytes from the body.

Source code in rnet/blocking.py 
85
86
87
88
89
def stream(self) -> Streamer:
    r"""
    Get the response into a `Streamer` of `bytes` from the body.
    """
    ...

text 

text()

Get the text content of the response.

Source code in rnet/blocking.py 
91
92
93
94
95
def text(self) -> str:
    r"""
    Get the text content of the response.
    """
    ...

text_with_charset 

text_with_charset(encoding)

Get the full response text given a specific encoding.

Source code in rnet/blocking.py 
 97
 98
 99
100
101
def text_with_charset(self, encoding: str) -> str:
    r"""
    Get the full response text given a specific encoding.
    """
    ...

json 

json()

Get the JSON content of the response.

Source code in rnet/blocking.py 
103
104
105
106
def json(self) -> Any:
    r"""
    Get the JSON content of the response.
    """

bytes 

bytes()

Get the bytes content of the response.

Source code in rnet/blocking.py 
108
109
110
111
112
def bytes(self) -> bytes:
    r"""
    Get the bytes content of the response.
    """
    ...

close 

close()

Close the response connection.

Source code in rnet/blocking.py 
114
115
116
117
def close(self) -> None:
    r"""
    Close the response connection.
    """

WebSocket

A blocking WebSocket response.

Source code in rnet/blocking.py 
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
class WebSocket:
    r"""
    A blocking WebSocket response.
    """

    status: StatusCode
    r"""
    Get the status code of the response.
    """

    version: Version
    r"""
    Get the HTTP version of the response.
    """

    headers: HeaderMap
    r"""
    Get the headers of the response.
    """

    cookies: Sequence[Cookie]
    r"""
    Get the cookies of the response.
    """

    remote_addr: SocketAddr | None
    r"""
    Get the remote address of the response.
    """

    protocol: str | None
    r"""
    Get the WebSocket protocol.
    """

    def recv(self, timeout: datetime.timedelta | None = None) -> Message | None:
        r"""
        Receive a message from the WebSocket.
        """

    def send(self, message: Message) -> None:
        r"""
        Send a message to the WebSocket.

        # Arguments

        * `message` - The message to send.
        """

    def send_all(self, messages: Sequence[Message]) -> None:
        r"""
        Send multiple messages to the WebSocket.

        # Arguments

        * `messages` - The sequence of messages to send.
        """

    def close(
        self,
        code: int | None = None,
        reason: str | None = None,
    ) -> None:
        r"""
        Close the WebSocket connection.

        # Arguments

        * `code` - An optional close code.
        * `reason` - An optional reason for closing.
        """

    def __enter__(self) -> "WebSocket": ...
    def __exit__(self, _exc_type: Any, _exc_value: Any, _traceback: Any) -> None: ...
    def __str__(self) -> str: ...

status instance-attribute 

status

Get the status code of the response.

version instance-attribute 

version

Get the HTTP version of the response.

headers instance-attribute 

headers

Get the headers of the response.

cookies instance-attribute 

cookies

Get the cookies of the response.

remote_addr instance-attribute 

remote_addr

Get the remote address of the response.

protocol instance-attribute 

protocol

Get the WebSocket protocol.

recv 

recv(timeout=None)

Receive a message from the WebSocket.

Source code in rnet/blocking.py 
159
160
161
162
def recv(self, timeout: datetime.timedelta | None = None) -> Message | None:
    r"""
    Receive a message from the WebSocket.
    """

send 

send(message)

Send a message to the WebSocket.

Arguments
  • message - The message to send.
Source code in rnet/blocking.py 
164
165
166
167
168
169
170
171
def send(self, message: Message) -> None:
    r"""
    Send a message to the WebSocket.

    # Arguments

    * `message` - The message to send.
    """

send_all 

send_all(messages)

Send multiple messages to the WebSocket.

Arguments
  • messages - The sequence of messages to send.
Source code in rnet/blocking.py 
173
174
175
176
177
178
179
180
def send_all(self, messages: Sequence[Message]) -> None:
    r"""
    Send multiple messages to the WebSocket.

    # Arguments

    * `messages` - The sequence of messages to send.
    """

close 

close(code=None, reason=None)

Close the WebSocket connection.

Arguments
  • code - An optional close code.
  • reason - An optional reason for closing.
Source code in rnet/blocking.py 
182
183
184
185
186
187
188
189
190
191
192
193
194
def close(
    self,
    code: int | None = None,
    reason: str | None = None,
) -> None:
    r"""
    Close the WebSocket connection.

    # Arguments

    * `code` - An optional close code.
    * `reason` - An optional reason for closing.
    """

Client

A blocking client for making HTTP requests.

Source code in rnet/blocking.py 
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
class Client:
    r"""
    A blocking client for making HTTP requests.
    """

    cookie_jar: Jar | None
    r"""
    Get the cookie jar used by this client (if enabled/configured).

    Returns:
        - The provided `Jar` if the client was constructed with `cookie_provider=...`
        - The auto-created `Jar` if the client was constructed with `cookie_store=True`
    """

    def __init__(
        self,
        **kwargs: Unpack[ClientConfig],
    ) -> None:
        r"""
        Creates a new blocking Client instance.

        # Examples

        ```python
        import asyncio
        import rnet

        client = rnet.blocking.Client(
            user_agent="Mozilla/5.0",
            timeout=10,
        )
        response = client.get('https://httpbin.io/get')
        print(response.text())
        ```
        """
        ...

    def request(
        self,
        method: Method,
        url: str,
        **kwargs: Unpack[Request],
    ) -> "Response":
        r"""
        Sends a request with the given method and URL.

        # Examples

        ```python
        import rnet
        from rnet import Method

        client = rnet.blocking.Client()
        response = client.request(Method.GET, "https://httpbin.io/anything")
        ```
        """
        ...

    def websocket(self, url: str, **kwargs: Unpack[WebSocketRequest]) -> "WebSocket":
        r"""
        Sends a WebSocket request.

        # Examples

        ```python
        import rnet

        client = rnet.blocking.Client()
        ws = client.websocket("wss://echo.websocket.org")
        ws.send(rnet.Message.from_text("Hello, WebSocket!"))
        message = ws.recv()
        print("Received:", message.data)
        ws.close()
        ```
        """
        ...

    def trace(
        self,
        url: str,
        **kwargs: Unpack[Request],
    ) -> "Response":
        r"""
        Sends a request with the given URL.

        # Examples

        ```python
        import rnet
        from rnet import Method

        client = rnet.blocking.Client()
        response = client.trace("https://httpbin.io/anything")
        print(response.text())
        ```
        """
        ...

    def options(
        self,
        url: str,
        **kwargs: Unpack[Request],
    ) -> "Response":
        r"""
        Sends a request with the given URL.

        # Examples

        ```python
        import rnet
        from rnet import Method

        client = rnet.blocking.Client()
        response = client.options("https://httpbin.io/anything")
        print(response.text())
        ```
        """
        ...

    def head(
        self,
        url: str,
        **kwargs: Unpack[Request],
    ) -> "Response":
        r"""
        Sends a request with the given URL.

        # Examples

        ```python
        import rnet
        from rnet import Method

        def main():
        client = rnet.blocking.Client()
        response = client.head("https://httpbin.io/anything")
        print(response.text())
        ```
        """
        ...

    def delete(
        self,
        url: str,
        **kwargs: Unpack[Request],
    ) -> "Response":
        r"""
        Sends a request with the given URL.

        # Examples

        ```python
        import rnet
        from rnet import Method

        client = rnet.blocking.Client()
        response = client.delete("https://httpbin.io/anything")
        print(response.text())
        ```
        """
        ...

    def patch(
        self,
        url: str,
        **kwargs: Unpack[Request],
    ) -> "Response":
        r"""
        Sends a request with the given URL.

        # Examples

        ```python
        import rnet
        from rnet import Method

        client = rnet.blocking.Client()
        response = client.patch("https://httpbin.io/anything", json={"key": "value"})
        print(response.text())
        ```
        """
        ...

    def put(
        self,
        url: str,
        **kwargs: Unpack[Request],
    ) -> "Response":
        r"""
        Sends a request with the given URL.

        # Examples

        ```python
        import rnet
        from rnet import Method

        client = rnet.blocking.Client()
        response = client.put("https://httpbin.io/anything", json={"key": "value"})
        print(response.text())
        ```
        """
        ...

    def post(
        self,
        url: str,
        **kwargs: Unpack[Request],
    ) -> "Response":
        r"""
        Sends a request with the given URL.

        # Examples

        ```python
        import rnet
        from rnet import Method

        client = rnet.blocking.Client()
        response = client.post("https://httpbin.io/anything", json={"key": "value"})
        print(response.text())
        ```
        """
        ...

    def get(
        self,
        url: str,
        **kwargs: Unpack[Request],
    ) -> "Response":
        r"""
        Sends a request with the given URL.

        # Examples

        ```python
        import rnet
        from rnet import Method

        client = rnet.blocking.Client()
        response = client.get("https://httpbin.io/anything")
        print(response.text())
        ```
        """
        ...

cookie_jar instance-attribute 

cookie_jar

Get the cookie jar used by this client (if enabled/configured).

Returns:

Type Description
Jar | None
  • The provided Jar if the client was constructed with cookie_provider=...
Jar | None
  • The auto-created Jar if the client was constructed with cookie_store=True

__init__ 

__init__(**kwargs)

Creates a new blocking Client instance.

Examples
import asyncio
import rnet

client = rnet.blocking.Client(
    user_agent="Mozilla/5.0",
    timeout=10,
)
response = client.get('https://httpbin.io/get')
print(response.text())
Source code in rnet/blocking.py 
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
def __init__(
    self,
    **kwargs: Unpack[ClientConfig],
) -> None:
    r"""
    Creates a new blocking Client instance.

    # Examples

    ```python
    import asyncio
    import rnet

    client = rnet.blocking.Client(
        user_agent="Mozilla/5.0",
        timeout=10,
    )
    response = client.get('https://httpbin.io/get')
    print(response.text())
    ```
    """
    ...

request 

request(method, url, **kwargs)

Sends a request with the given method and URL.

Examples
import rnet
from rnet import Method

client = rnet.blocking.Client()
response = client.request(Method.GET, "https://httpbin.io/anything")
Source code in rnet/blocking.py 
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
def request(
    self,
    method: Method,
    url: str,
    **kwargs: Unpack[Request],
) -> "Response":
    r"""
    Sends a request with the given method and URL.

    # Examples

    ```python
    import rnet
    from rnet import Method

    client = rnet.blocking.Client()
    response = client.request(Method.GET, "https://httpbin.io/anything")
    ```
    """
    ...

websocket 

websocket(url, **kwargs)

Sends a WebSocket request.

Examples
import rnet

client = rnet.blocking.Client()
ws = client.websocket("wss://echo.websocket.org")
ws.send(rnet.Message.from_text("Hello, WebSocket!"))
message = ws.recv()
print("Received:", message.data)
ws.close()
Source code in rnet/blocking.py 
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
def websocket(self, url: str, **kwargs: Unpack[WebSocketRequest]) -> "WebSocket":
    r"""
    Sends a WebSocket request.

    # Examples

    ```python
    import rnet

    client = rnet.blocking.Client()
    ws = client.websocket("wss://echo.websocket.org")
    ws.send(rnet.Message.from_text("Hello, WebSocket!"))
    message = ws.recv()
    print("Received:", message.data)
    ws.close()
    ```
    """
    ...

trace 

trace(url, **kwargs)

Sends a request with the given URL.

Examples
import rnet
from rnet import Method

client = rnet.blocking.Client()
response = client.trace("https://httpbin.io/anything")
print(response.text())
Source code in rnet/blocking.py 
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
def trace(
    self,
    url: str,
    **kwargs: Unpack[Request],
) -> "Response":
    r"""
    Sends a request with the given URL.

    # Examples

    ```python
    import rnet
    from rnet import Method

    client = rnet.blocking.Client()
    response = client.trace("https://httpbin.io/anything")
    print(response.text())
    ```
    """
    ...

options 

options(url, **kwargs)

Sends a request with the given URL.

Examples
import rnet
from rnet import Method

client = rnet.blocking.Client()
response = client.options("https://httpbin.io/anything")
print(response.text())
Source code in rnet/blocking.py 
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
def options(
    self,
    url: str,
    **kwargs: Unpack[Request],
) -> "Response":
    r"""
    Sends a request with the given URL.

    # Examples

    ```python
    import rnet
    from rnet import Method

    client = rnet.blocking.Client()
    response = client.options("https://httpbin.io/anything")
    print(response.text())
    ```
    """
    ...

head 

head(url, **kwargs)

Sends a request with the given URL.

Examples
import rnet
from rnet import Method

def main():
client = rnet.blocking.Client()
response = client.head("https://httpbin.io/anything")
print(response.text())
Source code in rnet/blocking.py 
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
def head(
    self,
    url: str,
    **kwargs: Unpack[Request],
) -> "Response":
    r"""
    Sends a request with the given URL.

    # Examples

    ```python
    import rnet
    from rnet import Method

    def main():
    client = rnet.blocking.Client()
    response = client.head("https://httpbin.io/anything")
    print(response.text())
    ```
    """
    ...

delete 

delete(url, **kwargs)

Sends a request with the given URL.

Examples
import rnet
from rnet import Method

client = rnet.blocking.Client()
response = client.delete("https://httpbin.io/anything")
print(response.text())
Source code in rnet/blocking.py 
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
def delete(
    self,
    url: str,
    **kwargs: Unpack[Request],
) -> "Response":
    r"""
    Sends a request with the given URL.

    # Examples

    ```python
    import rnet
    from rnet import Method

    client = rnet.blocking.Client()
    response = client.delete("https://httpbin.io/anything")
    print(response.text())
    ```
    """
    ...

patch 

patch(url, **kwargs)

Sends a request with the given URL.

Examples
import rnet
from rnet import Method

client = rnet.blocking.Client()
response = client.patch("https://httpbin.io/anything", json={"key": "value"})
print(response.text())
Source code in rnet/blocking.py 
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
def patch(
    self,
    url: str,
    **kwargs: Unpack[Request],
) -> "Response":
    r"""
    Sends a request with the given URL.

    # Examples

    ```python
    import rnet
    from rnet import Method

    client = rnet.blocking.Client()
    response = client.patch("https://httpbin.io/anything", json={"key": "value"})
    print(response.text())
    ```
    """
    ...

put 

put(url, **kwargs)

Sends a request with the given URL.

Examples
import rnet
from rnet import Method

client = rnet.blocking.Client()
response = client.put("https://httpbin.io/anything", json={"key": "value"})
print(response.text())
Source code in rnet/blocking.py 
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
def put(
    self,
    url: str,
    **kwargs: Unpack[Request],
) -> "Response":
    r"""
    Sends a request with the given URL.

    # Examples

    ```python
    import rnet
    from rnet import Method

    client = rnet.blocking.Client()
    response = client.put("https://httpbin.io/anything", json={"key": "value"})
    print(response.text())
    ```
    """
    ...

post 

post(url, **kwargs)

Sends a request with the given URL.

Examples
import rnet
from rnet import Method

client = rnet.blocking.Client()
response = client.post("https://httpbin.io/anything", json={"key": "value"})
print(response.text())
Source code in rnet/blocking.py 
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
def post(
    self,
    url: str,
    **kwargs: Unpack[Request],
) -> "Response":
    r"""
    Sends a request with the given URL.

    # Examples

    ```python
    import rnet
    from rnet import Method

    client = rnet.blocking.Client()
    response = client.post("https://httpbin.io/anything", json={"key": "value"})
    print(response.text())
    ```
    """
    ...

get 

get(url, **kwargs)

Sends a request with the given URL.

Examples
import rnet
from rnet import Method

client = rnet.blocking.Client()
response = client.get("https://httpbin.io/anything")
print(response.text())
Source code in rnet/blocking.py 
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
def get(
    self,
    url: str,
    **kwargs: Unpack[Request],
) -> "Response":
    r"""
    Sends a request with the given URL.

    # Examples

    ```python
    import rnet
    from rnet import Method

    client = rnet.blocking.Client()
    response = client.get("https://httpbin.io/anything")
    print(response.text())
    ```
    """
    ...