Cette bibliothèque détecte les réponses aux requêtes erronées à l'API de . Une exception signale ces erreurs.
L'exception ApiError peut être levée quand une réponse de l'API de indique que la requête est erronée. Ses propriétés sont les suivantes.
message: le message d'erreur.doc_url: l'URL de la documentation de l'erreur.status: le code du statut de la réponse.req_url: l'URL de la requête erronée.
La fonction detect__api_error examine les données provenant de l'API de et lève ApiError si elles résultent d'une requête erronée. Les données doivent être un objet produit par la lecture du contenu de la réponse, qui est en JSON.
L'utilisateur devrait se fier à detect__api_error plutôt que lever ApiError lui-même.
Pour plus d'informations, consultez la documentation et la démo dans le dépôt de code source.
Cette commande installe les dépendances nécessaires au développement de ghae.
pip install -r requirements-dev.txt
La démo montre comment déterminer qu'une requête à l'API de est erronée. Elle constitue aussi un exemple de gestion de ApiError.
Affichez l'aide pour plus d'informations.
python demo.py -h
Cet exemple envoie une requête valide.
python demo.py -r GRV96/ghae
Cet exemple envoie une requête erronée.
python demo.py -r GRV96/gha
Cette commande exécute les tests automatiques.
pytest tests
This library detects the responses to erroneous requests to the API. An exception signals these errors.
Exception ApiError can be raised when a response from the API indicates that the request is erroneous. Its properties are the following.
message: the error message.doc_url: the URL to the error's documentation.status: the response's status code.req_url: the erroneous request's URL.
Function detect__api_error examines data from the API and raises a ApiError if it is the result of an erroneous request. The data must be an object returned by the parsing of the response's content, which is in JSON.
The user should rely on detect__api_error rather than raising ApiError themself.
For more information, consult the documentation and the demo in the source code repository.
This command installs the dependencies required for the development of ghae.
pip install -r requirements-dev.txt
The demo shows how to find out whether a request to the API is erroneous. It also constitutes an example of handling a ApiError.
Display the help message for more information.
python demo.py -h
This example sends a valid request.
python demo.py -r GRV96/ghae
This example sends an erroneous request.
python demo.py -r GRV96/gha
This command executes the automated tests.
pytest tests