{"id":3440,"date":"2016-08-25T07:20:59","date_gmt":"2016-08-25T06:20:59","guid":{"rendered":"http:\/\/www.sigterritoires.fr\/?p=3440"},"modified":"2016-08-25T09:28:54","modified_gmt":"2016-08-25T08:28:54","slug":"configurer-eclipse-pour-developper-des-scripts-ou-des-plugins-qgis","status":"publish","type":"post","link":"https:\/\/www.sigterritoires.fr\/index.php\/configurer-eclipse-pour-developper-des-scripts-ou-des-plugins-qgis\/","title":{"rendered":"Configurer Eclipse pour d\u00e9velopper des scripts ou des plugins QGis"},"content":{"rendered":"

Eclipse est un projet, d\u00e9clin\u00e9 et organis\u00e9 en un ensemble de sous-projets de d\u00e9veloppements logiciels, de la fondation Eclipse visant \u00e0 d\u00e9velopper un environnement de production de logiciels libre qui soit extensible, universel et polyvalent, en s’appuyant principalement sur Java.<\/p>\n

Figurant parmi les grandes r\u00e9ussites de l’Open source, Eclipse est devenu un standard du march\u00e9 des logiciels de d\u00e9veloppement, int\u00e9gr\u00e9 par de grands \u00e9diteurs logiciels et soci\u00e9t\u00e9s de services.<\/p>\n

Vous pouvez d\u00e9velopper un plugin pour QGis avec un simple \u00e9diteur de texte, mais si vous voulez disposer d’un v\u00e9ritable environnement de d\u00e9veloppement, vous permettant de d\u00e9boguer rapidement vos scripts, Eclipse est la meilleure solution.
\n<\/p>\n

Par o\u00f9 commencer?<\/h2>\n
Vous devez t\u00e9l\u00e9charger et installer Eclipse ET<\/strong><\/em> le plugin PyDev<\/strong><\/em>.<\/p>\n
Pour t\u00e9l\u00e9charger la derni\u00e8re version d’Eclipse<\/strong> :<\/p>\n
https:\/\/www.eclipse.org\/downloads\/download.php?file=\/oomph\/epp\/neon\/R\/eclipse-inst-win64.exe&mirror_id=17<\/a><\/p>\n
Ex\u00e9cutez le fichier d’installation, en s\u00e9lectionnant l’installation \u00ab\u00a0Eclipse IDE for Java Developers\u00a0\u00bb<\/p>\n
$\"option$ <\/a><\/p>\n
Une fois l’installation termin\u00e9e, Eclipse<\/strong> se lance. Vous devez installer alors le plugin PyDev pour Eclipse. Pour cela:<\/p>\n
Allez dans le menu Help->Install New softwar<\/strong><\/em>e<\/p>\n
Dans \u00ab\u00a0Work with\u00a0\u00bb cliquez sur le bouton Add<\/strong><\/em><\/p>\n
$\"ajout$ <\/a><\/p>\n
Dans name<\/strong> <\/em>tapez PyDev<\/strong> et dans Location<\/strong> <\/em>l’adresse du site de t\u00e9l\u00e9chargement : http:\/\/pydev.org\/updates<\/em><\/strong>, puis cliquez sur OK<\/strong><\/p>\n
$\"ec3\"$ <\/a><\/p>\n
Cochez la case PyDev<\/strong><\/em>, puis sur Next<\/strong> <\/em>et compl\u00e9tez l’installation du plugin.<\/p>\n
Une fois termin\u00e9, vous devez relancer Eclipse. Vous devez d\u00e9finir l’interpr\u00e9teur Python \u00e0 utiliser:<\/p>\n
Allez dans le menu Windows->Preferences<\/strong><\/em><\/p>\n
$\"d\u00e9fiition$ <\/a><\/p>\n
Dans la fen\u00eatre de gauche, recherchez l’item PyDev -> Interpreters -> Python Interpreter<\/strong><\/em> puis cliquez sur le bouton New<\/strong><\/em><\/p>\n
$\"ec5\"$ <\/a><\/p>\n
Rentrez PyQGis<\/strong> <\/em>comme nom et pointez sur le fichier python.ex<\/strong><\/em>e de votre installation QGis. Il se trouve dans le r\u00e9pertoire bin<\/strong> <\/em>de celle-ci.<\/p>\n
Quand vous cliquez sur OK, le programme d’installation recherche \u00e0 ajouter automatiquement toutes les biblioth\u00e8ques Python disponibles. Si vous les laissez, vous allez tout droit sur des conflits entre biblioth\u00e8ques. Vous devez renseigner ces biblioth\u00e8ques manuellement pour \u00eatre s\u00fbr qu’elles ne rentreront pas en conflit.<\/p>\n
$\"ec6\"$ <\/a><\/p>\n
Cliquez sur Deselect AL<\/strong>L<\/strong><\/em> puis sur OK<\/strong><\/em>.<\/p>\n
Un message d’avertissement appara\u00eet vous indiquant qu’aucune biblioth\u00e8que n’a \u00e9t\u00e9 indiqu\u00e9e. Cliquez sur Proceed anyway<\/strong><\/em>.<\/p>\n
Maintenant c’est la partie la plus ennuyeuse de l’installation. Armez vous de patience…<\/p>\n
On va faire des aller-retour entre Eclipse<\/strong> et QGis<\/strong> pour renseigner toutes les biblioth\u00e8ques n\u00e9cessaires.<\/p>\n
Pour chaque Path<\/strong> <\/em>rep\u00e9r\u00e9 dans QGis<\/strong>, vous devrez cliquez sur le bouton New Folder<\/strong><\/em> d’Eclipse et pointer sur le r\u00e9pertoire concern\u00e9:<\/p>\n
$\"ec7\"$ <\/a><\/p>\n
Dans QGis<\/strong> nous allons utiliser la console Python. Ouvrez-la et tapez simplement qgis<\/strong><\/em> . Vous aurez en retour le path de l’API PyQGIS.<\/p>\n
$\"ec8\"$ <\/a>Usez de votre perspicacit\u00e9 pour d\u00e9coder la r\u00e9ponse, en sachant que \u00e7a correspond \u00e0 votre installation QGis. Dans cet exemple le d\u00e9but est Programmes\/QgisEssen. Ignorez les \/.\/ ainsi que le dernier \u00e9l\u00e9ment. En effet, ce que vous devrez renseigner dans Eclipse c’est le r\u00e9pertoire de ce dernier \u00e9l\u00e9ment.<\/p>\n
Dans Eclipse cliquez sur New Folder<\/strong><\/em> et dans la fen\u00eatre qui s’ouvre allez pointer sur le r\u00e9pertoire<\/p>\n
$\"ec9\"$ <\/a>Cliquez sur OK<\/strong>. Vous verrez alors le r\u00e9pertoire s’afficher dans la liste des System PYTHONPATH<\/p>\n
$\"ec10\"$ <\/a>Bon. Le plus dur reste \u00e0 faire. Tapez das la console Python<\/p>\n
import sys<\/strong><\/em>
\n sys.path<\/strong><\/em><\/p>\n
Vous aurez quelque chose comme<\/p>\n
$\"ec11\"$ <\/a>Pour chaque \u00e9l\u00e9ment du path vous devrez r\u00e9p\u00e9ter ce que nous venons de faire pour l’api PyQGIS, sauf pour les \u00e9l\u00e9ments dont vous \u00eates s\u00fbr qu’ils n’interviennent pas dans votre d\u00e9veloppement, \u00e0 savoir ceux qui ne correspondent pas \u00e0 votre nom d’utilisateur quand il s’ag\u00eet des path commen\u00e7ant par \\\\Users\\ ou ceux qui correspondent \u00e0 d’autres environnements logiciels que QGis (dans cet exemple les path commen\u00e7ant par \\\\PCI Geomatics).<\/p>\n
Une fois ceci fait pour tous les paths, ce n’est pas fini! Il reste \u00e0 renseigner les dlls de QGis.<\/p>\n
Dans la fen\u00eatre de Pr\u00e9f\u00e9rences d’Eclipse, cliquez sur l’onglet Environnement<\/p>\n
$\"ec12\"$ <\/a>Cliquez sur le bouton New. Dan la fen\u00eatre qui s’ouvre tapez PATH dans Name<\/strong> <\/em>et dans Value<\/strong> <\/em>vous devrez rentrer la liste des r\u00e9pertoires de QGis contenant des fichiers binaires, s\u00e9par\u00e9s par des ; .<\/p>\n
Sous Windows prenez la ligne suivante en modifiant la version de QGis pour qu’elle corresponde \u00e0 celle install\u00e9e sur votre poste:<\/p>\n
C:\\Program Files\\QGIS Brighton;C:\\Program Files\\QGIS
\nBrighton\\bin;C:\\Program Files\\QGIS Brighton\\apps\\qgis\\bin;C:\\Program
\nFiles\\QGIS Brighton\\apps\\Python27\\DLLs<\/p>\n
La configuration d’Eclipse est termin\u00e9e!!<\/p>\n

Comment d\u00e9boguer les scripts Python dans QGis?<\/h2>\n
Les deux QGIS<\/strong> et Eclipse<\/strong> doivent \u00eatre configur\u00e9s pour le d\u00e9bogage de sorte que les deux logiciels puissent communiquer. Eclipse<\/strong> se lie \u00e0 QGIS<\/strong> afin de vous donner un aper\u00e7u des scripts Python en cours d’ex\u00e9cution dans QGIS. Cette approche vous permet d’ex\u00e9cuter des scripts de mani\u00e8re contr\u00f4l\u00e9e, de suspendre l’ex\u00e9cution pendant que vous inspectez le programme pour d\u00e9tecter des bugs au moment et \u00e0 l’endroit o\u00f9 ils ont lieu.<\/p>\n
Quand vous lancez un script dans QGis, celui-ci passe la main \u00e0 Eclipse pour ex\u00e9cuter le code, qui \u00e0 sont tour et renvoy\u00e9 vers QGis.<\/p>\n
On doit donc configurer QGis pour qu’il envoie le flux vers Eclipse et Eclipse pour qu’il renvoie les r\u00e9sultats vers QGis.<\/p>\n
Configuration de QGis.<\/h3>\n
Dan cette \u00e9tape nous allons ajouter deux plugins \u00e0 QGIS, qui permettent \u00e0 Eclipse de communiquer avec QGIS. Un plugin, Plugin Reloader<\/strong><\/em>, vous permet de recharger un plugin QGIS en m\u00e9moire sans red\u00e9marrer QGIS, pour effectuer les tests plus rapidement. Le second plugin, Remote Debug<\/strong><\/em>, relie QGIS \u00e0 Eclipse.
\nRemote Debug<\/strong><\/em> est un plugin exp\u00e9rimental, donc vous devez vous assurer que les plugins exp\u00e9rimentaux sont visibles dans la liste des plugins disponibles du Gestionnaire d’extensions QGIS.<\/p>\n
$\"ec13\"$ <\/a><\/p>\n
Installez les deux plugins. Profitez pour installer aussi le HelloWorldPlugin qui vous servira \u00e0 tester votre configuration.Notez l’emplacement du plugin :<\/p>\n
$\"ec14\"$ <\/a><\/p>\n
Configuration d’Eclipse.<\/h3>\n
Lancez Eclipse<\/strong><\/p>\n
Allez dans le menu File->New->Project<\/strong><\/em><\/p>\n
$\"ec15\"$ <\/a><\/p>\n
S\u00e9lectionnez General<\/strong> <\/em>puis Project<\/strong> <\/em>et cliquez sur Next<\/strong><\/em><\/p>\n
$\"ec16\"$ <\/a><\/p>\n
Donnez un nom au projet, par exemple, pour tester le fonctionnement, ProjetHelloWorld<\/strong><\/em>, puis cliquez sur le bouton Finish<\/strong><\/em>.<\/p>\n
$\"ec17\"$ <\/a>S\u00e9lectionnez le projet que vous venez de cr\u00e9er, puis clic-droit et New -> Folder<\/strong><\/em><\/p>\n
$\"ec18\"$ <\/a><\/p>\n
<\/p>\n
Dans la fen\u00eatre New Folder<\/strong><\/em> qui s’ouvre, cliquez sur le bouton Advanced<\/strong><\/em><\/p>\n
$\"ec19\"$ <\/a><\/p>\n
Cochez la case \u00ab\u00a0Link to alternate location (Linked Folder)\u00a0\u00bb puis avec le bouton browse<\/strong> <\/em>pointez sur le r\u00e9pertoire du plugin \u00e0 d\u00e9boguer, dans notre exemple HelloWorld<\/em>, dans le r\u00e9pertoire que vous avez not\u00e9 lors de son installation.<\/p>\n
$\"ec20\"$ <\/a>Test de la configuration<\/h3>\n
Pour tester la configuration, nous allons placer un point d’arr\u00eat dans le code du script HelloWorld<\/strong><\/em>, le lancer dans QGis<\/strong>, constater que le code est bien sur arr\u00eat dans Eclipse<\/strong>, relancer l’ex\u00e9cution dans Eclipse<\/strong> et voir la fen\u00eatre s’afficher dans QGis<\/strong>.<\/p>\n
Pour placer le point d’arr\u00eat:<\/p>\n
Dans Eclipse<\/strong>, ouvrez le fichier HelloWorld.py en double-cliquant sur lui.<\/p>\n
$\"ec21\"$ <\/a><\/p>\n
Allez dans le menu Window -> Perspective -> Open Perspective -> Other…<\/strong><\/em><\/p>\n
$\"ec23\"$ <\/a><\/p>\n
Dans la nouvelle fen\u00eatre s\u00e9lectionnez Debug<\/strong> <\/em>et cliquez sur OK<\/strong><\/em><\/p>\n
$\"ec24\"$ <\/a><\/p>\n
La \u00ab\u00a0perspective\u00a0\u00bb de type d\u00e9bogage est prise par Eclipse<\/p>\n
$\"ec25\"$ <\/a><\/p>\n
Cherchez la premi\u00e8re ligne du plugin (def hello_world(self):) et double-cliquez \u00e0 gauche du num\u00e9ro de ligne pour placer un point d’arr\u00eat (punaise verte)<\/p>\n
A partir du menu PyDev, s\u00e9lectionnez Start Debug Server<\/strong><\/em>.<\/p>\n
$\"ec26\"$ <\/a>Vous devrez voir s’afficher le message<\/p>\n
Debug Server at port: 5678<\/strong><\/em><\/p>\n
Dans la console (en bas de la fen\u00eatre Eclipse).<\/p>\n
$\"ec27\"$ <\/a><\/p>\n
Maintenant, allez sur QGis<\/strong>. Dans le menu Extensions<\/strong> <\/em>cliquez sur Remote Debug -> Remote Debug<\/strong><\/em><\/p>\n
$\"c28\"$ <\/a><\/p>\n
La fen\u00eatre de Remote Debugger s’ouvre. Une derni\u00e8re configuration est n\u00e9cessaire.<\/p>\n
$\"ec29\"$ <\/a>Assurez-vous que Debugger<\/strong> <\/em>est bien plac\u00e9 sur PyDev(Eclipse)<\/strong><\/em>. Dans PyDevd path<\/strong><\/em>, comme son nom l’indique, il faut indiquer o\u00f9 se trouve le fichier pydevd.py<\/strong><\/em>.<\/p>\n
Le plus simple est de lancer une recherche dans le gestionnaire de fichiers Windows et de copier coller le path de ce fichier. Cette op\u00e9ration ne doit \u00eatre faite que la premi\u00e8re fois que vous utilisez Remote Debugger.<\/p>\n
Une fois fait, cliquez sur le bouton Connect<\/strong><\/em>. la fen\u00eatre se ferme et un message appara\u00eet dans QGis<\/strong> vous indiquant: Python Debugging Active<\/strong><\/em>.<\/p>\n
Lancez le plugin HeloWorld \u00e0 partir du menu Extension -> HelloWorld ->HelloWorld.<\/strong><\/em><\/p>\n
Ceci entra\u00eene, habituellement, l’affichage d’une fen\u00eatre de message avec le texte Hello World<\/em>. Par contre, ici, rien ne se passe.<\/p>\n
Allez dans Eclipse<\/strong>.<\/p>\n
Vous constaterez que la ligne avec le point d’arr\u00eat est surlign\u00e9e. Ceci veut dire que l’ex\u00e9cution du script est bien arr\u00eat\u00e9e \u00e0 ce point la.<\/p>\n
$\"ec31\"$ <\/a>Pour red\u00e9marrer l’ex\u00e9cution, allez dans le menu Run->Resume<\/strong><\/em><\/p>\n
Allez dans QGis. La fen\u00eatre Hello World est apparue!<\/p>\n
$\"ec32\"$ <\/a>La configuration de votre environnement de d\u00e9veloppement est termin\u00e9e.<\/p>\n","protected":false},"excerpt":{"rendered":"
Eclipse est un projet, d\u00e9clin\u00e9 et organis\u00e9 en un ensemble de sous-projets de d\u00e9veloppements logiciels, de la fondation Eclipse visant \u00e0 d\u00e9velopper un environnement de production de logiciels libre qui soit extensible, universel et polyvalent, en…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"give_campaign_id":0,"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"sfsi_plus_gutenberg_text_before_share":"","sfsi_plus_gutenberg_show_text_before_share":"","sfsi_plus_gutenberg_icon_type":"","sfsi_plus_gutenberg_icon_alignemt":"","sfsi_plus_gutenburg_max_per_row":"","_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[3,222,62],"tags":[339,340,279,131,58,223],"class_list":["post-3440","post","type-post","status-publish","format-standard","hentry","category-logiciel_libres","category-python","category-qgis-2","tag-eclipse","tag-ide","tag-plugin","tag-python","tag-qgis","tag-script"],"aioseo_notices":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p6XU0A-Tu","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/posts\/3440","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/comments?post=3440"}],"version-history":[{"count":0,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/posts\/3440\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/media?parent=3440"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/categories?post=3440"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/tags?post=3440"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}