Lorsqu'un script est exécuté en tant qu'outil de script, ArcPy reconnaît l'application à partir de laquelle il est appelé. Vous pouvez alors écrire des messages avec ArcPy et ceux-ci s'affichent automatiquement dans la boîte de dialogue de progression, le résultat de l'outil et la fenêtre Python. Cela signifie également que tout outil de modèle ou de script qui appelle votre outil de script a accès aux messages que vous écrivez.
Pendant l'exécution d'un outil, des messages sont écrits qui peuvent être récupérés grâce à des fonctions de géotraitement. Ces messages comprennent les types d'information suivants :
- le début et la fin de l'opération,
- les valeurs de paramètre utilisées,
- des informations générales sur la progression de l'opération (message d'information),
- des avertissements relatifs à des problèmes potentiels (message d'avertissement),
- des erreurs qui provoquent l'arrêt de l'exécution par l'outil (message d'erreur).
Toute la communication entre les outils et les utilisateurs s'effectue à l'aide de messages. Selon l'environnement d'exécution des outils, les messages apparaissent dans la fenêtre Résultat, la fenêtre Python et la boîte de dialogue de progression. A partir de Python, vous pouvez récupérer ces messages dans votre script, les interroger, les imprimer ou les écrire dans un fichier. Tous les messages possèdent une propriété de gravité, qui peut fournir une information, un avertissement ou signaler une erreur. La gravité est un nombre entier, avec 0 = information, 1 = avertissement et 2 = erreur.
| Gravité | |
|---|---|
Message d'information (gravité = 0) | Un message d'information donne simplement des informations concernant l'exécution. Il ne permet jamais d'indiquer des problèmes. Les messages d'information signalent uniquement des informations générales, telles que la progression d'un outil, l'heure de début ou de fin de l'exécution d'un outil, les caractéristiques des données en sortie ou les résultats de l'outil. |
Message d'avertissement (gravité = 1) | Les messages d'avertissement sont générés lorsqu'un outil rencontre un problème d'exécution potentiel ou lorsque le résultat n'est pas conforme à ce que vous attendez. Par exemple, la définition d'un système de coordonnées pour un jeu de données comportant déjà un système de coordonnées défini génère un avertissement. Vous pouvez déclencher une action lorsqu'un avertissement est renvoyé, par exemple l'annulation de l'exécution de l'outil ou la sélection d'un autre paramètre. |
Message d'erreur (gravité = 2) | Des messages d'erreur indiquent les éventuels événements critiques qui ont empêché l'exécution d'un outil. Des erreurs sont générées lorsqu'un ou plusieurs paramètres affichent des valeurs incorrectes ou lorsqu'un processus d'exécution critique ou une routine a échoué. |
Les messages d'avertissement et d'erreur sont accompagnés d'un code d'identification à six chiffres. Ces codes d'identification sont documentés pour fournir des informations supplémentaires sur leurs causes et la manière dont ils peuvent être gérés. Lorsque des codes d'erreur ou d'avertissement sont affichés dans la boîte de dialogue de l'outil ou de la progression, la fenêtre Python ou Résultat, ils contiennent un lien permettant d'accéder directement à une aide supplémentaire pour ce message.