Referência para hub_sdk/base/api_client.py
Nota
Este ficheiro está disponível em https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/api_client .py. Se detectares um problema, por favor ajuda a corrigi-lo contribuindo com um Pull Request 🛠️. Obrigado 🙏!
hub_sdk.base.api_client.APIClientError
Bases: Exception
Classe de exceção personalizada para erros do cliente da API.
Atributos:
Nome | Tipo | Descrição |
---|---|---|
message |
str
|
Uma mensagem de erro legível por humanos. |
status_code |
int
|
O código de estado HTTP associado ao erro, se disponível. |
Código fonte em hub_sdk/base/api_client.py
__init__(message, status_code=None)
Inicializa a instância APIClientError.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
message |
str
|
Uma mensagem de erro legível por humanos. |
necessário |
status_code |
int
|
O código de estado HTTP associado ao erro, se disponível. |
None
|
Código fonte em hub_sdk/base/api_client.py
hub_sdk.base.api_client.APIClient
Representa um cliente API para fazer pedidos a um URL de base especificado.
Atributos:
Nome | Tipo | Descrição |
---|---|---|
base_url |
str
|
O URL de base para a API. |
headers |
(dict, None)
|
Cabeçalhos a incluir em cada pedido. |
logger |
Logger
|
Uma instância do registador para efeitos de registo. |
Código fonte em 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)
Inicializa uma instância da classe APIClient.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
base_url |
str
|
O URL de base para a API. |
necessário |
headers |
dict
|
Cabeçalhos a incluir em cada pedido. |
None
|
Código fonte em hub_sdk/base/api_client.py
delete(endpoint, params=None)
Faz um pedido DELETE à API.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
endpoint |
str
|
O ponto final a anexar ao URL de base do pedido. |
necessário |
params |
dict
|
Parâmetros a incluir no pedido. |
None
|
Devolve:
Tipo | Descrição |
---|---|
Optional[Response]
|
O objeto de resposta do pedido HTTP DELETE, ou None se falhar. |
Código fonte em hub_sdk/base/api_client.py
get(endpoint, params=None)
Faz um pedido GET à API.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
endpoint |
str
|
O ponto final a anexar ao URL de base do pedido. |
necessário |
params |
dict
|
Consulta os parâmetros do pedido. |
None
|
Devolve:
Tipo | Descrição |
---|---|
Optional[Response]
|
O objeto de resposta do pedido HTTP GET, None se falhar. |
Código fonte em hub_sdk/base/api_client.py
patch(endpoint, data=None, json=None)
Faz um pedido de PATCH à API.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
endpoint |
str
|
O ponto final a anexar ao URL de base do pedido. |
necessário |
data |
dict
|
Dados a enviar no corpo do pedido. |
None
|
json |
dict
|
Dados JSON a serem enviados no corpo do pedido. |
None
|
Devolve:
Tipo | Descrição |
---|---|
Optional[Response]
|
O objeto de resposta do pedido HTTP PATCH, ou None se falhar. |
Código fonte em hub_sdk/base/api_client.py
post(endpoint, data=None, json=None, files=None, stream=False)
Faz um pedido POST à API.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
endpoint |
str
|
O ponto final a anexar ao URL de base do pedido. |
necessário |
data |
dict
|
Dados a enviar no corpo do pedido. |
None
|
json |
dict
|
Dados JSON a serem enviados no corpo do pedido. |
None
|
files |
dict
|
Ficheiros a incluir no pedido, se for caso disso. |
None
|
stream |
bool
|
Se for Verdadeiro, o conteúdo da resposta será transmitido. |
False
|
Devolve:
Tipo | Descrição |
---|---|
Optional[Response]
|
O objeto de resposta do pedido HTTP POST. |
Código fonte em hub_sdk/base/api_client.py
put(endpoint, data=None, json=None)
Faz um pedido PUT à API.
Parâmetros:
Nome | Tipo | Descrição | Predefinição |
---|---|---|---|
endpoint |
str
|
O ponto final a anexar ao URL de base do pedido. |
necessário |
data |
Optional[Dict]
|
Dados a enviar no corpo do pedido. |
None
|
json |
Optional[Dict]
|
Dados JSON a enviar no corpo do pedido |
None
|
Devolve:
Tipo | Descrição |
---|---|
Optional[Response]
|
O objeto de resposta do pedido HTTP PUT. |