transports
xsdata.formats.dataclass.transports
Transport
Bases: ABC
An HTTP transport interface.
Source code in xsdata/formats/dataclass/transports.py
7 8 9 10 11 12 13 14 15 16 17 18 |
|
get(url, params, headers)
abstractmethod
Send a GET request.
Source code in xsdata/formats/dataclass/transports.py
12 13 14 |
|
post(url, data, headers)
abstractmethod
Send a POST request.
Source code in xsdata/formats/dataclass/transports.py
16 17 18 |
|
DefaultTransport
Bases: Transport
Default transport based on the requests
library.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
timeout | float | Read timeout in seconds | 2.0 |
Source code in xsdata/formats/dataclass/transports.py
21 22 23 24 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 |
|
__init__(timeout=2.0, session=None)
Initialize the transport.
Source code in xsdata/formats/dataclass/transports.py
30 31 32 33 |
|
get(url, params, headers)
Send a GET request.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url | str | The base URL | required |
params | dict | The query parameters | required |
headers | dict | A key-value map of HTTP headers | required |
Returns:
Type | Description |
---|---|
bytes | The encoded response content. |
Raises:
Type | Description |
---|---|
HTTPError | if status code is not valid for content unmarshalling. |
Source code in xsdata/formats/dataclass/transports.py
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
|
post(url, data, headers)
Send a POST request.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url | str | The base URL | required |
data | Any | The request body payload | required |
headers | dict | A key-value map of HTTP headers | required |
Returns:
Type | Description |
---|---|
Any | The encoded response content. |
Raises:
Type | Description |
---|---|
HTTPError | if status code is not valid for content unmarshalling. |
Source code in xsdata/formats/dataclass/transports.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
|
handle_response(response)
classmethod
Return the response content or raise an exception.
Status codes 200 or 500 means that we can unmarshall the response.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
response | Response | The response instance | required |
Returns:
Type | Description |
---|---|
bytes | The encoded response content. |
Raises:
Type | Description |
---|---|
HTTPError | If the response status code is not 200 or 500 |
Source code in xsdata/formats/dataclass/transports.py
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
|