16.1. Python Eklentileri Yapısı

Bir eklenti yazmak için takip edilmesi gereken adımlar:

  1. Fikir: Yeni QGIS eklentinizin ne yapacağı hakkında bir fikriniz olmalı. Neden, hangi problemi çözümleyeceksiniz? Bu problemi çözümleyen başka bir eklenti var mı?

  2. Dosyaları oluşturma: Gerekli adımlar için (see Eklenti dosyaları)

  3. Kod yazma: Uygun dosyalar içerisinde kod yazma

  4. Test: Herşeyin yolunda olduğunu kontrol etmek için Eklentinizi yeniden yükleyin

  5. Yayınlama: Eklentinizi QGIS sunucusunda yayınlayın veya kişisel “GIS gücünüz” olarak kişisel “depo” nuzda saklayın

16.1.1. Bir eklenti yazma

QGIS Python eklentilerine destek vermeye başladığında bazı eklentiler oluşturuldu. QGIS takımı Official Python plugin repository içerisinde bunları sunar. Bu eklentilerin kodlarından faydalanarak kendinizi eğitebilir veya üzerine eklemeler yaparak PyQGIS programlama işlemlerini kolaylaştırabilirsiniz.

16.1.1.1. Eklenti dosyaları

Örnek bir eklenti için klasör içeriği:

PYTHON_PLUGINS_PATH/
  MyPlugin/
    __init__.py    --> *required*
    mainPlugin.py  --> *core code*
    metadata.txt   --> *required*
    resources.qrc  --> *likely useful*
    resources.py   --> *compiled version, likely useful*
    form.ui        --> *likely useful*
    form.py        --> *compiled version, likely useful*

Bu dosyalar ne işe yarar:

  • __init__.py = eklentinizin başlangıç noktasıdır. classFactory() metoduna ve diğer başvurulan kodların başlatma kodlarını içermelidir.

  • mainPlugin.py = Eklentinin ana dosyasıdır. Bütün işleyicilerin bilgileri ve ana kodları içerir.

  • resources.qrc = QT Designer tarafından oluşturulabilen bir .xml dosyasıdır. Görsel arayüzlere ait kaynakların dosya yollarını barındırır.

  • resources.py = .qrc dosyasının Python tarafından tanımlanmış çevirisidir.

  • form.ui = Qt Designer tarafından oluşturulmuş kullanıcı arayüzüdür.

  • form.py = form.ui dosyasının Python tarafından tanımlanmış hali.

  • metadata.txt = Genel bilgileri, versaiyon numarasını, adını ve eklentinin web sitesini, eklenti yapısı gibi bilgileri içerir.

Burada Standart QGIS Python eklentisi için temel (iskelet) dosyalarını bulabilirsiniz.

Ayrıca QGIS Plugin Builder 3 <https://plugins.qgis.org/plugins/pluginbuilder3/> eklentisi _ varsayılan özelliklerle QGIS 3.x uyumlu eklenti şablonu oluşturur.

Uyarı

Eğer eklentinizi Official Python plugin repository içine yüklemek istiyorsanız bazı kurallara uymalı, kurallar için Validation sayfasına bakınız.

16.1.2. Eklenti içeriği

Burada dosya içeriklerinde neler olması gerektiğiyle ilgili bilgi ve örnekleri bulabilirsiniz.

16.1.2.1. Eklenti metaadata içeriği

Eklenti yöneticisi eklentiniz hakknda bazı basit bilgilere ihtiyaç duyar, adı, tanımlaması gibi. Bu bilgiler için metadata.txt doğru yerdir.

Not

Metadata dosyanız UTF-8 karakter kodlamasına sahip olmalı.

Metadata adı

Gerekli

Notlar

ad

Evet

eklenti adı, kısa bir metin

qgisMinimumVersion

Evet

nokta notasyonu ile minimum QGIS versiyonu

qgisMaximumVersion

Hayır

nokta notasyonu ile maksimum QGIS versiyonu

description

Evet

eklentinin kısa bir tanımlaması, HTML kodları kabul edilmiyor.

about

Evet

eklentinin detaylı tanımlaması, HTML kodları kabul edilmiyor

version

Evet

eklentinin versiyon numarası, nokta notasyonuyla

author

Evet

programcı adı

email

Evet

programcının mail adresi, web sitesinde oturum açmış kullanıcılara gösterilir. Eklenti yöneticisinde eklentiniz yüklendiğinde gösterilir.

changelog

Hayır

değişiklikler, çok satırlı olabilir, HTML kabul edilmiyor.

