Modifie test_api.sh pour générer les exemples de la documentation (samples).

This commit is contained in:
ilona 2024-08-06 09:22:27 +02:00
parent 933968c99b
commit 9302a173aa
2 changed files with 16 additions and 3 deletions

View File

@ -270,6 +270,9 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
Voir exemples d'utilisation de l'API en Python, dans `tests/api/`. Voir exemples d'utilisation de l'API en Python, dans `tests/api/`.
!!! info
Cette page a été générée par la commande `flask gen-api-doc`, et les exemples de résultats
sont créés par `tools/test_api.sh --make-samples`.
!!! note "Voir aussi" !!! note "Voir aussi"

View File

@ -11,13 +11,17 @@
# #
# Toutes les autres options sont passées telles qu'elles à pytest # Toutes les autres options sont passées telles qu'elles à pytest
# #
# Utilisation pour générer des exemples de documentation:
# tools/test_api.sh --make-samples
#
# Exemples: # Exemples:
# - lancer tous les tests API: tools/test_api.sh # - lancer tous les tests API: tools/test_api.sh
# - lancer tous les tests, en mode debug (arrêt pdb sur le 1er): # - lancer tous les tests, en mode debug (arrêt pdb sur le 1er):
# tools/test_api.sh -x --pdb tests/api # tools/test_api.sh -x --pdb tests/api
# - lancer un module de test, en utilisant un server dev existant: # - lancer un module de test, en utilisant un server dev existant:
# tools/test_api.sh --dont-start-server -x --pdb tests/api/test_api_evaluations.py # tools/test_api.sh --dont-start-server -x --pdb tests/api/test_api_evaluations.py
# # - Générer les samples pour la doc:
# tools/test_api.sh --make-samples
# #
# E. Viennet, Fev 2023 # E. Viennet, Fev 2023
@ -71,8 +75,14 @@ then
echo "Starting pytest tests/api" echo "Starting pytest tests/api"
pytest tests/api pytest tests/api
else else
echo "Starting pytest $@" if [ "$1" = "--make-samples" ]
pytest "$@" then
echo "Generating API documentation samples"
python tests/api/make_samples.py -i /tmp/samples.csv
else
echo "Starting pytest $@"
pytest "$@"
fi
fi fi
# ------------------ # ------------------