Reference for hub_sdk/base/api_client.py
Note
This file is available at https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/api_client.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
hub_sdk.base.api_client.APIClientError
Bases: Exception
Custom exception class for API client errors.
Attributes:
Name | Type | Description |
---|---|---|
message |
str
|
A human-readable error message. |
status_code |
int
|
The HTTP status code associated with the error, if available. |
Source code in hub_sdk/base/api_client.py
__init__(message, status_code=None)
Initialize the APIClientError instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
message |
str
|
A human-readable error message. |
required |
status_code |
int
|
The HTTP status code associated with the error, if available. |
None
|
Source code in hub_sdk/base/api_client.py
hub_sdk.base.api_client.APIClient
Represents an API client for making requests to a specified base URL.
Attributes:
Name | Type | Description |
---|---|---|
base_url |
str
|
The base URL for the API. |
headers |
(dict, None)
|
Headers to be included in each request. |
logger |
Logger
|
An instance of the logger for logging purposes. |
Source code in hub_sdk/base/api_client.py
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 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 |
|
__init__(base_url, headers=None)
Initialize an instance of the APIClient class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
base_url |
str
|
The base URL for the API. |
required |
headers |
dict
|
Headers to be included in each request. |
None
|
Source code in hub_sdk/base/api_client.py
delete(endpoint, params=None)
Make a DELETE request to the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
endpoint |
str
|
The endpoint to append to the base URL for the request. |
required |
params |
dict
|
Parameters to include in the request. |
None
|
Returns:
Type | Description |
---|---|
Optional[Response]
|
The response object from the HTTP DELETE request, or None if it fails. |
Source code in hub_sdk/base/api_client.py
get(endpoint, params=None)
Make a GET request to the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
endpoint |
str
|
The endpoint to append to the base URL for the request. |
required |
params |
dict
|
Query parameters for the request. |
None
|
Returns:
Type | Description |
---|---|
Optional[Response]
|
The response object from the HTTP GET request, None if it fails. |
Source code in hub_sdk/base/api_client.py
patch(endpoint, data=None, json=None)
Make a PATCH request to the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
endpoint |
str
|
The endpoint to append to the base URL for the request. |
required |
data |
dict
|
Data to be sent in the request's body. |
None
|
json |
dict
|
JSON data to be sent in the request's body. |
None
|
Returns:
Type | Description |
---|---|
Optional[Response]
|
The response object from the HTTP PATCH request, or None if it fails. |
Source code in hub_sdk/base/api_client.py
post(endpoint, data=None, json=None, files=None, stream=False)
Make a POST request to the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
endpoint |
str
|
The endpoint to append to the base URL for the request. |
required |
data |
dict
|
Data to be sent in the request's body. |
None
|
json |
dict
|
JSON data to be sent in the request's body. |
None
|
files |
dict
|
Files to be included in the request, if any. |
None
|
stream |
bool
|
If True, the response content will be streamed. |
False
|
Returns:
Type | Description |
---|---|
Optional[Response]
|
The response object from the HTTP POST request. |
Source code in hub_sdk/base/api_client.py
put(endpoint, data=None, json=None)
Make a PUT request to the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
endpoint |
str
|
The endpoint to append to the base URL for the request. |
required |
data |
Optional[Dict]
|
Data to be sent in the request's body. |
None
|
json |
Optional[Dict]
|
JSON data to be sent in the request's body |
None
|
Returns:
Type | Description |
---|---|
Optional[Response]
|
The response object from the HTTP PUT request. |