在QGIS下开发python插件

2023-11-14

本文来自CSDN博客,转载请标明出处http://blog.csdn.net/xiluoduyu/

出于研究sextante代码的需要,抽空查了下QGIS下python插件的开发流程。具体的操作参考英文的PyQGIS 的开发帮助文档。

QGIS是用C++开发的,传统QGIS下开发插件也多是用C++写的,然而用Python可不可以呢?当然可以!并且,由于Python语言的动态编程特性,用Python进行QGIS插件开发相比C++而言要快捷方便很多,也易于理解和发布。

实质上,在QGIS的插件管理器中,Python插件和C++插件是一视同仁的。Python插件的存放路径有两个,在UNIX或者Mac操作系统下为~/.qgis/python/plugins和(qgis_prefix)/share/qgis/python/plugin;在windows下为~/.qgis/python/plugin和(qgis_prefix)/python/plugin。在windows下插件存放根目录一般为C:\Documents and
Settings\(user)。在插件目录(根目录+上述路径)下的任何文件夹将会被视为QGIS的Python插件包,但是该目录下并非所有文件夹都能够被QGIS识别和安装,只有符合一定要求才可以,也即具备必要的文件组成。

开发Python插件思路大体分为4步:

  1. 点子。想清楚自己到底要干嘛。为什么要这样做?有没有必要这样做?想好了再动手吧,别弄了半天才发现根本就没那必要或者早就有人把你的需求给实现和共享出来了,那你就悲剧了,劳神费力,伤财伤精啊。
  2. 创建必要的文件。首先,创建初始化文件__init__.py文件,用来设置插件加载前的某些属性值。其次,创建插件主体文件plugin.py,你所有的插件操作将会在此文件中完成。最后,用QT-Designer设计插件界面,生成界面文件form.ui,伴随ui文件一般会有一份资源文件生成,即resources.qrc。
  3. 在plugin.py中填写必要的代码。下面会详细阐述。
  4. 测试。重启QGIS看能不能将插件加载进来并顺利运行。
  5. 发布你的插件。这一步其实看你心情咯,爱发布就发布,但若要发布千万得记住:别写的太烂!毕竟有可能比人会用到你的插件。程序员要则:不接受坑爹,但也别坑人。

插件编写

自从QGIS发布官方的Python插件开发文档后,到目前已经有很多很优秀的插件被共享出来了,例如sextante。具体请浏览Plugin Repositories wiki page,可以下载下来研究下源码哦,适合的的话修改一下说不定就成了你的插件了呢偷笑(太坏了,起码要跟原作者说一声嘛)。要是你只是想试下手又没啥好的想法,到Python Plugin Ideas wiki page去吧,那里有。

创建必要的文件

           说这么多话终于到了编码的节奏了呢。先看个例子吧,了解下它的结构组成:

            PYTHON_PLUGINS_PATH/testplug/

__init__.py

plugin.py

metadata.txt

resources.qrc

resources.py

form.ui

form.py

其中:

  • __init__.py,是插件调用的起点,一般例如版本号、插件名、插件主类等信息会在这里面定义;
  • plugin.py,插件主体啦,所有的插件操作都必须在这里完成,也是写代码最多的部分;
  • resources.qrc,QT-Designer创建的XML文档,包含了界面资源的相对路径;
  • resources.py,利用pyrcc4.bat转换resources.qrc所得;
  • form.ui,QT-Designer创建的界面文件;
  • form.py,利用pyucc4.bat转换form.ui所得;
  • meradata.txt,QGIS>=1.8.0版本要求提供,是插件元数据,描述了插件的基本信息,如版本号,插件名和其他一些插件网址,框架信息等。在__init__.py文件中会用到,用来获取上述插件相关信息。然而从QGIS2.0开始,所有的插件元数据信息只能在metadata.txt中设置了,在__init__.py中的设置将被视为无效。

        若嫌手动创建这些插件框架文件太繁琐,这里有两种方案你可以选择:1)http://hub.qgis.org/projects/plugin-builder2)http://www.dimitrisk.gr/qgis/creator/。此外,你也可以下载一款叫Plugin Builder的离线插件来帮助你创建插件模板。在开始编写自己的插件之前,建议最好还是找个典型的插件案例来研究一下吧,例如sextante啦。

编写代码

__init__.py