experimental

Hayır

boolean flag, True or False - True if this version is experimental

deprecated

Hayır

kullanımdan kaldırılmış mı, True veya False, sadece yüklenen sürüme değil, tüm eski versiyonlara etki eder.

tags

Hayır

etiketler listesi, virgülle ayrılmış olarak girilir. Her etiket içinde boşluk kullanılabilir.

homepage

Hayır

eklentinin websitesi için URL linki.

repository

Evet

kod kaynağı için bir URL linki

tracker

Hayır

hata bildirimleri için bir URL linki

icon

Hayır

görseller için simge dosyası yolu (sıkıştırılmış paketin ana dizinine bağıl yol) resim tipi (PNG, JPEG) web uyumlu olmalı

category

Hayır

kategori Raster, Vector, Database ve Web tipi olabilir

plugin_dependencies

Hayır

PIP yükleme stilinde virgülle ayrılmış, eklentinin çalışması için ihtiyaç duyduğu eklentiler listesi

server

Hayır

boolean flag, True or False, determines if the plugin has a server interface

hasProcessingProvider

Hayır

işlem sunucusu mu, True veya False, eklentinin işleme algoritmaları içerdiğini gösterir

Eklentiniz varsayılan olarak Plugins menüsü içerisinde görünür. (sonraki bölümde eklenti için menü oluşturmayı göreceğiz) Seçime bağlı olarak Raster, Vector, Database veya Web menüleri içerisinde görüntülenebilir.

metadata içinde “category” seçimine göre eklenti türü seçilir. Metadata verisi eklentinin nerede bulunabileceğini (hangi menüde) belirtir. “category” için seçenekler: Vector, Raster, Database veya Web. Örneğin, eklentiniz Raster menüsünde olacaksa metadata.txt içerisinde belirtin.

category=Raster

Not

Eğer qgisMaximumVersion değeri boş geçilirse, Official Python plugin repository içerisine yüklenirken otomatik olarak ana versiyon numarasına .99 eklenir.

Örnek metadata.txt içeriği

; the next section is mandatory

[general]
name=HelloWorld
email=me@example.com
author=Just Me
qgisMinimumVersion=3.0
description=This is an example plugin for greeting the world.
    Multiline is allowed:
    lines starting with spaces belong to the same
    field, in this case to the "description" field.
    HTML formatting is not allowed.
about=This paragraph can contain a detailed description
    of the plugin. Multiline is allowed, HTML is not.
version=version 1.2
tracker=http://bugs.itopen.it
repository=http://www.itopen.it/repo
; end of mandatory metadata

; start of optional metadata
category=Raster
changelog=The changelog lists the plugin versions
    and their changes as in the example below:
    1.0 - First stable release
    0.9 - All features implemented
    0.8 - First testing release

; Tags are in comma separated value format, spaces are allowed within the
; tag name.
; Tags should be in English language. Please also check for existing tags and
; synonyms before creating a new one.
tags=wkt,raster,hello world

; these metadata can be empty, they will eventually become mandatory.
homepage=https://www.itopen.it
icon=icon.png

; experimental flag (applies to the single version)
experimental=True

; deprecated flag (applies to the whole plugin and not only to the uploaded version)
deprecated=False

; if empty, it will be automatically set to major version + .99
qgisMaximumVersion=3.99

; Since QGIS 3.8, a comma separated list of plugins to be installed
; (or upgraded) can be specified.
; The example below will try to install (or upgrade) "MyOtherPlugin" version 1.12
; and any version of "YetAnotherPlugin"
plugin_dependencies=MyOtherPlugin==1.12,YetAnotherPlugin

16.1.2.2. __init__.py

Bu dosya Python bileşen çağırma sistemi için gereklidir. Ayrıca, eklentiniz QGIS içerisinde çalışacaksa classFactory() fonksiyonunun olmasını gerektirir. Fonksiyon QgisInterface ` sınıfını çağırmalı ve :file:`mainplugin.py dosyanızdaki eklentinin ana sınıfını geri döndürmelidir — örnekte TestPlugin (aşağıda) dosyasındaki gibi . __init__.py dosyası nasıl olmalı:

def classFactory(iface):
  from .mainPlugin import TestPlugin
  return TestPlugin(iface)

# any other initialisation needed

16.1.2.3. mainPlugin.py

Burası sihrin gerçekleştiği yer ve işte sihrin nasıl göründüğü: (örn. mainPlugin.py)

from qgis.PyQt.QtGui import *
from qgis.PyQt.QtWidgets import *

