GIS-Lab - Вклад [ru]

Разработка простого расширения для QGIS на Python

2017-03-21T11:12:06Z

Elf: Уточнение ОС для раздела "Интернационализация"

{{Статья|Опубликована|qgis-dev-python}}
{{Аннотация|Описание процесса создания элементарного расширения для QGIS.}}

QGIS — свободная пользовательская ГИС, обладающая развитым API и продвинутой системой расширений (модулей). Модули создаются для расширения функциональности программы. QGIS написана на объектно-ориентированном языке высокого уровня C++. Так же в QGIS встроены привязки (bindings), которые реализуют практически весь функционал QGIS на языке Python. Графический интерфейс пользователя QGIS базируется на библиотеках Qt4. Разработка для QGIS может вестись на двух языках, Python и C++. Для разработки на языке Python необходимы привязки [http://www.riverbankcomputing.co.uk/software/pyqt/intro PyQt], обеспечивающие взаимодействия Python с Qt4. Помимо расширений библиотеки QGIS могут быть также использованы для разработки отдельных приложений, что подробно описано в статье «[http://gis-lab.info/qa/qgis-standalone.html Создание приложения на базе набора библиотек QGIS на Python]».

Данная статья описывает процесс создания каркаса расширения на языке Python. Разработанный каркас можно в дальнейшем использовать как основу для других расширений, выполняющих нужные функции.

Создание расширения состоит из нескольких этапов:

* Идея
* Создание каркаса
* Разработка необходимой функциональности.
* Тестирование
* Публикация

Задача этой статьи - иллюстрация процесса создания простого расширения, которое:
* добавит новую кнопку на панель инструментов
* добавит подменю в меню расширений
* выполнит простое действие
* будет доступно на двух языках.

Это расширение можно будет использовать как каркас для других будущих, более функциональных расширений. Далее мы более подробно разберем процесс создания по шагам.

=== Получение исходного кода ===

Код расширения, работающий под QGIS 2.0 можно получить в [https://github.com/nextgis/testplugin репозитории GitHub]:

<pre>git clone git@github.com:nextgis/testplugin.git</pre>

=== Подготовка ===

Для разработки расширения понадобится

* Любой текстовый редактор
* Python, лучше версии 2.5-2.7.х (3.x не подойдет)
* QGIS версии 2.0 и выше, для проверки работоспособности расширения.

Если вы установили QGIS с помощью установщика [http://gis-lab.info/qa/qgis-osgeo4w.html osgeo4w] или [http://nextgis.ru/nextgis-qgis NextGIS QGIS], то у вас уже есть все необходимое для разработки. Ничего дополнительно устанавливать не нужно.

Разработку можно вести прямо в папке, где хранятся расширения или переместить его в нее после разработки, в QGIS эта папка либо <tt>QGIS\python\plugins</tt> либо </tt>C:\Documents and Settings\username\.qgis2\python\plugins\</tt>.

В папке с плагинами необходимо создать новую, назвав ее так, чтобы бы по названию можно было легко определить, что именно делает расширение. Назовем нашу папку <code>testplugin</code>. Это название следует запомнить, так как оно будет фигурировать в различных компонентах кода.

Перед разработкой, нам нужно создать в этой папке несколько новых, пока пустых текстовых файлов:

* <tt>__init__.py</tt> — начальная точка, создаёт экземпляр основного класса, который передается в QGIS
* <tt>testplugin.py</tt> — основной код расширения. Содержит всю информацию о всех действиях расширения.
* <tt>resources.qrc</tt> — xml файл, создаваемый Qt Designer или вручную и содержащий относительные пути к ресурсам расширения, формам, иконкам и т.п. Компилируется в py перед созданием пакета плагина.
* <tt>metadata.txt</tt> — описание модуля, содержит информацию о расширении, версию, имя разработчика

Помимо этих файлов, если расширение использует формы, могут также присутствовать файлы:

* <tt>form.ui</tt> — форма созданная с помощью Qt Designer
* <tt>form.py</tt> — она же, скомпилированная в виде программы на языке Python

Для примера из данной статьи эти файлы не понадобятся.

Итак, пустые файлы созданы и лежат в нужной папке.

Перед разработкой, отредактируем файл metadata.txt. Этот файл содержит информацию о расширении, такую как его название <tt>name</tt>, т.е. то, как он будет показываться в Менеджере модулей, его описание <tt>description</tt>, показывается там же. Нужно также указать минимальную версию QGIS, для которой разработано это расширение (при попытке загрузки в QGIS меньшей версии плагин будет отключен) и другие параметры:

<pre>[general]
name=TestPlugin
description=This plugin is for testing and templating purposes
category=Vector
version=0.0.2
qgisMinimumVersion=2.0

author=NextGIS
email=info@nextgis.org

icon=icons/icon.png

tags=testing,template

homepage=http://gis-lab.info/qa/qgis-dev-python.html
tracker=https://github.com/nextgis/testplugin/issues
repository=https://github.com/nextgis/testplugin

experimental=True
deprecated=False</pre>

=== Разработка ===

Разработка начинается с файла <tt>__init__.py</tt>. Главным фрагментом кода является импорт исполняемой части расширения, содержащейся в файле <tt>plugin.py</tt> (поэтому <tt>from testplugin</tt>) и содержащей всю содержательную часть кода.

<syntaxhighlight lang="python">
def classFactory(iface):
# Import class TestPlugin from file testplugin.py
from testplugin import TestPlugin
return TestPlugin(iface)
</syntaxhighlight>

Название главного импортируемого класса <tt>TestPlugin</tt> должно быть равно названию класса в коде <tt>testplugin.py</tt>, название — регистрозависимое, если вызывается <tt>TestPlugin</tt>, а класс носит название <tt>testplugin</tt>, будет выдано сообщение об ошибке.

Рассмотрим <tt>testplugin.py</tt>.

Как и во всех программах на языке Python, все начинается с импорта необходимых для работы классов, в нашем случае это будут классы PyQt — обертки для Qt на языке Python: PyQt4.QtCore и PyQt4.QtGui, активно используемые QGIS и сами классы QGIS: qgis.core

<syntaxhighlight lang="python">
# -*- coding: utf-8 -*-
from PyQt4.QtCore import *
from PyQt4.QtGui import *
from qgis.core import *
</syntaxhighlight>

Помимо этого нужно также импортировать ресурсы самого расширения, в нашем случае они будут задаваться через <tt>resources.py</tt>, как его создать мы разберем чуть позже.

<syntaxhighlight lang="python">
import resources
</syntaxhighlight>

После импорта идет раздел главного класса, импортируемого в <tt>__init__.py</tt> и содержащего все нужные функции. Необходимо обратить внимание, что название класса должно быть равно названию используемому для его вызова в <tt>__init__.py</tt>. Определение функции начинается с ключевого слова <tt>def</tt>, за которым следует имя функции и ее аргументы.

Объявим наш основной класс и функцию инициализации:

<syntaxhighlight lang="python">
class TestPlugin:

def __init__(self, iface):
"""Initialize class"""
# сохраним ссылку на интерфейс QGIS//save reference to QGIS interface
self.iface = iface
self.qgsVersion = unicode(QGis.QGIS_VERSION_INT)
</syntaxhighlight>

Одна из важнейших функций — создание элементов интерфейса расширения <tt>initGui</tt>. При загрузке расширения к пользовательскому интерфейсу <tt>iface.self</tt> могут добавляться кнопки <tt>addToolBarIcon</tt> или строки в меню «Модули», <tt>addPluginToMenu</tt>. Не забываем документировать функции с помощью тройных кавычек.

<syntaxhighlight lang="python">
import resources
def initGui(self):
"""Инициализируем графический интерфейс пользователя"""
#проверим, не пытаются ли запустить плагин из QGIS версии ниже 2.0//check if the plugin is ran below 2.0
if int(self.qgsVersion) < 10900:
qgisVersion = self.qgsVersion[0] + "." + self.qgsVersion[2] + "." + self.qgsVersion[3]
QMessageBox.warning(self.iface.mainWindow(),
"TestPlugin", "Error",
"TestPlugin", "QGIS %s detected.\n" % (qgisVersion) +
"TestPlugin", "This version of TestPlugin requires at least QGIS version 2.0.\nPlugin will not be enabled.")
return None

# create action that will be run by the plugin//создадим действие, которое будет запускать конфигурацию расширения
self.action = QAction("Test plugin", self.iface.mainWindow())
self.action.setIcon(QIcon(":/icons/icon.png"))
self.action.setWhatsThis("Configuration for test plugin")
self.action.setStatusTip("This is status tip")

# добавим пункт в меню инструментов Vector//add plugin menu to Vector toolbar
self.iface.addPluginToVectorMenu("TestPlugin",self.action)

# добавим кнопку на панель инструментов Vector//add icon to new menu item in Vector toolbar
self.iface.addVectorToolBarIcon(self.action)

# связь действия с функцией run//connect action to the run method
self.action.triggered.connect(self.run)

</syntaxhighlight>

Следующая важная функция расширения описывает то, что происходит при его выгрузке, выключении через Менеджер модулей — <tt>unload(self)</tt>

<syntaxhighlight lang="python">
def unload(self):
"""Действия при выгрузке расширения"""
# удалить меню расширения и иконку//remove menu and icon from the menu
self.iface.removeVectorToolBarIcon(self.action)
self.iface.removePluginVectorMenu("TestPlugin",self.action)
</syntaxhighlight>

И наконец функция выполняющая единственное действие в нашем расширении — <tt>run()</tt>. Функция создаёт строку сообщения и показывает ее в <tt>QMessageBox</tt> в главном окне программы.

<syntaxhighlight lang="python">
def run(self):
"""Действия при запуске расширения"""
# создать и показать сообщение//create a string and show it
infoString = "This is a test"
QMessageBox.information(self.iface.mainWindow(),"About",infoString)
</syntaxhighlight>

=== Интернационализация ===
Интернационализация позволяет сделать ваш плагин доступным на разных языках. [https://ru.wikipedia.org/wiki/Интернационализация Об интернационализации на wiki]
В качестве примера рассмотрим добавление перевода на русский язык. Команды в данном разделе указаны для систем Ubuntu/Debian.
Для начала нам потребуется внести изменения в код файла <tt>testplugin.py</tt>.
Добавим импорт нового модуля <tt>os</tt>, который позволит нам обращаться к файловой системе. Добавьте перед существующими "импортами":

<syntaxhighlight lang="python">
import os
</syntaxhighlight>

Воспользуемся новым модулем. Метод <tt>__init__</tt> теперь будет выглядеть так:

<syntaxhighlight lang="python">
def __init__(self, iface):
"""Initialize class"""
# save reference to QGIS interface
self.iface = iface
self.qgsVersion = unicode(QGis.QGIS_VERSION_INT)
self.plugin_dir = os.path.dirname(__file__)
# initialize locale
locale = QSettings().value('locale/userLocale')[0:2]
locale_path = os.path.join(
self.plugin_dir,
'i18n',
'TestPlugin_{}.qm'.format(locale))
if os.path.exists(locale_path):
self.translator = QTranslator()
self.translator.load(locale_path)

if qVersion() > '4.3.3':
QCoreApplication.installTranslator(self.translator)
</syntaxhighlight>

Что изменилось? Мы добавили атрибут <tt>self.plugin_dir</tt>, хранящий путь к папке с текущим файлом (<tt>testplugin.py</tt>). Получили из настроек QGIS текущую локаль (<tt>locale</tt>), которую пытаемся использовать для обращения к пути файла перевода (<tt>locale_path</tt>). Если такой файл существует, то загружаем из него перевод.
Сразу после метода <tt>__init__</tt> создадим новый:

<syntaxhighlight lang="python">
def tr(self, message):
return QCoreApplication.translate("TestPlugin", message)
</syntaxhighlight>

В Qt4 для перевода строки необходимо использовать метод <tt>QCoreApplication.translate()</tt>. Для каждой строки, требующей перевода, писать такую конструкцию неудобно, поэтому мы и добавили новый метод <tt>tr</tt>. В нашем примере есть только две строки, требующие перевода, и без данного метода можно было и обойтись, но вам он должен упростить жизнь. Далее используем новый метод для того, чтобы "пометить" строки для перевода:

<syntaxhighlight lang="python">
def run(self):
"""Action to run"""
# create a string and show it
infoString = self.tr("This is a test")
QMessageBox.information(self.iface.mainWindow(), self.tr("About"), infoString)
</syntaxhighlight>

С кодом почти закончили, перейдем к заключительным действиям. Создайте папку <tt>i18n</tt> рядом с файлом <tt>testplugin.py</tt>. В папке <tt>i18n</tt> создайте файл <tt><ИмяВашегоПлагина>.pro</tt>. В нашем примере это будет файл <tt>TestPlugin.pro</tt>. Содержимое файла должно быть таким:

<pre>SOURCES += ../testplugin.py
TRANSLATIONS += TestPlugin_ru.ts</pre>

В <tt>SOURCES</tt> перечисляются файлы, в которых требуется искать строки для перевода. Таких источников может быть несколько, и необходимо перечислить их все, добавляя новые строки <tt>SOURCES += ../<ИмяФайла></tt>. В нашем примере ресурс один. В <tt>TRANSLATIONS</tt> перечисляются файлы, содержащие перевод в виде разметки XML, которые необходимо сгенерировать. В имени файла <tt>ru</tt> значит, что это файл перевода на русский. Если хотите добавить другой язык, то после нижнего подчеркивания следует указать соответствующие две буквы. Например, <tt>uk</tt> — украинский.
Далее необходимо установить инструменты разработчика. В частности, нам понадобятся <tt>pylupdate4</tt> и <tt>linguist</tt>. Это делается следующей командой:

<pre>sudo apt-get install pyqt4-dev-tools</pre>

В терминале выполняем команды:

<pre>cd i18n
pylupdate4 TestPlugin.pro
linguist TestPlugin_ru.ts</pre>

Если требуется переводить сразу на несколько языков, то можно открыть несколько файлов, перечислив их:

<pre>linguist TestPlugin_ru.ts TestPlugin_uk.ts</pre>

Или открыть все доступные файлы переводов:

<pre>linguist *.ts</pre>

Всплывающее окно заполните так:

[[Файл:Linguist_settings.jpg]]

Если языков несколько, то настройте каждый отдельно в меню "Правка -> Параметры файла перевода".
В поле "Русский перевод" введите желаемый перевод — "Это тест" и нажмите <tt>Ctrl+Enter</tt>.

[[Файл:Linguist_translation_example.jpg]]

Теперь введите "О Плагине" и нажмите <tt>Ctrl+Enter</tt>. Далее "Файл -> Сохранить" и "Файл -> Скомпилировать". Последняя операция создаст бинарный файл <tt>TestPlugin_ru.qm</tt>, содержащий перевод. Именно этот файл и будет использоваться при отображении плагина на русском языке.
Осталось проверить результат. Для перезагрузки разрабатываемых плагинов удобно использовать плагин с говорящим названием "Plugin Reloader". В QGIS откройте меню "Модули -> Управление модулями". Во вкладке "Параметры" поставьте галочку напротив "Разрешить установку экспериментальных модулей". Во вкладке "Все" введите "Plugin Reloader" и нажмите "Установить модуль". В настройках появившейся иконки плагина "Plugin Reloader" нажмите "Choose plugin to be reloaded" и выберите плагин "testplugin" из списка. Нажмите на иконку плагина "Plugin Reloader", откройте "testplugin" и посмотрите результат.
<gallery>
Файл:Testplugin_en.jpg‎|До перевода
Файл:Testplugin_ru.jpg‎|После перевода
</gallery>

=== Какие функции из API доступны через Python ===

К сожалению, не все функции API QGIS доступны через Python (через C++ доступны все). Чтобы определить, доступны ли конкретные классы и функции, необходимо сначала найти их в документации к API GIS [http://doc.qgis.org/ http://doc.qgis.org]. А затем в консоли Python (Модули\Консоль Python) определить с помощью команды <tt>dir</tt> видны ли эти классы и функции из Python.

Например, определим доступные классы:

<syntaxhighlight lang="python">
import qgis.core
dir(qgis.core)
</syntaxhighlight>

Результат:
<pre>
['DEFAULT_LINE_WIDTH', 'DEFAULT_POINT_SIZE', 'DEFAULT_SEGMENT_EPSILON', 'ELLPS_PREFIX_LEN', 'GEOCRS_ID', 'GEOPROJ4', 'GEOSRID', 'GEOWKT', 'GEO_EPSG_CRS_AUTHID', 'GEO_EPSG_CRS_ID', 'GEO_NONE', 'LAT_PREFIX_LEN', 'MINIMUM_POINT_SIZE', 'NULL', 'PROJECT_SCALES', 'PROJ_PREFIX_LEN', 'QGis', 'QgsAbstractCacheIndex', 'QgsAbstractFeatureIterator', 'QgsAction', 'QgsAddRemoveItemCommand', 'QgsAddRemoveMultiFrameCommand', 'QgsApplication', 'QgsAtlasComposition', 'QgsAttributeAction', 'QgsAttributeEditorContainer', 'QgsAttributeEditorElement', 'QgsAttributeEditorField', 'QgsBilinearRasterResampler', 'QgsBrightnessContrastFilter', 'QgsBrowserModel', 'QgsCRSCache', 'QgsCacheIndexFeatureId', 'QgsCachedFeatureIterator', 'QgsCachedFeatureWriterIterator', 'QgsCategorizedSymbolRendererV2', 'QgsCentroidFillSymbolLayerV2', 'QgsClipToMinMaxEnhancement', 'QgsClipper', 'QgsColorBrewerPalette', 'QgsColorRampShader', 'QgsComposerArrow', 'QgsComposerAttributeTable', 'QgsComposerAttributeTableCompare', 'QgsComposerEffect', 'QgsComposerFrame', 'QgsComposerGroupItem', 'QgsComposerHtml', 'QgsComposerItem', 'QgsComposerItemCommand', 'QgsComposerItemGroup', 'QgsComposerLabel', 'QgsComposerLayerItem', 'QgsComposerLegend', 'QgsComposerLegendItem', 'QgsComposerLegendStyle', 'QgsComposerMap', 'QgsComposerMergeCommand', 'QgsComposerMultiFrame', 'QgsComposerMultiFrameCommand', 'QgsComposerPicture', 'QgsComposerRasterSymbolItem', 'QgsComposerScaleBar', 'QgsComposerShape', 'QgsComposerSymbolV2Item', 'QgsComposerTable', 'QgsComposerTextTable', 'QgsComposition', 'QgsContextHelp', 'QgsContrastEnhancement', 'QgsContrastEnhancementFunction', 'QgsCoordinateReferenceSystem', 'QgsCoordinateTransform', 'QgsCoordinateTransformCache', 'QgsCptCityArchive', 'QgsCptCityBrowserModel', 'QgsCptCityCollectionItem', 'QgsCptCityColorRampItem', 'QgsCptCityColorRampV2', 'QgsCptCityDataItem', 'QgsCptCityDirectoryItem', 'QgsCptCitySelectionItem', 'QgsCredentials', 'QgsCredentialsConsole', 'QgsCsException', 'QgsCubicRasterResampler', 'QgsDataCollectionItem', 'QgsDataDefined', 'QgsDataItem', 'QgsDataProvider', 'QgsDataSourceURI', 'QgsDbFilterProxyModel', 'QgsDiagram', 'QgsDiagramInterpolationSettings', 'QgsDiagramLayerSettings', 'QgsDiagramRendererV2', 'QgsDiagramSettings', 'QgsDirectoryItem', 'QgsDirectoryParamWidget', 'QgsDistanceArea', 'QgsDoubleBoxScaleBarStyle', 'QgsEllipseSymbolLayerV2', 'QgsError', 'QgsErrorItem', 'QgsErrorMessage', 'QgsException', 'QgsExpression', 'QgsFavouritesItem', 'QgsFeature', 'QgsFeatureIterator', 'QgsFeatureRendererV2', 'QgsFeatureRequest', 'QgsFeatureStore', 'QgsField', 'QgsFields', 'QgsFillSymbolLayerV2', 'QgsFillSymbolV2', 'QgsFontMarkerSymbolLayerV2', 'QgsFontUtils', 'QgsGPSConnection', 'QgsGPSConnectionRegistry', 'QgsGPSDetector', 'QgsGPSInformation', 'QgsGeometry', 'QgsGeometryCache', 'QgsGeometryValidator', 'QgsGml', 'QgsGmlFeatureClass', 'QgsGmlSchema', 'QgsGpsdConnection', 'QgsGradientStop', 'QgsGraduatedSymbolRendererV2', 'QgsHistogramDiagram', 'QgsHttpTransaction', 'QgsHueSaturationFilter', 'QgsImageFillSymbolLayer', 'QgsLabel', 'QgsLabelAttributes', 'QgsLabelCandidate', 'QgsLabelComponent', 'QgsLabelPosition', 'QgsLabelSearchTree', 'QgsLabelingEngineInterface', 'QgsLayerItem', 'QgsLegendModel', 'QgsLinePatternFillSymbolLayer', 'QgsLineSymbolLayerV2', 'QgsLineSymbolV2', 'QgsLinearMinMaxEnhancement', 'QgsLinearMinMaxEnhancementWithClip', 'QgsLinearlyInterpolatedDiagramRenderer', 'QgsLogger', 'QgsMapLayer', 'QgsMapLayerRegistry', 'QgsMapRenderer', 'QgsMapToPixel', 'QgsMarkerLineSymbolLayerV2', 'QgsMarkerSymbolLayerV2', 'QgsMarkerSymbolV2', 'QgsMessageLog', 'QgsMessageLogConsole', 'QgsMessageOutput', 'QgsMessageOutputConsole', 'QgsMimeDataUtils', 'QgsMultiBandColorRenderer', 'QgsNMEAConnection', 'QgsNetworkAccessManager', 'QgsNumericScaleBarStyle', 'QgsOWSConnection', 'QgsOfflineEditing', 'QgsOgcUtils', 'QgsPaintEngineHack', 'QgsPalLabeling', 'QgsPalLayerSettings', 'QgsPalettedRasterRenderer', 'QgsPaperItem', 'QgsPieDiagram', 'QgsPluginLayer', 'QgsPluginLayerRegistry', 'QgsPluginLayerType', 'QgsPoint', 'QgsPointDisplacementRenderer', 'QgsPointPatternFillSymbolLayer', 'QgsProject', 'QgsProjectBadLayerDefaultHandler', 'QgsProjectBadLayerHandler', 'QgsProjectFileTransform', 'QgsProjectVersion', 'QgsProperty', 'QgsPropertyKey', 'QgsPropertyValue', 'QgsProviderCountCalcEvent', 'QgsProviderExtentCalcEvent', 'QgsProviderMetadata', 'QgsProviderRegistry', 'QgsPseudoColorShader', 'QgsPythonRunner', 'QgsRaster', 'QgsRasterBandStats', 'QgsRasterBlock', 'QgsRasterChecker', 'QgsRasterDataProvider', 'QgsRasterDrawer', 'QgsRasterFileWriter', 'QgsRasterHistogram', 'QgsRasterIdentifyResult', 'QgsRasterInterface', 'QgsRasterIterator', 'QgsRasterLayer', 'QgsRasterNuller', 'QgsRasterPipe', 'QgsRasterProjector', 'QgsRasterPyramid', 'QgsRasterRange', 'QgsRasterRenderer', 'QgsRasterResampleFilter', 'QgsRasterResampler', 'QgsRasterShader', 'QgsRasterShaderFunction', 'QgsRasterTransparency', 'QgsRasterViewPort', 'QgsRectangle', 'QgsRenderChecker', 'QgsRenderContext', 'QgsRendererCategoryV2', 'QgsRendererRangeV2', 'QgsRendererV2AbstractMetadata', 'QgsRendererV2Metadata', 'QgsRendererV2Registry', 'QgsRuleBasedRendererV2', 'QgsRunProcess', 'QgsSVGFillSymbolLayer', 'QgsSatelliteInfo', 'QgsScaleBarStyle', 'QgsScaleCalculator', 'QgsScaleUtils', 'QgsSimpleFillSymbolLayerV2', 'QgsSimpleLineSymbolLayerV2', 'QgsSimpleMarkerSymbolLayerV2', 'QgsSingleBandColorDataRenderer', 'QgsSingleBandGrayRenderer', 'QgsSingleBandPseudoColorRenderer', 'QgsSingleBoxScaleBarStyle', 'QgsSingleCategoryDiagramRenderer', 'QgsSingleSymbolRendererV2', 'QgsSnapper', 'QgsSnappingResult', 'QgsSpatialIndex', 'QgsStyleV2', 'QgsSvgCache', 'QgsSvgCacheEntry', 'QgsSvgMarkerSymbolLayerV2', 'QgsSymbolLayerV2', 'QgsSymbolLayerV2AbstractMetadata', 'QgsSymbolLayerV2Metadata', 'QgsSymbolLayerV2Registry', 'QgsSymbolLayerV2Utils', 'QgsSymbolV2', 'QgsSymbolV2LevelItem', 'QgsSymbolV2RenderContext', 'QgsSymbologyV2Conversion', 'QgsTextDiagram', 'QgsTicksScaleBarStyle', 'QgsTolerance', 'QgsVectorColorBrewerColorRampV2', 'QgsVectorColorRampV2', 'QgsVectorDataProvider', 'QgsVectorFieldSymbolLayer', 'QgsVectorFileWriter', 'QgsVectorGradientColorRampV2', 'QgsVectorJoinInfo', 'QgsVectorLayer', 'QgsVectorLayerCache', 'QgsVectorLayerEditBuffer', 'QgsVectorLayerEditUtils', 'QgsVectorLayerFeatureIterator', 'QgsVectorLayerImport', 'QgsVectorLayerJoinBuffer', 'QgsVectorRandomColorRampV2', 'QgsZipItem', 'USER_CRS_START_ID', '__doc__', '__file__', '__name__', '__package__']
</pre>

Далее, после выбора нужного класса, например QgsFeature, посмотрим его методы:

<syntaxhighlight lang="python">
dir(qgis.core.QgsFeature)
</syntaxhighlight>

Результат:

<pre>
['__class__', '__delattr__', '__delitem__', '__dict__', '__doc__', '__format__', '__getattribute__', '__getitem__', '__hash__', '__init__', '__iter__', '__module__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__setitem__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'attribute', 'attributes', 'deleteAttribute', 'fieldNameIndex', 'fields', 'geometry', 'geometryAndOwnership', 'id', 'initAttributes', 'isValid', 'setAttribute', 'setAttributes', 'setFeatureId', 'setFields', 'setGeometry', 'setGeometryAndOwnership', 'setValid']
</pre>

=== Ресурсы ===

Для разработки расширения понадобится создать специальный файл, который будет содержать указатели на используемые расширением ресурсы, такие как например иконки. Пример такого файла:

<syntaxhighlight lang="xml">
<RCC>
<qresource prefix="" >
<file>icons/icon.png</file>
</qresource>
</RCC>
</syntaxhighlight>

Рекомендуется использовать уникальный qresource prefix, который не будет конфликтовать с другими расширениями.

После создания этого файла, необходимо его скомпилировать с помощью <tt>pyrcc4</tt> в формат, который можно импортировать с помощью Python:

<pre>
pyrcc4 -o resources.py resources.qrc
</pre>

И как уже упоминалось выше, импортировать получившиеся ресурсы в основном коде <tt>testplugin.py</tt>.

=== Заключение ===

Разработка каркаса нашего расширения завершена. Если она велась в папке расширений, то после запуска QGIS расширение должно автоматически появиться в списке расширений и можно начать его тестирование, отладку и, конечно, наполнение нужными полезными функциями.

Помните, что лучшим пособием по разработке для QGIS являются расширения созданные другими авторами.

=== Ссылки по теме ===

* [http://gis-lab.info/qa/qgis-standalone.html Создание приложения на базе набора библиотек QGIS на Python]
* [http://gis-lab.info/qa/qgis-repo.html Организация и работа с репозиториями расширений QGIS]
* [http://gis-lab.info/qa/qgis-install-plugin.html Установка модулей расширения в QGIS]
* [http://gis-lab.info/docs/qgis Документация по QGIS]

Разработка простого расширения для QGIS на Python

2017-03-13T23:10:57Z

Elf: Добавлен раздел об интернационализации. На гитхабе сделан pull request c изменениями кода.

{{Статья|Опубликована|qgis-dev-python}}
{{Аннотация|Описание процесса создания элементарного расширения для QGIS.}}

QGIS — свободная пользовательская ГИС, обладающая развитым API и продвинутой системой расширений (модулей). Модули создаются для расширения функциональности программы. QGIS написана на объектно-ориентированном языке высокого уровня C++. Так же в QGIS встроены привязки (bindings), которые реализуют практически весь функционал QGIS на языке Python. Графический интерфейс пользователя QGIS базируется на библиотеках Qt4. Разработка для QGIS может вестись на двух языках, Python и C++. Для разработки на языке Python необходимы привязки [http://www.riverbankcomputing.co.uk/software/pyqt/intro PyQt], обеспечивающие взаимодействия Python с Qt4. Помимо расширений библиотеки QGIS могут быть также использованы для разработки отдельных приложений, что подробно описано в статье «[http://gis-lab.info/qa/qgis-standalone.html Создание приложения на базе набора библиотек QGIS на Python]».

Данная статья описывает процесс создания каркаса расширения на языке Python. Разработанный каркас можно в дальнейшем использовать как основу для других расширений, выполняющих нужные функции.

Создание расширения состоит из нескольких этапов:

* Идея
* Создание каркаса
* Разработка необходимой функциональности.
* Тестирование
* Публикация

Задача этой статьи - иллюстрация процесса создания простого расширения, которое:
* добавит новую кнопку на панель инструментов
* добавит подменю в меню расширений
* выполнит простое действие
* будет доступно на двух языках.

Это расширение можно будет использовать как каркас для других будущих, более функциональных расширений. Далее мы более подробно разберем процесс создания по шагам.

=== Получение исходного кода ===

Код расширения, работающий под QGIS 2.0 можно получить в [https://github.com/nextgis/testplugin репозитории GitHub]:

<pre>git clone git@github.com:nextgis/testplugin.git</pre>

=== Подготовка ===

Для разработки расширения понадобится

* Любой текстовый редактор
* Python, лучше версии 2.5-2.7.х (3.x не подойдет)
* QGIS версии 2.0 и выше, для проверки работоспособности расширения.

Если вы установили QGIS с помощью установщика [http://gis-lab.info/qa/qgis-osgeo4w.html osgeo4w] или [http://nextgis.ru/nextgis-qgis NextGIS QGIS], то у вас уже есть все необходимое для разработки. Ничего дополнительно устанавливать не нужно.

Разработку можно вести прямо в папке, где хранятся расширения или переместить его в нее после разработки, в QGIS эта папка либо <tt>QGIS\python\plugins</tt> либо </tt>C:\Documents and Settings\username\.qgis2\python\plugins\</tt>.

В папке с плагинами необходимо создать новую, назвав ее так, чтобы бы по названию можно было легко определить, что именно делает расширение. Назовем нашу папку <code>testplugin</code>. Это название следует запомнить, так как оно будет фигурировать в различных компонентах кода.

Перед разработкой, нам нужно создать в этой папке несколько новых, пока пустых текстовых файлов:

* <tt>__init__.py</tt> — начальная точка, создаёт экземпляр основного класса, который передается в QGIS
* <tt>testplugin.py</tt> — основной код расширения. Содержит всю информацию о всех действиях расширения.
* <tt>resources.qrc</tt> — xml файл, создаваемый Qt Designer или вручную и содержащий относительные пути к ресурсам расширения, формам, иконкам и т.п. Компилируется в py перед созданием пакета плагина.
* <tt>metadata.txt</tt> — описание модуля, содержит информацию о расширении, версию, имя разработчика

Помимо этих файлов, если расширение использует формы, могут также присутствовать файлы:

* <tt>form.ui</tt> — форма созданная с помощью Qt Designer
* <tt>form.py</tt> — она же, скомпилированная в виде программы на языке Python

Для примера из данной статьи эти файлы не понадобятся.

Итак, пустые файлы созданы и лежат в нужной папке.

Перед разработкой, отредактируем файл metadata.txt. Этот файл содержит информацию о расширении, такую как его название <tt>name</tt>, т.е. то, как он будет показываться в Менеджере модулей, его описание <tt>description</tt>, показывается там же. Нужно также указать минимальную версию QGIS, для которой разработано это расширение (при попытке загрузки в QGIS меньшей версии плагин будет отключен) и другие параметры:

<pre>[general]
name=TestPlugin
description=This plugin is for testing and templating purposes
category=Vector
version=0.0.2
qgisMinimumVersion=2.0

author=NextGIS
email=info@nextgis.org

icon=icons/icon.png

tags=testing,template

homepage=http://gis-lab.info/qa/qgis-dev-python.html
tracker=https://github.com/nextgis/testplugin/issues
repository=https://github.com/nextgis/testplugin

experimental=True
deprecated=False</pre>

=== Разработка ===

Разработка начинается с файла <tt>__init__.py</tt>. Главным фрагментом кода является импорт исполняемой части расширения, содержащейся в файле <tt>plugin.py</tt> (поэтому <tt>from testplugin</tt>) и содержащей всю содержательную часть кода.

<syntaxhighlight lang="python">
def classFactory(iface):
# Import class TestPlugin from file testplugin.py
from testplugin import TestPlugin
return TestPlugin(iface)
</syntaxhighlight>

Название главного импортируемого класса <tt>TestPlugin</tt> должно быть равно названию класса в коде <tt>testplugin.py</tt>, название — регистрозависимое, если вызывается <tt>TestPlugin</tt>, а класс носит название <tt>testplugin</tt>, будет выдано сообщение об ошибке.

Рассмотрим <tt>testplugin.py</tt>.

Как и во всех программах на языке Python, все начинается с импорта необходимых для работы классов, в нашем случае это будут классы PyQt — обертки для Qt на языке Python: PyQt4.QtCore и PyQt4.QtGui, активно используемые QGIS и сами классы QGIS: qgis.core

<syntaxhighlight lang="python">
# -*- coding: utf-8 -*-
from PyQt4.QtCore import *
from PyQt4.QtGui import *
from qgis.core import *
</syntaxhighlight>

Помимо этого нужно также импортировать ресурсы самого расширения, в нашем случае они будут задаваться через <tt>resources.py</tt>, как его создать мы разберем чуть позже.

<syntaxhighlight lang="python">
import resources
</syntaxhighlight>

После импорта идет раздел главного класса, импортируемого в <tt>__init__.py</tt> и содержащего все нужные функции. Необходимо обратить внимание, что название класса должно быть равно названию используемому для его вызова в <tt>__init__.py</tt>. Определение функции начинается с ключевого слова <tt>def</tt>, за которым следует имя функции и ее аргументы.

Объявим наш основной класс и функцию инициализации:

<syntaxhighlight lang="python">
class TestPlugin:

def __init__(self, iface):
"""Initialize class"""
# сохраним ссылку на интерфейс QGIS//save reference to QGIS interface
self.iface = iface
self.qgsVersion = unicode(QGis.QGIS_VERSION_INT)
</syntaxhighlight>

Одна из важнейших функций — создание элементов интерфейса расширения <tt>initGui</tt>. При загрузке расширения к пользовательскому интерфейсу <tt>iface.self</tt> могут добавляться кнопки <tt>addToolBarIcon</tt> или строки в меню «Модули», <tt>addPluginToMenu</tt>. Не забываем документировать функции с помощью тройных кавычек.

<syntaxhighlight lang="python">
import resources
def initGui(self):
"""Инициализируем графический интерфейс пользователя"""
#проверим, не пытаются ли запустить плагин из QGIS версии ниже 2.0//check if the plugin is ran below 2.0
if int(self.qgsVersion) < 10900:
qgisVersion = self.qgsVersion[0] + "." + self.qgsVersion[2] + "." + self.qgsVersion[3]
QMessageBox.warning(self.iface.mainWindow(),
"TestPlugin", "Error",
"TestPlugin", "QGIS %s detected.\n" % (qgisVersion) +
"TestPlugin", "This version of TestPlugin requires at least QGIS version 2.0.\nPlugin will not be enabled.")
return None

# create action that will be run by the plugin//создадим действие, которое будет запускать конфигурацию расширения
self.action = QAction("Test plugin", self.iface.mainWindow())
self.action.setIcon(QIcon(":/icons/icon.png"))
self.action.setWhatsThis("Configuration for test plugin")
self.action.setStatusTip("This is status tip")

# добавим пункт в меню инструментов Vector//add plugin menu to Vector toolbar
self.iface.addPluginToVectorMenu("TestPlugin",self.action)

# добавим кнопку на панель инструментов Vector//add icon to new menu item in Vector toolbar
self.iface.addVectorToolBarIcon(self.action)

# связь действия с функцией run//connect action to the run method
self.action.triggered.connect(self.run)

</syntaxhighlight>

Следующая важная функция расширения описывает то, что происходит при его выгрузке, выключении через Менеджер модулей — <tt>unload(self)</tt>

<syntaxhighlight lang="python">
def unload(self):
"""Действия при выгрузке расширения"""
# удалить меню расширения и иконку//remove menu and icon from the menu
self.iface.removeVectorToolBarIcon(self.action)
self.iface.removePluginVectorMenu("TestPlugin",self.action)
</syntaxhighlight>

И наконец функция выполняющая единственное действие в нашем расширении — <tt>run()</tt>. Функция создаёт строку сообщения и показывает ее в <tt>QMessageBox</tt> в главном окне программы.

<syntaxhighlight lang="python">
def run(self):
"""Действия при запуске расширения"""
# создать и показать сообщение//create a string and show it
infoString = "This is a test"
QMessageBox.information(self.iface.mainWindow(),"About",infoString)
</syntaxhighlight>

=== Интернационализация ===
Интернационализация позволяет сделать ваш плагин доступным на разных языках. [https://ru.wikipedia.org/wiki/Интернационализация Об интернационализации на wiki]
В качестве примера рассмотрим добавление перевода на русский язык.
Для начала нам потребуется внести изменения в код файла <tt>testplugin.py</tt>.
Добавим импорт нового модуля <tt>os</tt>, который позволит нам обращаться к файловой системе. Добавьте перед существующими "импортами":

<syntaxhighlight lang="python">
import os
</syntaxhighlight>

Воспользуемся новым модулем. Метод <tt>__init__</tt> теперь будет выглядеть так:

<syntaxhighlight lang="python">
def __init__(self, iface):
"""Initialize class"""
# save reference to QGIS interface
self.iface = iface
self.qgsVersion = unicode(QGis.QGIS_VERSION_INT)
self.plugin_dir = os.path.dirname(__file__)
# initialize locale
locale = QSettings().value('locale/userLocale')[0:2]
locale_path = os.path.join(
self.plugin_dir,
'i18n',
'TestPlugin_{}.qm'.format(locale))
if os.path.exists(locale_path):
self.translator = QTranslator()
self.translator.load(locale_path)

if qVersion() > '4.3.3':
QCoreApplication.installTranslator(self.translator)
</syntaxhighlight>

Что изменилось? Мы добавили атрибут <tt>self.plugin_dir</tt>, хранящий путь к папке с текущим файлом (<tt>testplugin.py</tt>). Получили из настроек QGIS текущую локаль (<tt>locale</tt>), которую пытаемся использовать для обращения к пути файла перевода (<tt>locale_path</tt>). Если такой файл существует, то загружаем из него перевод.
Сразу после метода <tt>__init__</tt> создадим новый:

<syntaxhighlight lang="python">
def tr(self, message):
return QCoreApplication.translate("TestPlugin", message)
</syntaxhighlight>

В Qt4 для перевода строки необходимо использовать метод <tt>QCoreApplication.translate()</tt>. Для каждой строки, требующей перевода, писать такую конструкцию неудобно, поэтому мы и добавили новый метод <tt>tr</tt>. В нашем примере есть только две строки, требующие перевода, и без данного метода можно было и обойтись, но вам он должен упростить жизнь. Далее используем новый метод для того, чтобы "пометить" строки для перевода:

<syntaxhighlight lang="python">
def run(self):
"""Action to run"""
# create a string and show it
infoString = self.tr("This is a test")
QMessageBox.information(self.iface.mainWindow(), self.tr("About"), infoString)
</syntaxhighlight>

С кодом почти закончили, перейдем к заключительным действиям. Создайте папку <tt>i18n</tt> рядом с файлом <tt>testplugin.py</tt>. В папке <tt>i18n</tt> создайте файл <tt><ИмяВашегоПлагина>.pro</tt>. В нашем примере это будет файл <tt>TestPlugin.pro</tt>. Содержимое файла должно быть таким:

<pre>SOURCES += ../testplugin.py
TRANSLATIONS += TestPlugin_ru.ts</pre>

В <tt>SOURCES</tt> перечисляются файлы, в которых требуется искать строки для перевода. Таких источников может быть несколько, и необходимо перечислить их все, добавляя новые строки <tt>SOURCES += ../<ИмяФайла></tt>. В нашем примере ресурс один. В <tt>TRANSLATIONS</tt> перечисляются файлы, содержащие перевод в виде разметки XML, которые необходимо сгенерировать. В имени файла <tt>ru</tt> значит, что это файл перевода на русский. Если хотите добавить другой язык, то после нижнего подчеркивания следует указать соответствующие две буквы. Например, <tt>uk</tt> — украинский.
Далее необходимо установить инструменты разработчика. В частности, нам понадобятся <tt>pylupdate4</tt> и <tt>linguist</tt>. Это делается следующей командой:

<pre>sudo apt-get install pyqt4-dev-tools</pre>

Данная команда подходит для систем Ubuntu/Debian. Если у вас Windows и команды <tt>pylupdate4</tt> и <tt>linguist</tt> недоступны, то установите [http://pyqt.sourceforge.net/Docs/PyQt4/installation.html PyQt4]. В терминале выполняем команды:

<pre>cd i18n
pylupdate4 TestPlugin.pro
linguist TestPlugin_ru.ts</pre>

Если требуется переводить сразу на несколько языков, то можно открыть несколько файлов, перечислив их:

<pre>linguist TestPlugin_ru.ts TestPlugin_uk.ts</pre>

Или открыть все доступные файлы переводов:

<pre>linguist *.ts</pre>

Всплывающее окно заполните так:

[[Файл:Linguist_settings.jpg]]

Если языков несколько, то настройте каждый отдельно в меню "Правка -> Параметры файла перевода".
В поле "Русский перевод" введите желаемый перевод — "Это тест" и нажмите <tt>Ctrl+Enter</tt>.

[[Файл:Linguist_translation_example.jpg]]

Теперь введите "О Плагине" и нажмите <tt>Ctrl+Enter</tt>. Далее "Файл -> Сохранить" и "Файл -> Скомпилировать". Последняя операция создаст бинарный файл <tt>TestPlugin_ru.qm</tt>, содержащий перевод. Именно этот файл и будет использоваться при отображении плагина на русском языке.
Осталось проверить результат. Для перезагрузки разрабатываемых плагинов удобно использовать плагин с говорящим названием "Plugin Reloader". В QGIS откройте меню "Модули -> Управление модулями". Во вкладке "Параметры" поставьте галочку напротив "Разрешить установку экспериментальных модулей". Во вкладке "Все" введите "Plugin Reloader" и нажмите "Установить модуль". В настройках появившейся иконки плагина "Plugin Reloader" нажмите "Choose plugin to be reloaded" и выберите плагин "testplugin" из списка. Нажмите на иконку плагина "Plugin Reloader", откройте "testplugin" и посмотрите результат.
<gallery>
Файл:Testplugin_en.jpg‎|До перевода
Файл:Testplugin_ru.jpg‎|После перевода
</gallery>

=== Какие функции из API доступны через Python ===

К сожалению, не все функции API QGIS доступны через Python (через C++ доступны все). Чтобы определить, доступны ли конкретные классы и функции, необходимо сначала найти их в документации к API GIS [http://doc.qgis.org/ http://doc.qgis.org]. А затем в консоли Python (Модули\Консоль Python) определить с помощью команды <tt>dir</tt> видны ли эти классы и функции из Python.

Например, определим доступные классы:

<syntaxhighlight lang="python">
import qgis.core
dir(qgis.core)
</syntaxhighlight>

Результат:
<pre>
['DEFAULT_LINE_WIDTH', 'DEFAULT_POINT_SIZE', 'DEFAULT_SEGMENT_EPSILON', 'ELLPS_PREFIX_LEN', 'GEOCRS_ID', 'GEOPROJ4', 'GEOSRID', 'GEOWKT', 'GEO_EPSG_CRS_AUTHID', 'GEO_EPSG_CRS_ID', 'GEO_NONE', 'LAT_PREFIX_LEN', 'MINIMUM_POINT_SIZE', 'NULL', 'PROJECT_SCALES', 'PROJ_PREFIX_LEN', 'QGis', 'QgsAbstractCacheIndex', 'QgsAbstractFeatureIterator', 'QgsAction', 'QgsAddRemoveItemCommand', 'QgsAddRemoveMultiFrameCommand', 'QgsApplication', 'QgsAtlasComposition', 'QgsAttributeAction', 'QgsAttributeEditorContainer', 'QgsAttributeEditorElement', 'QgsAttributeEditorField', 'QgsBilinearRasterResampler', 'QgsBrightnessContrastFilter', 'QgsBrowserModel', 'QgsCRSCache', 'QgsCacheIndexFeatureId', 'QgsCachedFeatureIterator', 'QgsCachedFeatureWriterIterator', 'QgsCategorizedSymbolRendererV2', 'QgsCentroidFillSymbolLayerV2', 'QgsClipToMinMaxEnhancement', 'QgsClipper', 'QgsColorBrewerPalette', 'QgsColorRampShader', 'QgsComposerArrow', 'QgsComposerAttributeTable', 'QgsComposerAttributeTableCompare', 'QgsComposerEffect', 'QgsComposerFrame', 'QgsComposerGroupItem', 'QgsComposerHtml', 'QgsComposerItem', 'QgsComposerItemCommand', 'QgsComposerItemGroup', 'QgsComposerLabel', 'QgsComposerLayerItem', 'QgsComposerLegend', 'QgsComposerLegendItem', 'QgsComposerLegendStyle', 'QgsComposerMap', 'QgsComposerMergeCommand', 'QgsComposerMultiFrame', 'QgsComposerMultiFrameCommand', 'QgsComposerPicture', 'QgsComposerRasterSymbolItem', 'QgsComposerScaleBar', 'QgsComposerShape', 'QgsComposerSymbolV2Item', 'QgsComposerTable', 'QgsComposerTextTable', 'QgsComposition', 'QgsContextHelp', 'QgsContrastEnhancement', 'QgsContrastEnhancementFunction', 'QgsCoordinateReferenceSystem', 'QgsCoordinateTransform', 'QgsCoordinateTransformCache', 'QgsCptCityArchive', 'QgsCptCityBrowserModel', 'QgsCptCityCollectionItem', 'QgsCptCityColorRampItem', 'QgsCptCityColorRampV2', 'QgsCptCityDataItem', 'QgsCptCityDirectoryItem', 'QgsCptCitySelectionItem', 'QgsCredentials', 'QgsCredentialsConsole', 'QgsCsException', 'QgsCubicRasterResampler', 'QgsDataCollectionItem', 'QgsDataDefined', 'QgsDataItem', 'QgsDataProvider', 'QgsDataSourceURI', 'QgsDbFilterProxyModel', 'QgsDiagram', 'QgsDiagramInterpolationSettings', 'QgsDiagramLayerSettings', 'QgsDiagramRendererV2', 'QgsDiagramSettings', 'QgsDirectoryItem', 'QgsDirectoryParamWidget', 'QgsDistanceArea', 'QgsDoubleBoxScaleBarStyle', 'QgsEllipseSymbolLayerV2', 'QgsError', 'QgsErrorItem', 'QgsErrorMessage', 'QgsException', 'QgsExpression', 'QgsFavouritesItem', 'QgsFeature', 'QgsFeatureIterator', 'QgsFeatureRendererV2', 'QgsFeatureRequest', 'QgsFeatureStore', 'QgsField', 'QgsFields', 'QgsFillSymbolLayerV2', 'QgsFillSymbolV2', 'QgsFontMarkerSymbolLayerV2', 'QgsFontUtils', 'QgsGPSConnection', 'QgsGPSConnectionRegistry', 'QgsGPSDetector', 'QgsGPSInformation', 'QgsGeometry', 'QgsGeometryCache', 'QgsGeometryValidator', 'QgsGml', 'QgsGmlFeatureClass', 'QgsGmlSchema', 'QgsGpsdConnection', 'QgsGradientStop', 'QgsGraduatedSymbolRendererV2', 'QgsHistogramDiagram', 'QgsHttpTransaction', 'QgsHueSaturationFilter', 'QgsImageFillSymbolLayer', 'QgsLabel', 'QgsLabelAttributes', 'QgsLabelCandidate', 'QgsLabelComponent', 'QgsLabelPosition', 'QgsLabelSearchTree', 'QgsLabelingEngineInterface', 'QgsLayerItem', 'QgsLegendModel', 'QgsLinePatternFillSymbolLayer', 'QgsLineSymbolLayerV2', 'QgsLineSymbolV2', 'QgsLinearMinMaxEnhancement', 'QgsLinearMinMaxEnhancementWithClip', 'QgsLinearlyInterpolatedDiagramRenderer', 'QgsLogger', 'QgsMapLayer', 'QgsMapLayerRegistry', 'QgsMapRenderer', 'QgsMapToPixel', 'QgsMarkerLineSymbolLayerV2', 'QgsMarkerSymbolLayerV2', 'QgsMarkerSymbolV2', 'QgsMessageLog', 'QgsMessageLogConsole', 'QgsMessageOutput', 'QgsMessageOutputConsole', 'QgsMimeDataUtils', 'QgsMultiBandColorRenderer', 'QgsNMEAConnection', 'QgsNetworkAccessManager', 'QgsNumericScaleBarStyle', 'QgsOWSConnection', 'QgsOfflineEditing', 'QgsOgcUtils', 'QgsPaintEngineHack', 'QgsPalLabeling', 'QgsPalLayerSettings', 'QgsPalettedRasterRenderer', 'QgsPaperItem', 'QgsPieDiagram', 'QgsPluginLayer', 'QgsPluginLayerRegistry', 'QgsPluginLayerType', 'QgsPoint', 'QgsPointDisplacementRenderer', 'QgsPointPatternFillSymbolLayer', 'QgsProject', 'QgsProjectBadLayerDefaultHandler', 'QgsProjectBadLayerHandler', 'QgsProjectFileTransform', 'QgsProjectVersion', 'QgsProperty', 'QgsPropertyKey', 'QgsPropertyValue', 'QgsProviderCountCalcEvent', 'QgsProviderExtentCalcEvent', 'QgsProviderMetadata', 'QgsProviderRegistry', 'QgsPseudoColorShader', 'QgsPythonRunner', 'QgsRaster', 'QgsRasterBandStats', 'QgsRasterBlock', 'QgsRasterChecker', 'QgsRasterDataProvider', 'QgsRasterDrawer', 'QgsRasterFileWriter', 'QgsRasterHistogram', 'QgsRasterIdentifyResult', 'QgsRasterInterface', 'QgsRasterIterator', 'QgsRasterLayer', 'QgsRasterNuller', 'QgsRasterPipe', 'QgsRasterProjector', 'QgsRasterPyramid', 'QgsRasterRange', 'QgsRasterRenderer', 'QgsRasterResampleFilter', 'QgsRasterResampler', 'QgsRasterShader', 'QgsRasterShaderFunction', 'QgsRasterTransparency', 'QgsRasterViewPort', 'QgsRectangle', 'QgsRenderChecker', 'QgsRenderContext', 'QgsRendererCategoryV2', 'QgsRendererRangeV2', 'QgsRendererV2AbstractMetadata', 'QgsRendererV2Metadata', 'QgsRendererV2Registry', 'QgsRuleBasedRendererV2', 'QgsRunProcess', 'QgsSVGFillSymbolLayer', 'QgsSatelliteInfo', 'QgsScaleBarStyle', 'QgsScaleCalculator', 'QgsScaleUtils', 'QgsSimpleFillSymbolLayerV2', 'QgsSimpleLineSymbolLayerV2', 'QgsSimpleMarkerSymbolLayerV2', 'QgsSingleBandColorDataRenderer', 'QgsSingleBandGrayRenderer', 'QgsSingleBandPseudoColorRenderer', 'QgsSingleBoxScaleBarStyle', 'QgsSingleCategoryDiagramRenderer', 'QgsSingleSymbolRendererV2', 'QgsSnapper', 'QgsSnappingResult', 'QgsSpatialIndex', 'QgsStyleV2', 'QgsSvgCache', 'QgsSvgCacheEntry', 'QgsSvgMarkerSymbolLayerV2', 'QgsSymbolLayerV2', 'QgsSymbolLayerV2AbstractMetadata', 'QgsSymbolLayerV2Metadata', 'QgsSymbolLayerV2Registry', 'QgsSymbolLayerV2Utils', 'QgsSymbolV2', 'QgsSymbolV2LevelItem', 'QgsSymbolV2RenderContext', 'QgsSymbologyV2Conversion', 'QgsTextDiagram', 'QgsTicksScaleBarStyle', 'QgsTolerance', 'QgsVectorColorBrewerColorRampV2', 'QgsVectorColorRampV2', 'QgsVectorDataProvider', 'QgsVectorFieldSymbolLayer', 'QgsVectorFileWriter', 'QgsVectorGradientColorRampV2', 'QgsVectorJoinInfo', 'QgsVectorLayer', 'QgsVectorLayerCache', 'QgsVectorLayerEditBuffer', 'QgsVectorLayerEditUtils', 'QgsVectorLayerFeatureIterator', 'QgsVectorLayerImport', 'QgsVectorLayerJoinBuffer', 'QgsVectorRandomColorRampV2', 'QgsZipItem', 'USER_CRS_START_ID', '__doc__', '__file__', '__name__', '__package__']
</pre>

Далее, после выбора нужного класса, например QgsFeature, посмотрим его методы:

<syntaxhighlight lang="python">
dir(qgis.core.QgsFeature)
</syntaxhighlight>

Результат:

<pre>
['__class__', '__delattr__', '__delitem__', '__dict__', '__doc__', '__format__', '__getattribute__', '__getitem__', '__hash__', '__init__', '__iter__', '__module__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__setitem__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'attribute', 'attributes', 'deleteAttribute', 'fieldNameIndex', 'fields', 'geometry', 'geometryAndOwnership', 'id', 'initAttributes', 'isValid', 'setAttribute', 'setAttributes', 'setFeatureId', 'setFields', 'setGeometry', 'setGeometryAndOwnership', 'setValid']
</pre>

=== Ресурсы ===

Для разработки расширения понадобится создать специальный файл, который будет содержать указатели на используемые расширением ресурсы, такие как например иконки. Пример такого файла:

<syntaxhighlight lang="xml">
<RCC>
<qresource prefix="" >
<file>icons/icon.png</file>
</qresource>
</RCC>
</syntaxhighlight>

Рекомендуется использовать уникальный qresource prefix, который не будет конфликтовать с другими расширениями.

После создания этого файла, необходимо его скомпилировать с помощью <tt>pyrcc4</tt> в формат, который можно импортировать с помощью Python:

<pre>
pyrcc4 -o resources.py resources.qrc
</pre>

И как уже упоминалось выше, импортировать получившиеся ресурсы в основном коде <tt>testplugin.py</tt>.

=== Заключение ===

Разработка каркаса нашего расширения завершена. Если она велась в папке расширений, то после запуска QGIS расширение должно автоматически появиться в списке расширений и можно начать его тестирование, отладку и, конечно, наполнение нужными полезными функциями.

Помните, что лучшим пособием по разработке для QGIS являются расширения созданные другими авторами.

=== Ссылки по теме ===

* [http://gis-lab.info/qa/qgis-standalone.html Создание приложения на базе набора библиотек QGIS на Python]
* [http://gis-lab.info/qa/qgis-repo.html Организация и работа с репозиториями расширений QGIS]
* [http://gis-lab.info/qa/qgis-install-plugin.html Установка модулей расширения в QGIS]
* [http://gis-lab.info/docs/qgis Документация по QGIS]

Файл:Testplugin ru.jpg

2017-03-13T22:57:26Z

Elf: Interface of testplugin in Russian.

Interface of testplugin in Russian.

Файл:Testplugin en.jpg

2017-03-13T22:56:38Z

Elf: загружена новая версия «Файл:Testplugin en.jpg»

Interface of testplugin in English.

Файл:Testplugin en.jpg

2017-03-13T22:55:58Z

Elf: Отмена правки 25243, сделанной участником Elf (обс.)

Interface of testplugin in English.

Файл:Testplugin en.jpg

2017-03-13T22:55:07Z

Elf:

Interface of testplugin in Russian.

Файл:Testplugin en.jpg

2017-03-13T22:52:17Z

Elf: Interface of testplugin in English.

Interface of testplugin in English.

Файл:Linguist translation example.jpg

2017-03-13T22:36:58Z

Elf: Linguist example of translation

Linguist example of translation

Файл:Linguist settings.jpg

2017-03-13T22:30:08Z

Elf: Screenshot of Linguist settings pop-up window.

Screenshot of Linguist settings pop-up window.