{"id":5631,"date":"2018-07-10T00:01:38","date_gmt":"2018-07-09T22:01:38","guid":{"rendered":"http:\/\/www.sigterritoires.fr\/?p=5631"},"modified":"2018-10-17T13:00:58","modified_gmt":"2018-10-17T11:00:58","slug":"how-to-set-up-eclipse-to-develop-qgis-scripts-or-plugins","status":"publish","type":"post","link":"https:\/\/www.sigterritoires.fr\/index.php\/en\/how-to-set-up-eclipse-to-develop-qgis-scripts-or-plugins\/","title":{"rendered":"How to set up Eclipse to develop QGis scripts or plugins"},"content":{"rendered":"

Eclipse software is an Eclipse Foundation project, developed and organized into a set of software sub-projects, to develop an open source software production environment that is open-ended, universal and versatile, relying mainly on Java.<\/p>\n

As one of the great success stories of Open Source, Eclipse has become a standard in the development software market, built in by leading software publishers as well as service companies.<\/p>\n

You can develop a plugin for QGis with a simple text editor, but if you want to have a real development environment, allowing you to quickly debug your scripts, Eclipse is the best solution.
\nWhere to start?<\/strong><\/p>\n

You must download and install\u00a0\u00a0\u00a0Eclipse AND<\/em><\/strong>\u00a0\u00a0\u00a0the plugin\u00a0\u00a0\u00a0PyDev<\/em><\/strong>\u00a0.<\/p>\n

To download the latest version of\u00a0Eclipse<\/strong>\u00a0\u00a0\u00a0:<\/p>\n

https:\/\/www.eclipse.org\/downloads\/download.php?file=\/oomph\/epp\/neon\/R\/eclipse-inst-win64.exe&mirror_id=17<\/a><\/p>\n

Run the installation file, selecting the installation \u00ab\u00a0Eclipse IDE for Java Developers\u00a0\u00bb<\/p>\n

\"\"<\/p>\n

Once the installation is complete,\u00a0\u00a0\u00a0Eclipse<\/strong>\u00a0starts.\u00a0Then you must install the PyDev plugin for Eclipse.<\/p>\n

Go to the menu\u00a0\u00a0\u00a0Help-> Install New software<\/em><\/strong><\/p>\n

Go to \u00ab\u00a0Work with\u00a0\u00bb and click \u00a0Add\u00a0 \u00a0\u00a0<\/em><\/strong><\/p>\n

\"\"<\/p>\n

Go to\u00a0\u00a0name<\/em><\/strong>\u00a0 and\u00a0<\/em>\u00a0type\u00a0\u00a0\u00a0PyDev<\/strong>\u00a0\u00a0\u00a0and in\u00a0\u00a0\u00a0location<\/em><\/strong>\u00a0<\/em>\u00a0the download site address:\u00a0\u00a0<\/strong>\u00a0http:\/\/pydev.org\/updates<\/em><\/strong>\u00a0, and then click\u00a0\u00a0\u00a0OK\u00a0\u00a0<\/strong><\/p>\n

\"\"<\/p>\n

Check the box\u00a0\u00a0\u00a0PyDev<\/em><\/strong>, \u00a0then\u00a0\u00a0Next<\/em><\/strong>\u00a0\u00a0<\/em>\u00a0and complete the plugin installation.<\/p>\n

Once finished, you must restart Eclipse.\u00a0You must define the Python interpreter to use:<\/p>\n

Go to the menu\u00a0\u00a0\u00a0Windows-> Preferences\u00a0<\/em><\/strong><\/p>\n

\"\"<\/p>\n

In the left window, search for the item\u00a0\u00a0\u00a0PyDev -> Interpreters -> Python Interpreter<\/em><\/strong>\u00a0\u00a0\u00a0then click on New\u00a0<\/strong><\/p>\n

\"\"<\/p>\n

Re-enter PyQGIS\u00a0\u00a0<\/em>\u00a0as name and point to the file\u00a0\u00a0\u00a0python.ex<\/em><\/strong>\u00a0e of your QGis installation.\u00a0It is located in its\u00a0\u00a0\u00a0bin<\/em><\/strong>\u00a0\u00a0<\/em>\u00a0directory.<\/p>\n

When you click OK, the setup programme researches automatically all the available Python libraries to be added. \u00a0If you let this happen, you’re going straight to conflicting libraries.\u00a0You have to fill in these libraries manually to make sure there is no contradiction. <\/strong><\/p>\n

\"\"<\/p>\n

A warning message appears telling you that no libraries have been specified.\u00a0Click on\u00a0\u00a0\u00a0Proceed anyway<\/em><\/strong>.<\/p>\n

Now, the most boring part of the installation.\u00a0Be as patient as possible…<\/p>\n

We will go back and forth between\u00a0\u00a0\u00a0Eclipse<\/strong>\u00a0\u00a0\u00a0and\u00a0\u00a0\u00a0QGis<\/strong>\u00a0\u00a0\u00a0to fill in all the necessary libraries.<\/p>\n

For each\u00a0\u00a0\u00a0Path<\/em><\/strong>\u00a0\u00a0<\/em>\u00a0spotted in\u00a0\u00a0\u00a0QGis<\/strong>\u00a0, you will have to click on the button\u00a0\u00a0\u00a0New Folder<\/em><\/strong>\u00a0\u00a0\u00a0of \u00a0Eclipse and point to the directory concerned:<\/p>\n

\"\"<\/p>\n

In\u00a0\u00a0\u00a0QGis<\/strong>\u00a0\u00a0\u00a0we will use the Python console.\u00a0Open it and simply type\u00a0\u00a0\u00a0qgis<\/em><\/strong>\u00a0\u00a0\u00a0.\u00a0You will get back the PyQGIS API path.\u00a0<\/strong><\/p>\n

\"\"<\/p>\n

Use your insight to decode the answer, knowing that it fits your QGis installation.\u00a0In this example the beginning is Programs \/ QgisEssen.\u00a0Ignore the \/.\/ as well as the last element.\u00a0Indeed, what you need to fill in Eclipse this last element directory.<\/p>\n

In Eclipse click\u00a0\u00a0\u00a0New Folder<\/em><\/strong>\u00a0\u00a0\u00a0and in the window that pops up, point directory<\/p>\n

\"\"<\/p>\n

Click OK<\/strong>.\u00a0You will see the directory displayed in the list of PYTHONPATH System<\/p>\n

\"\"<\/p>\n

Right! But the hardest remains to be done.\u00a0Type in the Python console<\/p>\n

import sys<\/em><\/strong>
\nsys.path<\/em><\/strong><\/p>\n

You will have something like this<\/p>\n

\"\"<\/p>\n

For each path element you will have to repeat what we have done for the PyQGIS API, except for items you are sure do not interfere with your development, ie those that do not match your username, those that start with \\\\ Users \\ or those which correspond to software environments other than QGis (in this example the path starting with \\\\ PCI Geomatics).<\/p>\n

Once this is done for all paths, it’s not over!\u00a0It remains to inform the QGis dlls.<\/p>\n

In the Eclipse Preferences window, click the Environment tab<\/p>\n

\"\"<\/p>\n

Click on New and in the window that opens type PATH in\u00a0\u00a0\u00a0Name<\/em><\/strong>\u00a0\u00a0<\/em>\u00a0and in\u00a0\u00a0\u00a0Value<\/em><\/strong>\u00a0\u00a0<\/em>\u00a0you will need to enter the list of QGis directories containing binary files, separated by;\u00a0.<\/p>\n

On Windows, take the following line and change the version of QGis to match the version installed on your computer:<\/p>\n

Brighton C: \\ Program Files \\ QGIS; C: \\ Program Files \\ QGIS
\nBrighton \\ bin; C: \\ Program Files \\ QGIS Brighton \\ apps \\ qgis \\ bin; C: \\ Program
\nBrighton Files \\ QGIS \\ apps \\ Python27 \\ DLLs<\/p>\n

The configuration of Eclipse is complete!!<\/p>\n

How to debug Python scripts in QGis?<\/strong><\/p>\n

Both\u00a0\u00a0\u00a0QGIS<\/strong>\u00a0\u00a0\u00a0and\u00a0\u00a0\u00a0Eclipse<\/strong>\u00a0\u00a0\u00a0must be configured for debugging so that both software can communicate.\u00a0\u00a0\u00a0Eclipse<\/strong>\u00a0\u00a0\u00a0binds to\u00a0\u00a0\u00a0QGIS<\/strong>\u00a0\u00a0\u00a0to give you an overview of the Python scripts running in QGIS.\u00a0This approach allows you to run scripts in a controlled manner, suspend execution while you inspect the program for bugs when and where they occur.<\/p>\n

When you launch a script in QGis, it is hand over to Eclipse to execute the code, which in turn is returned to QGis.<\/p>\n

So we have to configure QGis to send the stream to Eclipse and Eclipse to return the results to QGis.<\/p>\n

QGis Configuration.<\/strong><\/p>\n

In this step we will add two plugins to QGIS, which allow Eclipse to communicate with QGIS.\u00a0A plugin,\u00a0\u00a0\u00a0Plugin Reloader<\/em><\/strong>, allows you to reload a QGIS plugin into the memory without restarting QGIS, to run the tests faster.\u00a0The second plugin,\u00a0\u00a0\u00a0Remote Debug<\/em><\/strong>, links QGIS to Eclipse.
\nRemote Debug<\/em><\/strong>\u00a0\u00a0\u00a0is an experimental plugin, so you need to make sure the experimental plugins are visible in the list of available QGIS Plugin Manager plugins.<\/p>\n

\"\"<\/p>\n

Install both plugins.\u00a0Take advantage of the opportunity to install, as well, \u00a0the HelloWorldPlugin, which will be helpful to test your configuration. Note the plugin’s location:<\/p>\n

\"\"<\/p>\n

Eclipse configuration.<\/strong><\/p>\n

Launch\u00a0\u00a0\u00a0Eclipse<\/strong><\/p>\n

Go to the menu\u00a0\u00a0\u00a0File-> New-> Project\u00a0 \u00a0\u00a0<\/em><\/strong><\/p>\n

\"\"<\/p>\n

Select\u00a0\u00a0\u00a0General<\/em><\/strong>\u00a0\u00a0<\/em>\u00a0then\u00a0\u00a0\u00a0Project<\/em><\/strong>\u00a0\u00a0<\/em>\u00a0and click on\u00a0\u00a0\u00a0Next\u00a0\u00a0<\/em><\/strong><\/p>\n

\"\"<\/p>\n

Name the project, for example, to test the operation,\u00a0\u00a0\u00a0HelloWorld Project<\/em><\/strong>\u00a0, then click on the button\u00a0\u00a0\u00a0Finish<\/em><\/strong>\u00a0.<\/p>\n

\"\"<\/p>\n

Select the project you just created, then right-click and\u00a0\u00a0\u00a0New -> Folder\u00a0\u00a0<\/em><\/strong><\/p>\n

\"\"<\/p>\n

 <\/p>\n

In the window\u00a0\u00a0\u00a0New Folder<\/em><\/strong>\u00a0\u00a0\u00a0which pops up, click on the button\u00a0\u00a0\u00a0Advanced\u00a0<\/em><\/strong><\/p>\n

\"\"<\/p>\n

Check the box \u00a0\u201cLink to alternate location (Linked Folder)\u201d\u00a0\u00a0\u00a0Then with the button\u00a0\u00a0\u00a0browse<\/em><\/strong>\u00a0\u00a0<\/em>\u00a0point to the plugin directory to debug, in our example\u00a0\u00a0\u00a0HelloWorld<\/em>\u00a0, in the directory that you checked during its installation.<\/p>\n

\"\"<\/p>\n

 <\/p>\n

Configuration Test<\/strong><\/p>\n

To test the configuration, we will place a breakpoint in the script code\u00a0\u00a0\u00a0HelloWorld<\/em><\/strong>\u00a0, launch it in\u00a0\u00a0\u00a0QGis<\/strong>\u00a0, verify the code is on stop in\u00a0\u00a0\u00a0Eclipse<\/strong>\u00a0, restart execution in\u00a0\u00a0\u00a0Eclipse<\/strong>\u00a0\u00a0\u00a0and see the window appearing in\u00a0\u00a0\u00a0QGis<\/strong>\u00a0.<\/p>\n

To set the breakpoint:<\/p>\n

In\u00a0\u00a0\u00a0Eclipse<\/strong>, open the HelloWorld.py file by double-clicking on it.\u00a0<\/strong><\/p>\n

\"\"<\/p>\n

Go to the menu\u00a0\u00a0\u00a0Window -> Perspective -> Open Perspective -> Other …\u00a0<\/em><\/strong><\/p>\n

\"\"<\/p>\n

In the new window select\u00a0\u00a0\u00a0debug<\/em><\/strong>\u00a0\u00a0<\/em>\u00a0and click on\u00a0\u00a0\u00a0OK\u00a0 \u00a0<\/em><\/strong><\/p>\n

\"\"<\/p>\n

The \u00ab\u00a0perspective\u201d\u00a0\u00a0\u00a0Debug type is taken by Eclipse<\/p>\n

\"\"<\/p>\n

Look for the first line of the plugin (def hello_world (self) \ud83d\ude42 and double-click to the left of the line number to place a breakpoint (green bug)<\/p>\n

From the PyDev menu, select\u00a0\u00a0\u00a0Start Debug Server<\/em><\/strong>. <\/strong><\/p>\n

\"\"<\/p>\n

Debug Server at port: 5678<\/em><\/strong><\/p>\n

In the console (bellow the Eclipse window).<\/p>\n

\"\"<\/p>\n

Now, go to\u00a0QGis<\/strong>\u00a0.\u00a0In the\u00a0\u00a0\u00a0Extensions<\/em><\/strong>\u00a0menu\u00a0<\/em>\u00a0click on\u00a0\u00a0\u00a0Remote Debug -> Remote Debug\u00a0\u00a0<\/em><\/strong><\/p>\n

\"\"<\/p>\n

The Remote Debugger window opens.\u00a0A last configuration is necessary.<\/p>\n

\"\"<\/p>\n

Be sure that\u00a0\u00a0\u00a0Debugger<\/em><\/strong>\u00a0\u00a0<\/em>\u00a0is placed on\u00a0\u00a0\u00a0PyDev (Eclipse)<\/em><\/strong>.\u00a0In\u00a0\u00a0\u00a0PyDevd path<\/em><\/strong>, as its name suggests, indicate where the file \u00a0\u00a0\u00a0pydevd.py<\/em><\/strong>\u00a0is located.<\/p>\n

The easiest way is to search the Windows file manager and copy paste the path of that file.\u00a0You only have to perform this operation the first time you use Remote Debugger.<\/p>\n

Once done, click Connect<\/em><\/strong>, the window closes and a message appears in\u00a0\u00a0\u00a0QGis<\/strong>\u00a0\u00a0\u00a0indicating you:\u00a0\u00a0\u00a0Python Debugging Active<\/em><\/strong>\u00a0.<\/p>\n

Launch the HeloWorld plugin from the menu\u00a0\u00a0\u00a0Extension -> HelloWorld -> HelloWorld.<\/em><\/strong><\/p>\n

This, usually, results in displaying a message window with the text\u00a0\u00a0\u00a0Hello World<\/em>\u00a0.\u00a0But here, nothing happens.<\/p>\n

Go to\u00a0Eclipse<\/strong>\u00a0.<\/p>\n

You will verify that the line with the breakpoint is highlighted.\u00a0This means that the execution of the script is stopped at this point.<\/p>\n

\"\"<\/p>\n

To restart the execution, go to the menu\u00a0\u00a0\u00a0Run-> Restart<\/em><\/strong><\/p>\n

Go to QGis.\u00a0The Hello World window has appeared!<\/p>\n

\"\"<\/p>\n

The configuration of your development environment is complete.<\/p>\n","protected":false},"excerpt":{"rendered":"

Eclipse software is an Eclipse Foundation project, developed and organized into a set of software sub-projects, to develop an open source software production environment that is open-ended, universal and versatile, relying mainly on Java. As one…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_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_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_post_was_ever_published":false},"categories":[1260],"tags":[],"class_list":["post-5631","post","type-post","status-publish","format-standard","hentry","category-non-classe-en"],"aioseo_notices":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p6XU0A-1sP","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/posts\/5631","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=5631"}],"version-history":[{"count":0,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/posts\/5631\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/media?parent=5631"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/categories?post=5631"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/tags?post=5631"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}