# initialize Qt resources from file resources.py
from . import resources

class TestPlugin:

  def __init__(self, iface):
    # save reference to the QGIS interface
    self.iface = iface

  def initGui(self):
    # create action that will start plugin configuration
    self.action = QAction(QIcon(":/plugins/testplug/icon.png"),
                          "Test plugin",
                          self.iface.mainWindow())
    self.action.setObjectName("testAction")
    self.action.setWhatsThis("Configuration for test plugin")
    self.action.setStatusTip("This is status tip")
    self.action.triggered.connect(self.run)

    # add toolbar button and menu item
    self.iface.addToolBarIcon(self.action)
    self.iface.addPluginToMenu("&Test plugins", self.action)

    # connect to signal renderComplete which is emitted when canvas
    # rendering is done
    self.iface.mapCanvas().renderComplete.connect(self.renderTest)

  def unload(self):
    # remove the plugin menu item and icon
    self.iface.removePluginMenu("&Test plugins", self.action)
    self.iface.removeToolBarIcon(self.action)

    # disconnect form signal of the canvas
    self.iface.mapCanvas().renderComplete.disconnect(self.renderTest)

  def run(self):
    # create and show a configuration dialog or something similar
    print("TestPlugin: run called!")

  def renderTest(self, painter):
    # use painter for drawing to map canvas
    print("TestPlugin: renderTest called!")

The only plugin functions that must exist in the main plugin source file (e.g. mainPlugin.py) are:

  • __init__ which gives access to QGIS interface

  • initGui() called when the plugin is loaded

  • unload() called when the plugin is unloaded

In the above example, addPluginToMenu is used. This will add the corresponding menu action to the Plugins menu. Alternative methods exist to add the action to a different menu. Here is a list of those methods:

Bütün hepsinde addPluginToMenu metodundakine benzer yapı vardır.

Adding your plugin menu to one of those predefined method is recommended to keep consistency in how plugin entries are organized. However, you can add your custom menu group directly to the menu bar, as the next example demonstrates:

def initGui(self):
    self.menu = QMenu(self.iface.mainWindow())
    self.menu.setObjectName("testMenu")
    self.menu.setTitle("MyMenu")

    self.action = QAction(QIcon(":/plugins/testplug/icon.png"),
                          "Test plugin",
                          self.iface.mainWindow())
    self.action.setObjectName("testAction")
    self.action.setWhatsThis("Configuration for test plugin")
    self.action.setStatusTip("This is status tip")
    self.action.triggered.connect(self.run)
    self.menu.addAction(self.action)

    menuBar = self.iface.mainWindow().menuBar()
    menuBar.insertMenu(self.iface.firstRightStandardMenu().menuAction(),
                       self.menu)

def unload(self):
    self.menu.deleteLater()

Don’t forget to set QAction and QMenu objectName to a name specific to your plugin so that it can be customized.

16.1.2.4. Resource Dosyası

You can see that in initGui() we’ve used an icon from the resource file (called resources.qrc in our case)

<RCC>
  <qresource prefix="/plugins/testplug" >
     <file>icon.png</file>
  </qresource>
</RCC>

It is good to use a prefix that will not collide with other plugins or any parts of QGIS, otherwise you might get resources you did not want. Now you just need to generate a Python file that will contain the resources. It’s done with pyrcc5 command:

pyrcc5 -o resources.py resources.qrc

Not

In Windows environments, attempting to run the pyrcc5 from Command Prompt or Powershell will probably result in the error “Windows cannot access the specified device, path, or file […]”. The easiest solution is probably to use the OSGeo4W Shell but if you are comfortable modifying the PATH environment variable or specifiying the path to the executable explicitly you should be able to find it at <Your QGIS Install Directory>\bin\pyrcc5.exe.

And that’s all… nothing complicated :)

If you’ve done everything correctly you should be able to find and load your plugin in the plugin manager and see a message in console when toolbar icon or appropriate menu item is selected.

When working on a real plugin it’s wise to write the plugin in another (working) directory and create a makefile which will generate UI + resource files and install the plugin into your QGIS installation.

16.1.3. Documentation

The documentation for the plugin can be written as HTML help files. The qgis.utils module provides a function, showPluginHelp() which will open the help file browser, in the same way as other QGIS help.

The showPluginHelp() function looks for help files in the same directory as the calling module. It will look for, in turn, index-ll_cc.html, index-ll.html, index-en.html, index-en_us.html and index.html, displaying whichever it finds first. Here ll_cc is the QGIS locale. This allows multiple translations of the documentation to be included with the plugin.

