Lorsque vous ouvrez pour la première fois la fenêtre Python, elle a l'aspect suivant :
La partie de gauche est la fenêtre de commande Python, dans laquelle les commandes Python sont exécutées. La partie de droite est la fenêtre d'aide et de syntaxe, dans laquelle s'affichent les messages d'exécution lorsque les outils sont exécutés et où l'aide est présentée pour l'outil, la fonction ou la classe actuelle lors de la saisie du code.
La première étape d'accès aux outils et autres fonctionnalités arcpy dans la fenêtre Python consiste à taper arcpy. à l'invite, ce qui affiche une liste déroulante de tous les outils, fonctions et classes arcpy. Vous pouvez faire défiler cette liste à l'aide du pointeur ou des touches Haut et Bas de votre clavier. Lorsque vous saisissez des caractères supplémentaires, la liste déroulante est filtrée de sorte à correspondre uniquement aux outils ou méthodes correspondant aux caractères saisis. Par exemple, si vous saisissez arcpy.addf dans la fenêtre Python, la liste déroulante contient uniquement les outils ou méthodes qui commencent par ces caractères. Si vous faites défiler la liste jusque arcpy.AddField_management ou si vous cliquez dessus, une pression sur la touche Tab renseigne automatiquement le nom complet de l'outil à l'invite. Lorsque vous saisissez une parenthèse d'ouverture (, l'aide de l'outil arcpy.AddField_management s'affiche dans la fenêtre d'aide et de syntaxe. Par défaut, le premier paramètre est mis en surbrillance.
Dans Python, le nom de l'outil est utilisé à la place de la dénomination de l'outil. La dénomination d'un outil est indiquée dans la partie supérieure de la boîte de dialogue de l'outil ou dans la fenêtre Catalogue. Les noms des outils sont généralement similaires aux dénominations, mais ils ne comportent pas d'espaces. Dans Python, l'alias de la boîte à outils est également inclus avec le nom d'outil.
- Nom et dénomination des propriétés d'un outil
- Dénomination et alias des noms des propriétés d'un outil
Une fois tous les paramètres requis saisis, appuyez sur la touche Entrée pour exécuter l'outil. Les messages d'exécution apparaîtront dans la section d'aide et de syntaxe de la fenêtre Python. Le texte des messages sera d'une couleur différente, selon le type de message. Les couleurs de texte par défaut et leurs significations sont les suivantes :
| Couleur | Signification |
|---|---|
Noir | Messages d'information normaux. |
Rouge | Message d'erreur. Aucun résultat n'a été généré. |
Orange | Message d’avertissement. Les résultats peuvent différer des résultats escomptés. |
Vous pouvez modifier ces couleurs en cliquant avec le bouton droit dans la section d'aide et de syntaxe de la fenêtre Python et en sélectionnant Format.
Paramètres requis et paramètres facultatifs
Les paramètres d'outil peuvent être soit obligatoires soit facultatifs. Les paramètres facultatifs sont entre accolades { } tandis que les obligatoires ne le sont pas.
| Type de paramètre | Symbole | Signification |
|---|---|---|
Requis | Paramètre obligatoire. Ces paramètres sont toujours les premiers paramètres de la commande. Vous devez fournir une valeur pour les paramètres obligatoires. | |
Facultatif | { } | Paramètre facultatif. Ces paramètres suivent toujours les paramètres obligatoires. Si vous n'entrez pas de valeur pour un paramètre facultatif, la valeur par défaut est calculée et utilisée. La valeur par défaut d'un paramètre est présentée dans l'aide de l'outil. |
Les outils peuvent posséder plusieurs paramètres facultatifs. Quelquefois, seuls certains des paramètres facultatifs d'un outil sont intéressants et doivent être définis. Il existe trois manières d'ignorer, ou de se déplacer après, un paramètre facultatif :
- Définir le paramètre facultatif comme étant une paire de guillemets vide ("").
- Définir le paramètre facultatif comme étant un signe dièse entre guillemets ("#").
- Spécifier explicitement le nom du paramètre à utiliser, ainsi que sa valeur (ignorer tout sauf le paramètre nommé).
Dans l'exemple suivant, l'outil Ajouter un champ est utilisé, mais le quatrième et le cinquième paramètres conservent leurs valeurs par défaut, grâce à ces trois techniques :
# Use empty strings to skip optional parameters
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", "", "", 120)
# Use the # sign to skip optional arguments
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", "#", "#", 120)
# Use the parameter name to bypass unused optional arguments
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", field_length=120)
Valeurs par défaut
- Les paramètres facultatifs ont des valeurs par défaut. Si vous tapez un signe dièse #, "" (deux guillemets doubles), '' (deux guillemets simples) ou un None entre parenthèses Python comme paramètre facultatif, la valeur du paramètre par défaut est utilisée. Pour les mots-clés, la valeur par défaut correspond au premier mot-clé dans la liste. Consultez l'aide sur un outil individuel pour connaître les valeurs par défaut de ses paramètres.
- Il est courant d'ignorer certains paramètres facultatifs pour arriver au paramètre que vous voulez modifier.
Listes déroulantes de paramètres
Des listes déroulantes sont fournies dans la fenêtre Python à chaque fois qu'un outil reconnaît des options disponibles pour un paramètre spécifique. Comme dans une boîte de dialogue d'outil, le paramètre identifie et filtre les valeurs adéquates. Par exemple, l'outil AddXY_management accepte uniquement des classes d'entités ponctuelles ou des couches comme entités en entrée. Par conséquent, la liste déroulante de ce paramètre contient uniquement des couches d'entités ponctuelles. De la même façon, l'outil DeleteField_management fournit une liste déroulante des champs basée sur la table en entrée.
Paramètres à valeurs multiples
Un paramètre d'outil peut accepter une ou plusieurs valeurs, selon le paramètre. Lorsque plusieurs valeurs sont acceptables, la valeur du paramètre peut être spécifiée sous forme de liste Python.
L'outil Supprimer un champ accepte plusieurs champs pour la suppression. Pour supprimer plusieurs champs à l'aide de Supprimer un champ, saisissez les noms des champs sous forme de chaînes dans une liste Python.
arcpy.DeleteField_management("c:/base/rivers.shp", ["Type", "Turbidity", "Depth"])
Certains outils, tels que les outils de superposition Union_analysis et Intersect_analysis , possèdent des paramètres représentés comme une table, c'est-à-dire qu'ils contiennent plusieurs lignes, qui contiennent plusieurs valeurs. Dans le cas de l'outil Union_analysis, le paramètre Entités en entrée prend en charge l'utilisation de niveaux de priorité, qui permet de conserver les entités avec une haute précision. Un niveau de priorité est affecté à chaque classe d'entités en entrée sous forme d'une valeur facultative où 1 représente le niveau le plus élevé.
Les paramètres représentés comme une table s'appellent des tables de valeurs. Les tables de valeurs sont saisies sous la forme d'une liste Python de listes. Dans le cas du paramètre Entités en entrée dans Union_analysis, le niveau de priorité est défini après le nom de la classe d'entités, avec une virgule séparant les valeurs. Chaque paire de niveau de classe d'entité est contenu dans une liste plus élevée (d'où la liste de listes). L'exemple ci-dessous montre comment créer ce type de liste. L'environnement d'espace de travail a été défini pour vous épargner la répétition du même espace de travail pour chaque classe d'entités.
arcpy.env.workspace = "D:/St_Johns/data.mdb/neighborhoods"
input_list = [["east", 1], ["west", 1], ["south", 1], ["north", 2]]
arcpy.Union_analysis(input_list, "D:/base/data.gdb/land_use")
Conventions sur les paramètres
En général :
- Les noms des paramètres pour tous les jeux de données en entrée sont précédés du préfixe in_ et ceux correspondant aux jeux de données en sortie sont précédés du préfixe out_.
- Le jeu de données en entrée est habituellement le premier paramètre et le jeu de données en sortie est habituellement le dernier paramètre requis. D'autres paramètres obligatoires sont placés entre les jeux de données en entrée et en sortie.
- Les paramètres facultatifs suivent toujours les paramètres obligatoires.
Obtention d'aide dans la fenêtre Python
Une fois que vous avez entré le nom de la commande, vous pouvez obtenir ses modalités d'utilisation et une aide spécifique de l'outil de deux façons distinctes :
- Tapez le nom de l'outil à l'invite suivi par une parenthèse d'ouverture : arcpy.Buffer_analysis(. Cela affiche l'utilisation de l'outil et les information d'aide dans la fenêtre d'aide et de syntaxe.
- Utilisez la fonction d'aide intégrée de Python et transmettez le nom de l'outil pour lequel vous avez besoin d'aide. L'aide s'affiche dans la principale section Python.
- Utilisez l'attribut de fonction intégrée de Python __doc__ à la suite de l'outil pour afficher la chaîne de documentation. L'aide s'affiche dans la principale section Python.
>>> arcpy.Buffer_analysis(
>>> help(arcpy.Buffer_analysis)
>>> print arcpy.Buffer_analysis.__doc__