Déboguer Scripts Python dans Visual Studio Code
Nous assumons l'installation à jour de Visual Studio Code (VS Code) avec l'extension ms-python.python installée. Veuillez lire les configurations Python debug dans le guide Visual Studio Code officiel pour un aperçu général.
Veuillez noter les points suivants :
•Ce guide utilise raptorxmlxbrl-python en tant que commande pour exécuter RaptorXML+XBRL Server en tant qu'interpréteur Python.
•L'exécutable raptorxmlxbrl-python est disponible dans le dossier bin de votre dossier d'application RaptorXML+XBRL Server.
Aperçu
Nous présentons deux méthodes pour utiliser VS Code afin de déboguer les scripts Python dans RaptorXML+XBRL Server.
•La Méthode 1 fonctionne également pour les serveurs et les rappels de RaptorXML Python (option de --script).
•La Méthode 2 ne requiert aucune modification de code source. Il s'agit d'une invocation modifiée de RaptorXML. La Méthode 2 ne fonctionne pas pour les serveurs ni pour les rappels de RaptorXML Python (option de --script).
•Les deux méthodes fonctionnent avec un interpréteur Python standard et le module RaptorXML Python intégré ('import altova_api.v2 as altova').
Méthode 1 : changer votre code source
Exécutez les points suivants :
1.Exécutez : raptorxml-python -m pip install --upgrade debugpy
2.Ajoutez les lignes suivantes à votre code source Python :
python
import debugpy
debugpy.listen(5678)
debugpy.wait_for_client()
debugpy.breakpoint()
3.Copiez cette configuration de lancement vers VS Code launch.json (les valeurs par défaut permettront les valeurs ci-dessus) et sélectionnez-la pour Run.
json5
{
"name": "Python: Remote Attach",
"type": "python",
"request": "attach",
"connect": {
"host": "localhost",
"port": 5678
},
"pathMappings": [
{
"localRoot": "${workspaceFolder}",
"remoteRoot": "."
}
]
}
Vous pouvez également l'exécuter en utilisant la commande de menu Run->Add Configuration...->Python->Remote Attach avec les valeurs par défaut acceptées.
4.Exécutez votre script Python (ou RaptorXML avec les rappels --script) comme d'habitude.
5.Commencez à déboguer (normalement avec le raccourci F5).
Méthode 2 : Utiliser une ligne de commande modifiée
Réalisez les étapes suivantes :
1.Ajoutez la configuration de lancement (comme pour la Méthode 1 ci-dessus), et sélectionnez-la pour Run.
2.Définissez un point d'arrêt dans votre script Python.
3.Exécutez la commande: raptorxml-python -m debugpy --listen 0.0.0.0:5678 --wait-for-client your-script-.py
4.Commencez à déboguer (normalement avec le raccourci F5).
| Note : | Le débogage fonctionne également avec les conteneurs et serveurs distants. Vous devez changer la clé host de l'entrée connect dans la configuration de lancement. Vous pouvez aussi utiliser d'autres ports à condition que les lignes de code ou de commande et launch.json ont des valeurs consistantes. |
Définir raptorxml-python.exe en tant qu'interprète par défaut de VS Code
Il est possible de configurer raptorxml-python.exe en tant qu'interprète Python par défaut de VS Code. Configurez en ajoutant ce qui suit à votre code VS settigs.json file:
json
"python.defaultInterpreterPath": "/path/to/raptorxml-python.exe"
...
Dans ce cas, il est possible d'utiliser une configuration de lancement dite "Current File" qui lance le scripte pour déboguer. Consultez la documentation VS Code officielle pour tout détail.