QGIS 插件管理器在加载一款插件前需要获取一些插件的基本信息,例如插件名(插件标志,类似ID子类的)、插件描述信息(显示)等。__init__.py就是要干这活的,看下面代码就知道了:

def name():
  return "My testing plugin"
def description():
  return "This plugin has no real use."
def version():
  return "Version 0.1"
def qgisMinimumVersion():
  return "1.0"
def authorName():
  return "Developer"
def classFactory(iface):
  # load TestPlugin class from file testplugin.py
  from testplugin import TestPlugin
  return TestPlugin(iface)

        在旧版本中QGIS外部插件只能显示在“插件/Plugins”菜单栏下,但在1.9.90版本后,在__init__.py中新增了函数“category()”使得插件在菜单栏Raster、Vector、Database和Web下都可以了。该函数的作用就是定义插件的显示菜单,但目前其值只能选“Vector”、“Raster”、“Database”、“Web”和“Layers”中的一个。例如,加入你想在“Raster”菜单栏下显示你的插件,参照下面的代码:

__init__.py:

def category():
    return "Raster"

metadata.txt

在1.8版本之后,你必须添加该文件以描述你的插件信息。关于该文件的详细信息请参考https://github.com/qgis/qgis-django/blob/master/qgis-app/plugins/docs/introduction.rst。一个简单的例子如下:

; the next section is mandatory
[general]
name=HelloWorld
qgisMinimumVersion=1.8
description=This is a plugin for greeting the
    (going multiline) world
category=Raster
version=version 1.2
; end of mandatory metadata
; start of optional metadata
changelog=this is a very
    very
    very
    very
    very
    very long multiline changelog
