Building A Python Plugin - QGIS Tutorials and Tips
Building A Python Plugin - QGIS Tutorials and Tips
Ujaval Gandhi
Follow @spatialthoughts
Change Language
English
Download PDF
[A4] (../pdf/building_a_python_plugin_a4.pdf) [Letter] (../pdf/building_a_python_plugin_letter.pdf)
Share
Download and install the Qt Creator software from SourgeForge (http://sourceforge.net/projects/qtcreator.mirror/ les/latest/download)
Windows
Download the OSGeo4W network installer (http://trac.osgeo.org/osgeo4w/) and choose Express Desktop Install. Install the package QGIS . After installation, you will
be able to access the pyrcc4 tool via the OSGeo4W Shell.
Mac
Install the Homebrew (http://brew.sh) package manager. Install PyQt package by running the following command:
Linux
Depending on your distribution, nd and install the python-qt4 package. On Ubuntu and Debian-based distributions, you can run the following command:
Windows
Notepad++ (http://notepad-plus-plus.org/) is a good free editor for windows. Download and install the Notepad++ editor (http://notepad-plus-
plus.org/repository/6.x/6.7.5/npp.6.7.5.Installer.exe).
Note
If you are using Notepad++, makes sure to check Replace by space at Settings Preferences Tab Settings. Python is very sensitive about whitespace and this
setting will ensure tabs and spaces are treated properly.
Note
Plugin Reloader is an experimental plugin. Make sure you have checked Show also experimental plugins in Plugin Manager settings if you cannot nd it.
Procedure
1. Open QGIS. Go to Plugins Plugin Builder Plugin Builder.
2. You will see the QGIS Plugin Builder dialog with a form. You can ll the form with details relating to our plugin. The Class name will be the name of the Python
Class containing the logic of the plugin. This will also be the name of the folder containing all the plugin les. Enter SaveAttributes as the class name. The
Plugin name is the name under which your plugin will appear in the Plugin Manager. Enter the name as Save Attributes . Add a description in the Description
eld. The Module name will be the name of the main python le for the plugin. Enter it as save_attributes . Leave the version numbers as they are. The Text
for menu item value will be how the users will nd your plugin in QGIS menu. Enter it as Save Attributes as CSV . Enter your name and email address in the
appropriate elds. The Menu eld will decide where your plugin item is added in QGIS. Since our plugin is for vector data, select Vector . Check the Flag the
plugin as experimental box at the bottom. Click OK.
3. Next, you will be prompted to choose a directory for your plugin. You need to browse to the QGIS python plugin directory on your computer and select Select
Folder. Typically, a .qgis2/ directory is located in your home directory. The plugin folder location will depend on your platform as follows: (Replace
username with your login name)
Windows
c:\Users\username\.qgis2\python\plugins
Mac
/Users/username/.qgis2/python/plugins
Linux
/home/username/.qgis2/python/plugins
4. You will see a con rmation dialog once your plugin template is created. Note the path to the plugin folder.
5. Before we can use the newly created plugin, we need to compile the resources.qrc le that was created by Plugin Builder. Launch the OSGeo4W Shell on
windows or a terminal on Mac or Linux.
6. Browse to the plugin directory where the output of Plugin Builder was created. You can use the cd command followed by the path to the directory.
cd c:\Users\username\.qgis2\python\plugins\SaveAttributes
7. Once you are in the directory, type make . This will run the pyrcc4 command that we had installed as part of Qt bindings for Python.
make
8. Now we are ready to have a rst look at the brand new plugin we created. Close QGIS and launch it again. Go to Plugins Manage and Install plugins and enable
the Save Attributes plugin in the Installed tab. You will notice that there is a new icon in the toolbar and a new menu entry under Vector Save Attributes
Save Attributes as CSV`. Select it to launch the plugin dialog.
9. You will notice a new blank dialog named Save Attributes. Close this dialog.
10. We will now design our dialog box and add some user interface elements to it. Open the Qt Creator program and to to File > Open File or Project....
11. Browse to the plugin directory and select the save_attributes_dialog_base.ui le. Click Open.
12. You will see the blank dialog from the plugin. You can drag-and-drop elements from the left-hand panel on the dialog. We will add a Combo Box type of Input
Widget. Drag it to the plugin dialog.
13. Resize the combo box and adjust its size. Now drag a Label type Display Widget on the dialog.
16. Lets reload our plugin so we can see the changes in the dialog window. Go to Plugin Plugin Reloader Choose a plugin to be reloaded.
17. Select SaveAttributes in the Congure Plugin reloader dialog.
18. Now click the Save Attributes as CSV button. You will see the newly designed dialog box.
19. Lets add some logic to the plugin that will populate the combo box with the layers loaded in QGIS. Go to the plugin directory and load the le
save_attributes.py in a text editor. Scroll down and nd the run(self) method. This method will be called when you click the toolbar button or select the
plugin menu item. Add the following code at the beginning of the method. This code gets the layers loaded in QGIS and adds it to the comboBox object from
the plugin dialog.
layers = self.iface.legendInterface().layers()
layer_list = []
for layer in layers:
layer_list.append(layer.name())
self.dlg.comboBox.addItems(layer_list)
20. Back in the main QGIS window, reload the plugin by going to Plugins Plugin Reloader Reload plugin: SaveAttributes. Alternatively, you can just press F5 . To
test this new functionality, we must load some layers in QGIS. After you load some data, launch the plugin by going to Vector Save Attributes Save Attributes
as CSV.
21. You will see that our combo box is now populated with the layer names that are loaded in QGIS.
22. Lets add remaining user interface elements. Switch back to Qt Creator and load the save_attributes_dialog_base.ui le. Add a Label Display Widget
and change the text to Select output file . Add a LineEdit type Input Widget that will show the output le path that the user has chosen. Next, add a
Push Button type Button and change the button label to ... . Note the object names of the widgets that we will have to use to interact with them. Save the
le.
23. We will now add python code to open a le browser when the user clicks the ... push button and show the select path in the line edit widget. Open the
save_attributes.py le in a text editor. Add QFileDialog to our list of imports at the top of the le.
24. Add a new method called select_output_file with the following code. This code will open a le browser and populate the line edit widget with the path of
the le that the user chose.
def select_output_file(self):
filename = QFileDialog.getSaveFileName(self.dlg, "Select output file ","", '*.txt')
self.dlg.lineEdit.setText(filename)
25. Now we need to add code so that when the ... button is clicked, select_output_file method is called. Scroll up to the __init__ method and add the
following lines at the bottom. This code will clear the previously loaded text (if any) in the line edit widget and also connect the select_output_file method
to the clicked signal of the push button widget.
self.dlg.lineEdit.clear()
self.dlg.pushButton.clicked.connect(self.select_output_file)
26. Back in QGIS, reload the plugin and open the Save Attributes` dialog. If all went ne, you will be able to click the ... button and select an output text le from
your disk.
27. When you click OK on the plugin dialog, nothing happens. That is because we have not added the logic to pull attribute information from the layer and write it
to the text le. We now have all the pieces in place to do just that. Find the place in the run method where it says pass . Replace it with the code below. The
explanation for this code can be found in Getting Started With Python Programming (getting_started_with_pyqgis.html).
filename = self.dlg.lineEdit.text()
output_file = open(filename, 'w')
selectedLayerIndex = self.dlg.comboBox.currentIndex()
selectedLayer = layers[selectedLayerIndex]
fields = selectedLayer.pendingFields()
fieldnames = [field.name() for field in fields]
for f in selectedLayer.getFeatures():
line = ','.join(unicode(f[x]) for x in fieldnames) + '\n'
unicode_line = line.encode('utf-8')
output_file.write(unicode_line)
output_file.close()
28. Now our plugin is ready. Reload the plugin and try it out. You will nd that the output text le you chose will have the attributes from the vector layer. You can
zip the plugin directory and share it with your users. They can unzip the contents to their plugin directory and try out your plugin. If this was a real plugin, you
would upload it to the QGIS Plugin Repository (https://plugins.qgis.org/) so that all QGIS users will be able to nd and download your plugin.
Note
This plugin is for demonstration purpose only. Do not publish this plugin or upload it to the QGIS plugin repository.
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
"""
from PyQt4.QtCore import QSettings, QTranslator, qVersion, QCoreApplication
from PyQt4.QtGui import QAction, QIcon, QFileDialog
# Initialize Qt resources from file resources.py
import resources_rc
# Import the code for the dialog
from save_attributes_dialog import SaveAttributesDialog
import os.path
class SaveAttributes:
"""QGIS Plugin Implementation."""
if os.path.exists(locale_path):
self.translator = QTranslator()
self.translator.load(locale_path)
self.dlg.lineEdit.clear()
self.dlg.pushButton.clicked.connect(self.select_output_file)
# noinspection PyMethodMayBeStatic
def tr(self, message):
"""Get the translation for a string using Qt translation API.
def add_action(
self,
icon_path,
text,
callback,
enabled_flag=True,
add_to_menu=True,
add_to_toolbar=True,
status_tip=None,
whats_this=None,
parent=None):
"""Add a toolbar icon to the toolbar.
:param icon_path: Path to the icon for this action. Can be a resource
path (e.g. ':/plugins/foo/bar.png') or a normal file system path.
:type icon_path: str
:param text: Text that should be shown in menu items for this action.
:type text: str
:param parent: Parent widget for the new action. Defaults None.
:type parent: QWidget
:param whats_this: Optional text to show in the status bar when the
mouse pointer hovers over the action.
:returns: The action that was created. Note that the action is also
added to self.actions list.
:rtype: QAction
"""
icon = QIcon(icon_path)
action = QAction(icon, text, parent)
action.triggered.connect(callback)
action.setEnabled(enabled_flag)
if add_to_toolbar:
self.toolbar.addAction(action)
if add_to_menu:
self.iface.addPluginToVectorMenu(
self.menu,
action)
self.actions.append(action)
return action
def initGui(self):
"""Create the menu entries and toolbar icons inside the QGIS GUI."""
icon_path = ':/plugins/SaveAttributes/icon.png'
self.add_action(
icon_path,
text=self.tr(u'Save Attributes as CSV'),
callback=self.run,
parent=self.iface.mainWindow())
def unload(self):
"""Removes the plugin menu item and icon from QGIS GUI."""
for action in self.actions:
self.iface.removePluginVectorMenu(
self.tr(u'&Save Attributes'),
action)
self.iface.removeToolBarIcon(action)
# remove the toolbar
del self.toolbar
def select_output_file(self):
filename = QFileDialog.getSaveFileName(self.dlg, "Select output file ","", '*.txt')
self.dlg.lineEdit.setText(filename)
def run(self):
"""Run method that performs all the real work"""
layers = self.iface.legendInterface().layers()
layer_list = []
for layer in layers:
layer_list.append(layer.name())
self.dlg.comboBox.addItems(layer_list)
# show the dialog
self.dlg.show()
# Run the dialog event loop
result = self.dlg.exec_()
# See if OK was pressed
if result:
# Do something useful here - delete the line containing pass and
# substitute with your code.
filename = self.dlg.lineEdit.text()
output_file = open(filename, 'w')
selectedLayerIndex = self.dlg.comboBox.currentIndex()
selectedLayer = layers[selectedLayerIndex]
fields = selectedLayer.pendingFields()
fieldnames = [field.name() for field in fields]
for f in selectedLayer.getFeatures():
line = ','.join(unicode(f[x]) for x in fieldnames) + '\n'
unicode_line = line.encode('utf-8')
output_file.write(unicode_line)
output_file.close()
Sort by Best
Recommend 4 Share
Good question. To integrate the .ui le you need to create a new .py le similar to save_attributes_dialog.py. Then import the Dialog from
that .py le into the save_attributes.py le to use it.
1 Reply Share
Error :
layer = shapele.GetLayer(0)
Reply Share
Thanks for the very helpful tutorials. I have a basic question: I can't display the .qgis2 folder when I search for a directory to install the plugin to
(step 3). I have tried changing the settings in the Terminal to display hidden folders, likewise I have tried selecting show hidden les when searching
in QGIS, both to no avail.
I suppose one solution would be to save the plugin to a visible folder in QGIS, then manually move it using the Terminal to ~/.qgis2/python/plugins,
but this seems silly. Is there no way to nd the .qgis2 folder directly?
But I have no clue how to nd the various elds (like the number of columns/row or where to store the le) in the Interpolation plugin.
Reply Share
Instead - you can use Processing. There are equivalent processing algorithms that can be programmatically congured and run via python
http://gis.stackexchange.com/q...
btw, for interpolation - there is a Raster Interpolation python plugin that can be accessed via python
http://gis.stackexchange.com/q...
Reply Share
import processing
GRASS_REGION_PARAMETER = '%f,%f,%f,%f'% (min_lon, max_lon, min_lat , max_lat)
processing.runandload("grass:v.voronoi", path_and_le_name_point,False, False, GRASS_REGION_PARAMETER, -1, 0, 3,
path_and_le_name_poly)
I had huge problems with getting the correct format for GRASS_REGION_PARAMETER. I had an extra space in the end which
resulted in that no polygon le were created ("= '%f, %f, %f, %f '%" etc. instead of "= '%f,%f,%f,%f'%" )
The only "problem" that remains now are that it takes rather long time to run the process with 100k+ points.
Reply Share
self.dlg.lineEdit.setTest(lename)
Im getting the following error when I go to save a vector layer using the plugin.
Reply Share
Reply Share
a.py
class A:
def run(self):
self.x = 20
b.py
from a import A
class B:
see more
Reply Share
How can make sub menu of sub menu in QGIS. Please see below
image.
Ok Thanks
Reply Share
self.iface.addPluginToVectorMenu to add the items, get a reference to appropriate menu. For example webMenu = self.iface.webMenu() and
then add a sub-menu and actions in the standard QT way. http://stackoverow.com/quest...
Reply Share
I'm having problems in the step#7: When I try to run the 'make' command, I get the message:
" 'make' is not recognized as an internal or external command, operable program or batch le."
*UPDATE*
Already solved the issue. The problem was that if you install QGIS, Python and Qt before installing OSGeo4w, you have to manually link all the
libraries between the programs. As an advice, download only OSGeo4w and select the Desktop Express Install, it will download QGIS, Python and
Qt (And some other things) and congure them automatically.
Still, it would be nice to include in this post how to link the libraries of QGIS, Python and Qt without having to reinstall them.
Reply Share
Thanks Pablo Adrian Q for the feedback. Managing dependencies and linking them is dicult to do manually so best let the OSGeo4W
installer gure it out. I realized the need to make that more explicit while teaching a in-person workshop so created this
https://drive.google.com/le/...
thanks again
Reply Share
@Bubu Italia Good catch. Your approach is the right way to handle this.
Reply Share
I've got as far as typimg 'make' but get the error: "make: *** No targets specied and no makele found. Stop."
Mark
Reply Share
Thank you.
Reply Share
Couldn't load plugin MultiStats due to an error when calling its classFactory() method