Concepts fondamentaux liés aux compléments Python

Ce document présente des concepts indispensables à la compréhension de la création de compléments avec Python.

Assistant de complément Python

Afin de simplifier le développement des compléments Python, il est recommandé d'utiliser l'assistant de complément Python pour déclarer le type de personnalisation. L'assistant de complément Python réduit la durée du développement et le nombre d'erreurs éventuelles en créant les fichiers et dossiers nécessaires au fonctionnement du complément.

Télécharger l'assistant de complément Python.

Il s'agit d'un fichier compressé ZIP (.zip) contenant tous les fichiers nécessaires à la prise en charge de l'assistant. Pour utiliser l'assistant, décompressez le contenu dans un dossier et localisez le fichier exécutable nommé addin_assistant.exe dans le dossier bin ; double-cliquez sur cet exécutable pour lancer l'assistant. Vous trouverez des exemples d'utilisation de l'assistant de complément Python dans les rubriques relatives à la création de compléments.

Astuce:

Créez un raccourci du fichier exécutable sur le Bureau ou dans la barre de lancement rapide.

Structure de fichiers et de dossiers

Un complément est un ensemble de fichiers et de dossiers rassemblés dans un fichier compressé portant une extension .esriaddin qui le rend facilement identifiables par les utilisateurs et par l'utilitaire d'installation des compléments ESRI d'ArcGIS. Par exemple, si vous double-cliquez sur un complément dans l'Explorateur Windows, sur un site Internet ou dans un courrier électronique, l'utilitaire d'installation de compléments installe automatiquement le complément sur l'ordinateur, et le déploie dans un dossier connu.

Les compléments possèdent un fichier config.xml situé au niveau de la racine de l'archive de compléments. Ce fichier décrit le complément et déclare ses personnalisations. Il est créé par l'assistant de complément Python lorsque vous cliquez sur le bouton Enregistrer. Il contient toutes les informations décrivant le complément, comme le produit ArcGIS, les légendes, les info-bulles, les informations relatives à l'Aide, les images et les informations liées à la mise en page.

Les compléments possèdent également un dossier Install. La principale finalité du dossier Install est de contenir le script Python (la partie active) du complément. Par exemple, un bouton est déclaré dans le fichier de configuration, mais son comportement personnalisé est défini dans le script Python associé.

Vous pouvez créer des dossiers et fichiers supplémentaires dans le dossier Install. Cela est utile lorsque vous voulez envoyer des données dans le cadre du complément. Ces données peuvent être des éléments tels que des fichiers de couche, des boîtes à outils et des fichiers .xml. Pour accéder aux données contenues dans l'emplacement d'installation, vous pouvez faire appel à la fonction intégrée __file__. Cet exemple illustre l'accès à un fichier de couches dans un dossier de données contenu dans le dossier d'installation :

eq_layer = os.path.join(os.path.dirname(__file__), r'data\earth_quakes.lyr')

La plupart des types de compléments déclarés ont des graphiques associés. Tous les graphiques saisis par le biais de l'assistant sont référencés dans le fichier de configuration et copiés dans le dossier Images, au niveau de la racine de l'archive.

Le graphique suivant présente la structure de fichiers et de dossiers d'un fichier de complément (.esriaddin) :

makeaddin.py

Le fichier Python makeaddin.py est un script d'utilitaire créé par l'assistant de complément Python pour rassembler les fichiers et les dossiers au sein du dossier de projet dans le fichier de complément compressé. Double-cliquez sur ce fichier pour créer le fichier de complément. À chaque fois que vous apportez des changements au complément, vous devez exécuter ce script et réempaqueter le fichier de complément avec les mises à jour les plus récentes.

Emplacements de dossier connus

Les compléments sont détectés automatiquement au démarrage d'ArcGIS for Desktop dans un dossier connu de version par utilisateur/par poste. Par exemple :

• Vista/7 : C:\Utilisateurs\<nomutilisateur>\Documents\ArcGIS\AddIns\Desktop10.1
• XP : C:\Documents and Settings\<nomutilisateur>\Mes Documents\ArcGIS\AddIns\Desktop10.1

Les compléments sont automatiquement ajoutés ou supprimés grâce à l'utilitaire d'installation des compléments ESRI d'ArcGIS et à la boîte de dialogue Gestionnaire de compléments. La boîte de dialogue Gestionnaire de compléments d'ArcGIS for Desktop permet également d'ajouter des dossiers connus, qui peuvent être des partages réseau.

En outre, les compléments extraient automatiquement le contenu de leur dossier Install dans un dossier temporaire. Par exemple :

• Vista/7 : C:\Utilisateurs\<nomutilisateur>\AppData\Local\ESRI\Desktop10.1\AssemblyCache
• XP : C:\Documents and Settings\<nomutilisateur>\Local Settings\Application Data\ESRI\Desktop10.1\AssemblyCache

Ces données sont supprimées automatiquement par la structure du complément une fois que celui-ci détecte que le complément n'est plus installé dans le système.