The showPluginHelp() function can also take parameters packageName, which identifies a specific plugin for which the help will be displayed, filename, which can replace “index” in the names of files being searched, and section, which is the name of an html anchor tag in the document on which the browser will be positioned.

16.1.4. Translation

With a few steps you can set up the environment for the plugin localization so that depending on the locale settings of your computer the plugin will be loaded in different languages.

16.1.4.1. Software requirements

The easiest way to create and manage all the translation files is to install Qt Linguist. In a Debian-based GNU/Linux environment you can install it typing:

sudo apt install qttools5-dev-tools

16.1.4.2. Files and directory

When you create the plugin you will find the i18n folder within the main plugin directory.

All the translation files have to be within this directory.

16.1.4.2.1. .pro file

First you should create a .pro file, that is a project file that can be managed by Qt Linguist.

In this .pro file you have to specify all the files and forms you want to translate. This file is used to set up the localization files and variables. A possible project file, matching the structure of our example plugin:

FORMS = ../form.ui
SOURCES = ../your_plugin.py
TRANSLATIONS = your_plugin_it.ts

Your plugin might follow a more complex structure, and it might be distributed across several files. If this is the case, keep in mind that pylupdate5, the program we use to read the .pro file and update the translatable string, does not expand wild card characters, so you need to place every file explicitly in the .pro file. Your project file might then look like something like this:

FORMS = ../ui/about.ui ../ui/feedback.ui \
        ../ui/main_dialog.ui
SOURCES = ../your_plugin.py ../computation.py \
          ../utils.py

Furthermore, the your_plugin.py file is the file that calls all the menu and sub-menus of your plugin in the QGIS toolbar and you want to translate them all.

Finally with the TRANSLATIONS variable you can specify the translation languages you want.

Uyarı

Be sure to name the ts file like your_plugin_ + language + .ts otherwise the language loading will fail! Use the 2 letter shortcut for the language (it for Italian, de for German, etc…)

16.1.4.2.2. .ts file

Once you have created the .pro you are ready to generate the .ts file(s) for the language(s) of your plugin.

Open a terminal, go to your_plugin/i18n directory and type:

pylupdate5 your_plugin.pro

you should see the your_plugin_language.ts file(s).

Open the .ts file with Qt Linguist and start to translate.

16.1.4.2.3. .qm file

When you finish to translate your plugin (if some strings are not completed the source language for those strings will be used) you have to create the .qm file (the compiled .ts file that will be used by QGIS).

Just open a terminal cd in your_plugin/i18n directory and type:

lrelease your_plugin.ts

now, in the i18n directory you will see the your_plugin.qm file(s).

16.1.4.3. Translate using Makefile

Alternatively you can use the makefile to extract messages from python code and Qt dialogs, if you created your plugin with Plugin Builder. At the beginning of the Makefile there is a LOCALES variable:

LOCALES = en

Add the abbreviation of the language to this variable, for example for Hungarian language:

LOCALES = en hu

Now you can generate or update the hu.ts file (and the en.ts too) from the sources by:

make transup

After this, you have updated .ts file for all languages set in the LOCALES variable. Use Qt Linguist to translate the program messages. Finishing the translation the .qm files can be created by the transcompile:

make transcompile

You have to distribute .ts files with your plugin.

16.1.4.4. Load the plugin

In order to see the translation of your plugin, open QGIS, change the language (Settings ‣ Options ‣ General) and restart QGIS.

You should see your plugin in the correct language.

Uyarı

If you change something in your plugin (new UIs, new menu, etc..) you have to generate again the update version of both .ts and .qm file, so run again the command of above.

16.1.5. Tips and Tricks

16.1.5.1. Plugin Reloader

During development of your plugin you will frequently need to reload it in QGIS for testing. This is very easy using the Plugin Reloader plugin. You can find it with the Plugin Manager.

16.1.5.2. Accessing Plugins

You can access all the classes of installed plugins from within QGIS using python, which can be handy for debugging purposes.

my_plugin = qgis.utils.plugins['My Plugin']

16.1.5.3. Log Messages

Plugins have their own tab within the Log Messages Panel.

16.1.5.4. Share your plugin

QGIS is hosting hundreds of plugins in the plugin repository. Consider sharing yours! It will extend the possibilities of QGIS and people will be able to learn from your code. All hosted plugins can be found and installed from within QGIS with the Plugin Manager.

Information and requirements are here: plugins.qgis.org.