; tags are in comma separated value format, spaces are allowed
tags=wkt,raster,hello world
; these metadata can be empty
; in a future version of the web application it will
; be probably possible to create a project on redmine
; if they are not filled
homepage=http://www.itopen.it
tracker=http://bugs.itopen.it
repository=http://www.itopen.it/repo
icon=icon.png
; experimental flag
experimental=True
; deprecated flag (applies to the whole plugin and not only to the uploaded versi
deprecated=False
...

plugin.py

在该类中定义插件操作。值得提醒的是该类中的classFactory()函数。该函数会在QGIS加载外部插件时调用,用来接收QgisInterface类实例的引用和(必须)返回自定义插件类的实例,即你的插件实例。举个简单的例子,如插件TestPlugin,参照下面的代码(testplugin.py):

from PyQt4.QtCore import *
from PyQt4.QtGui import *
from qgis.core import *
# initialize Qt resources from file resouces.py
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
    self.action.setWhatsThis("Configuration for test plugin")
    self.action.setStatusTip("This is status tip")
    QObject.connect(self.action, SIGNAL("triggered()"), 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
    QObject.connect(self.iface.mapCanvas(), SIGNAL("renderComplete(QPainter *)"),

  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
    QObject.disconnect(self.iface.mapCanvas(), SIGNAL("renderComplete(QPainter *)"

  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!
    ...
如果你用的是1.9.90以上的版本,并且想修改插件显示的位置,那你必须修改得修改initGui()函数和unload()函数部分代码。首先,检查QGIS的版本,若版本支持,则参照下面代码进行适当的修改:

def initGui(self):
  # create action that will start plugin configuration
  self.action = QAction(QIcon(":/plugins/testplug/icon.png"), "Test plugin", self
  self.action.setWhatsThis("Configuration for test plugin")
  self.action.setStatusTip("This is status tip")
  QObject.connect(self.action, SIGNAL("triggered()"), self.run)
  
  # check if Raster menu available
  if hasattr(self.iface, "addPluginToRasterMenu"):
    # Raster menu and toolbar available
    self.iface.addRasterToolBarIcon(self.action)
    self.iface.addPluginToRasterMenu("&Test plugins", self.action)
  else:
    # there is no Raster menu, place plugin under Plugins menu as usual
    self.iface.addToolBarIcon(self.action)
    self.iface.addPluginToMenu("&Test plugins", self.action)

  # connect to signal renderComplete which is emitted when canvas rendering is done
  QObject.connect(self.iface.mapCanvas(), SIGNAL("renderComplete(QPainter *)"), self

def unload(self):
  # check if Raster menu available and remove our buttons from appropriate
  # menu and toolbar
  if hasattr(self.iface, "addPluginToRasterMenu"):
    self.iface.removePluginRasterMenu("&Test plugins",self.action)
    self.iface.removeRasterToolBarIcon(self.action)
  else:
    self.iface.removePluginMenu("&Test plugins",self.action)
    self.iface.removeToolBarIcon(self.action)
  
  # disconnect form signal of the canvas 
  QObject.disconnect(self.iface.mapCanvas(), SIGNAL("renderComplete(QPainter *)"),

  ...
在自定义插件显示菜单位置时可参考 API docs中列举的函数。

Resources File

在initGui()函数中我们会使用到某些资源,例如上例中的icon.png,而这些资源是在resources中定义的,例如(resources.qrc):

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

为了避免与其他外部插件或者QGIS部件发生命名冲突,建议最好在资源文件中添加路径前缀,例如上例<qresource prefix="/plugins/testplug">。

最后呢,调用pyrcc4.exe将resources.qrc文件转换成resources.py文件即可,如下:

pyrcc4 -o resources.py resources.qrc
至此,万事具备,运行下看下结果把。


另附一张归纳图方便查阅:


 



本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

在QGIS下开发python插件 的相关文章

  • 漏极开路门详解(Open Drain, OD)定义 提示 上拉电阻对OD门动态性能的影响

    定义 指CMOS门电路的输出只有NMOS管 并且它的漏极是开路的 提示 由于OD门不能输出高电平 只能输出低电平 所以在使用OD门时必须在漏极和电源VDD间接一个上拉电阻 上拉电阻对OD门动态性能的影响 当其他门电路作为OD门的负载时 OD
  • 动态规划算法(2)最长回文子串详解

    文章目录 最长回文字串 动态规划 代码示例 前篇 1 初识动态规划 最长回文字串 传送门 https leetcode cn problems longest palindromic substring description 给你一个字符
  • PopupMenuView

    PopupMenuView 项目地址 kareluo PopupMenuView 简介 A view just like UIMenuController of iOS 一个类似 iOS 中弹框气泡菜单的控件 更多 作者 提 Bug 标签
  • 开心档-软件开发入门之Bootstrap4 按钮

    Bootstrap4 按钮 Bootstrap 4 提供了不同样式的按钮 实例
  • 还是畅通工程(水题) kruskal算法

    http acm hdu edu cn showproblem php pid 1233 Problem Description 某省调查乡村交通状况 得到的统计表中列出了任意两村庄间的距离 省政府 畅通工程 的目标是使全省任何两个村庄间都
  • Techniques for working with Big Data

    In the Big data it can be text data digital image data digital video data digital audio data and more Consequently with
  • 202.为用户定义的数据类型绑定规则案例

    示例说明 下面的示例演示了如何把规则绑定到列和用户定义的数据类型 并且演示了修改绑定于列和用户定义的数据类型的规则时 这两者之间的差异 定义数据类型 EXEC sp addtype ut age int null GO 为ut age定义规
  • 四层协议和七层协议详解

    一 TCP IP网络分层模型 四层协议 TCP IP的设计者创造性的提出 分层 的概念 把复杂的网络通信划分出多个层次 再给每一层分配不同的职责 采用 分而治之 的方法解决了网络通信的难题 TCP IP是一个纯软件的栈 缺少物理设备 TCP
  • 通过IP地址进行精准定位技术、方法与隐私问题的探讨

    导语 随着互联网和移动设备的普及 通过IP地址进行精准定位已成为现实 这一技术的发展带来了许多便利 但也引发了隐私问题的关注 本文将探讨通过IP地址进行精准定位的技术 方法以及涉及的隐私问题 技术和方法 IP地址的基本原理 IP地址是一个数
  • Elasticsearch使用系列-ES增删查改基本操作+ik分词

    一 安装可视化工具Kibana ES是一个NoSql数据库应用 和其他数据库一样 我们为了方便操作查看它 需要安装一个可视化工具 Kibana 官网 https www elastic co cn downloads kibana 和前面安
  • vue自定义指令---长按执行

    首先创建longpress js文件 import Vue from vue Vue directive longpress bind function el binding vNode if typeof binding value fu
  • Java中Transactional注解业务方法里面try catch会导致事务注解失效吗

    在 Java 中 使用 try catch 语句来捕获异常是很常见的 但是 在使用了 Transactional 注解的业务方法内部使用 try catch 语句并不会导致事务注解失效 当在带有 Transactional 注解的方法中使用
  • 【MifareClassicTool】小米NFC手机模拟加密门禁详细教程(Android手机通用)

    mifare官方最新版地址https www icaria de mct releases 3 0 资源名称 MifareClassicTool 资源分类 Android NFC类软件 资源大小 960 5 Kb 资源版本 V2 2 3 准
  • python中chr()函数和ord()函数的用法

    Python内置函数 一 chr 函数 格式 Chr lt 数值表达式 gt 说明 函数返回值类型为String 其数值表达式值取值范围为0 255 以下是 chr 方法的语法 chr i i 可以是10进制也可以是16进制的形式的数字 返
  • 【Matting】MODNet:实时人像抠图模型-笔记

    paper MODNet Real Time Trimap Free Portrait Matting via Objective Decomposition AAAI 2022 github https github com ZHKKKe
  • 无向图染色

    题目描述 给一个无向图染色 可以填红黑两种颜色 必须保证相邻两个节点不能同时为红色 输出有多少种不同的染色方案 输入描述 第 行输入M 图中节点数 N 边数 后续N行格式为 V1V2表示一个V1到V2的边 数据范围 1 lt M lt 15
  • Java中抽象类和接口区别

    简单概括下Java中抽象类和接口直接的区别 可以概括为如下几点 1 一个类可以实现多个接口 但却只能继承最多一个抽象类 2 抽象类可以包含具体的方法 接口的所有方法都是抽象的 3 抽象类可以声明和使用字段 接口则不能 但接口可以创建静态的f
  • CAT1和CAT4的区别

    现今 CAT1的发展势头一直很迅猛 那为什么CAT4不能替代CAT1的地位呢 我们来看下面几点 成本 1 网络建设方面 Cat1可以无缝接入现有LTE网络当中 无需针对基站进行软硬件升级 网络覆盖成本低 2 芯片成本方面 经过系统优化后 模
  • 在vue3项目中使用新版高德地图

    高德开发平台 高德开放平台 高德地图API amap com 1 首先你要注册好账号登录 2 获取key和密钥 自2021年12月02日升级 升级之后所申请的 key 必须配备安全密钥 jscode 一起使用 NPM方式安装和使用 基础版

随机推荐

  • 【VS2019/C++/报错】由于找不到libmysql.dll/由于找不到libssl-1_1-x64.dll,无法继续执行代码

    错误描述 属性页的包含目录和库目录都加了 链接器的lib也加了 但是运行时报错找不到libmysql dll 把libmysql dll文件放到项目文件夹内和系统文件夹C Windows SysWOW64都没用 开始报 找不到libssl
  • android AndroidManifest的category

    CATEGORY ALTERNATIVE 设置这个activity是否可以被认为是用户正在浏览的数据的一个可选择的action CATEGORY APP BROWSER 和ACTION MAIN一起使用 用来启动浏览器应用程序 CATEGO
  • SystemviewV3.3工具使用

    SystemviewV3 3工具使用 工具下载 移植 错误解决方式 使用方法 工具下载 Systemview下载地址 移植 以不带操作系统的移植方式为例 移植源码位于 工程加入以下文件 错误解决方式 keil下多重定义问题 Objects
  • 关于TP5多语言BUG的解决办法(直接上代码)

    按照手册配置 默认语言没有反应 跳转页面之后 也没有检测当前的语言 很尴尬 最大的bug在这里 1 请用下面代码覆盖 thinkPhp library think Lang php 里面的detect 自动检测语言方法 自动侦测设置获取语言
  • jQuery 获取当前节点的html包含当前节点的方法 --$(".test").prop("outerHTML");

    在开发过程中 jQuery html 是获取当前节点下的html代码 并不包含当前节点本身的代码 然后我们有时候确需要 找遍jQuery api文档也没有任何方法可以拿到 看到有的人通过parent html 如果当前元素没有兄弟元素还行
  • Python subplots() 使用说明

    plt subplots 官方教程 link 参数 matplotlib pyplot subplots nrows 1 ncols 1 sharex False sharey False squeeze True subplot kw N
  • 雅可比矩阵和Hessian矩阵

    Jacobian矩阵和Hessian矩阵 1 Jacobian 在向量分析中 雅可比矩阵是一阶偏导数以一定方式排列成的矩阵 其行列式称为雅可比行列式 还有 在代数几何中 代数曲线的雅可比量表示雅可比簇 伴随该曲线的一个代数群 曲线可以嵌入其
  • Linux搭建测试环境详细步骤

    本文讲解如何在Linux CentOS下部署Java Web项目的步骤 环境准备 1 Linux系统 2 JDK 3 Tomcat 4 MySQL 工具下载 可从官网下载 已把安装工具存于百度网盘 链接 https pan baidu co
  • Jmeter:使用代理录制脚本

    目录 前言 介绍下各设置项 前言 当我们想要录制并回放特定应用程序或网站的交互时 使用JMeter的代理是一种常见且有效的方法 通过配置JMeter代理 它可以拦截并记录客户端与目标应用程序之间的HTTP或HTTPS通信 然后生成对应的测试
  • 如何重装Linux系统

    大家都知道我们平常所用的windows系统 可以很方便的重装系统 有U盘安装 还有光盘安装 那么我们在Linux下如何重装系统呢 其实和Windows下方法大同小异 如果你手上正好有个U盘的话 那就可以试试做一个USB Linux启动盘 它
  • javaee springMVC Map ModelMap ModelAndView el和jstl的使用

    pom依赖
  • ELK Stack 日志平台性能优化实践

    性能分析 服务器硬件Linux 1cpu4GRAM 假设每条日志250Byte 分析 logstash Linux 1cpu 4GRAM 每秒500条日志 去掉ruby每秒660条日志 去掉grok后每秒1000条数据 filebeat L
  • EduCoder_web实训作业--CSS从入门到精通——文本与字体样式

    大家注意了 由于这次好多代码都是分开的 为了方便我把每一关所有代码都发出来了 只要全选粘贴复制就可以了 第二关和第三关的答题区域都是最后一个文件夹 第一关 body 背景渐变 background webkit linear gradien
  • 50岁贷款投资的人,到底经历了什么?

    虽说 成功的投资者大多是孤独的 但是 在学习成长的过程中 参与交流讨论的好处还是很大的 一方面三人行必有我师 一方面通过他人的经验教训 深化自己的思考 前两天 看到这样一个提问 我的中国银行信用卡可以贷款2 6利率 三年还清 共贷15万 我
  • Python 模块 ddt 数据驱动测试

    简介 ddt 提供了一种方便的方法来实现数据驱动测试 Data Driven Testing 数据驱动测试是一种测试方法 通过将测试数据与测试逻辑分开 可以使用不同的数据集来运行相同的测试用例 这样可以提高测试的灵活性和可维护性 减少代码的
  • 为什么说快速排序是性能最好的排序算法?

    刚刚学习了排序这一章 看到了书中最后的一个总结表 心想从表上来看 堆排序不该是最好的排序算法么 不管最好 最坏还是平均情况 时间复杂度都是O nlogn 而且还不像快排和归并排序那样占空间 为什么说快速排序是最好的算法呢 其实经过实验 会发
  • 手把手带你利用苹果手机使用美区礼品卡升级ChatGPT Plus,轻松搞定!

    大家好 我是五竹 昨天用苹果手机尝试了一下 借助App Store 苹果应用商店 升级 Plus 成功了 一共升级了三个号 有两个一气呵成 轻松搞定 最后一个可能触发风控了 但第一时间反馈给了苹果客服 5分钟不到就解决了 不得不说别人家的客
  • 下载Visio2013镜像路径以及安装Visio2013软件

    下载Visio2013镜像路径以及安装Visio2013软件 下载镜像安装路径 https exmail qq com cgi bin ftnExs download k 5736333137c49bbd8e5ddf1c106407561d
  • Java进阶知识点5:服务端高并发的基石 - NIO与Reactor模式以及AIO与Proactor模式

    一 背景 要提升服务器的并发处理能力 通常有两大方向的思路 1 系统架构层面 比如负载均衡 多级缓存 单元化部署等等 2 单节点优化层面 比如修复代码级别的性能Bug JVM参数调优 IO优化等等 一般来说 系统架构的合理程度 决定了系统在
  • 在QGIS下开发python插件

    本文来自CSDN博客 转载请标明出处 http blog csdn net xiluoduyu 出于研究sextante代码的需要 抽空查了下QGIS下python插件的开发流程 具体的操作参考英文的PyQGIS 的开发帮助文档 QGIS是