{"id":5774,"date":"2018-07-25T04:57:14","date_gmt":"2018-07-25T02:57:14","guid":{"rendered":"http:\/\/www.sigterritoires.fr\/?p=5774"},"modified":"2023-04-28T14:56:44","modified_gmt":"2023-04-28T12:56:44","slug":"use-script-runner-with-qgis","status":"publish","type":"post","link":"https:\/\/www.sigterritoires.fr\/index.php\/en\/use-script-runner-with-qgis\/","title":{"rendered":"Use Script Runner with QGis"},"content":{"rendered":"

The QGis Python ScriptRunner plugin provides a go-between tool for the QGis automatization process, between the Python Interactive Console and the complicated plugins developments. Provides a script management dialog box that you can easily load, create, edit and run scripts to automate QGis on large scale.<\/p>\n

Firstly, you\u00a0have to\u00a0install\u00a0and\u00a0activate\u00a0the plugin\u00a0from\u00a0the\u00a0manager\u00a0extensions.<\/p>\n

$\"\"$
\nTherefore, you\u00a0will find\u00a0the\u00a0Script Runner<\/em><\/strong>\u00a0launch menu\u00a0under the\u00a0\u00a0\u00a0extensions <\/em><\/strong>menu<\/p>\n

$\"\"$ <\/p>\n

Before starting\u00a0,\u00a0you\u00a0must\u00a0configure\u00a0the\u00a0text\u00a0editor\u00a0 for\u00a0editing\u00a0your\u00a0scripts.<\/p>\n

\n
Open\u00a0\u00a0\u00a0Script Runner<\/em><\/strong>\u00a0,<\/li>\n
click\u00a0the\u00a0Preferences\u00a0icon\u00a0(the\u00a0wheel\u00a0toothed\u00a0)<\/li>\n
In\u00a0\u00a0General\u00a0Options\u00a0check\u00a0the box\u00a0\u00a0<\/em><\/strong>\u00a0Edit Scripts Using …<\/em><\/strong><\/li>\n
Click\u00a0on the button\u00a0\u00a0\u00a0…<\/em><\/strong>\u00a0\u00a0<\/em>\u00a0and\u00a0point\u00a0to the\u00a0text\u00a0editing\u00a0program\u00a0selected\u00a0 $\"\"$ <\/li>\n<\/ul>\n
You\u00a0can\u00a0use the Windows Notepad that\u00a0you\u00a0find\u00a0in\u00a0C: \/Windows\/System32\/notepad.exe,\u00a0but\u00a0you\u00a0can\u00a0also\u00a0use\u00a0more powerful\u00a0tools\u00a0such\u00a0as Notepad ++ (\u00a0free\u00a0and\u00a0available\u00a0on the site\u00a0\u00a0https:\/\/notepad-plus-plus.org\/download\/v6.9.2.html
\nIf\u00a0you\u00a0follow\u00a0the\u00a0default\u00a0installation\u00a0you\u00a0will\u00a0enter\u00a0C: \/ Program Files (x86) \/ Notepad ++ \/ notepad ++. exe\u00a0in\u00a0the\u00a0Script Runner\u00a0window\u00a0.<\/p>\n
Need to<\/strong>\u00a0know<\/strong><\/p>\n
The\u00a0entry\u00a0point\u00a0of any script\u00a0in\u00a0\u00a0\u00a0Script Runner<\/em><\/strong>\u00a0\u00a0\u00a0is\u00a0the\u00a0function:<\/p>\n
def\u00a0run_script\u00a0(\u00a0iface\u00a0):<\/p>\n
run_script<\/em><\/strong>\u00a0\u00a0\u00a0with at\u00a0least\u00a0one argument,\u00a0the object\u00a0\u00a0\u00a0iface<\/em><\/strong>\u00a0.\u00a0You\u00a0have no \u00a0obligation\u00a0to use\u00a0this\u00a0object\u00a0in\u00a0your\u00a0code\u00a0but, inevitably, it has to be passed as first or only argument.<\/p>\n
Anyway, when you click on the icon New Script<\/em><\/strong>, you will find this function already declared.<\/p>\n
$\"\"$ <\/p>\n
This\u00a0structure\u00a0allows\u00a0you to use\u00a0directly the QGisInterface<\/em> class without\u00a0explicit declaration. But\u00a0without any other statement, you are limited to the methods contained in this class.<\/p>\n
However, you\u00a0can\u00a0add\u00a0imports of\u00a0any module\u00a0and\u00a0use them\u00a0in\u00a0your\u00a0code.\u00a0Creating\u00a0a new script\u00a0with\u00a0Script Runner<\/em><\/strong>\u00a0\u00a0\u00a0already\u00a0has\u00a0four\u00a0default\u00a0imports:<\/p>\n
\n
from PyQt4.QtCore import *<\/li>\n
from PyQt4.QtGui import *<\/li>\n
from\u00a0core\u00a0import *<\/li>\n
from\u00a0gui\u00a0import *<\/li>\n<\/ul>\n
that you\u00a0can\u00a0leave\u00a0or\u00a0remove\u00a0to\u00a0your\u00a0convenience\u00a0, and\u00a0also\u00a0complete\u00a0with any\u00a0other\u00a0Python module\u00a0needed\u00a0.<\/p>\n
How does it work<\/strong>\u00a0?<\/strong><\/p>\n
The\u00a0operation\u00a0\u00a0Script Runner<\/em><\/strong>\u00a0\u00a0is\u00a0very\u00a0simple.\u00a0You\u00a0have\u00a0the\u00a0toolbar:<\/p>\n
$\"\"$ <\/p>\n
For\u00a0creating\u00a0a\u00a0new\u00a0file.\u00a0py,\u00a0add\u00a0an\u00a0existing\u00a0Python\u00a0file,\u00a0execute\u00a0the\u00a0selected\u00a0script\u00a0in\u00a0the\u00a0list\u00a0of\u00a0script\u00a0files\u00a0, reload a\u00a0file\u00a0modified\u00a0, etc.<\/p>\n
And a\u00a0contextual\u00a0menu\u00a0(right\u00a0click\u00a0on a script from the\u00a0list\u00a0on the left) that\u00a0you\u00a0allows\u00a0mainly\u00a0to open\u00a0the\u00a0Python\u00a0file\u00a0in\u00a0your\u00a0text\u00a0editing\u00a0program\u00a0and\u00a0create\u00a0or\u00a0modify it.<\/p>\n
$\"\"$ <\/p>\n
Once\u00a0saved\u00a0the\u00a0contents\u00a0of\u00a0the\u00a0text\u00a0editor,\u00a0do\u00a0not\u00a0forget\u00a0to reload the script for\u00a0\u00a0\u00a0script runner<\/em><\/strong>\u00a0\u00a0\u00a0take\u00a0into consideration the changes you have just made.<\/p>\n
When you run a script with script runner<\/em><\/strong>, all the print<\/em><\/strong> commands are directed to the script runner<\/em><\/strong> output console:<\/p>\n
$\"\"$ <\/p>\n
Error\u00a0messages\u00a0are\u00a0also\u00a0directed\u00a0towards\u00a0this\u00a0window\u00a0.<\/p>\n
Finally,\u00a0the<\/strong>\u00a0setting<\/strong>\u00a0of<\/strong>\u00a0your<\/strong>\u00a0scripts<\/strong><\/p>\n
One\u00a0last\u00a0thing to know about\u00a0how\u00a0your\u00a0\u00a0\u00a0\u00a0script runner<\/em><\/strong>\u00a0\u00a0operation\u00a0is\u00a0how to pass arguments to\u00a0your\u00a0script.<\/p>\n
The first\u00a0method\u00a0is\u00a0to\u00a0return\u00a0these\u00a0arguments\u00a0in\u00a0the launching\u00a0command\u00a0of\u00a0the script:<\/p>\n
def\u00a0run_script\u00a0(\u00a0iface\u00a0,\u00a0data_path\u00a0,\u00a0buffer_size\u00a0):<\/p>\n
In\u00a0this\u00a0example,\u00a0you\u00a0look for\u00a0two\u00a0arguments, a\u00a0file\u00a0path,\u00a0and\u00a0a buffer\u00a0value.<\/p>\n
At the time of\u00a0script\u00a0execution,\u00a0a\u00a0window\u00a0will ask you\u00a0to\u00a0enter\u00a0the\u00a0parameters:<\/p>\n
$\"\"$ <\/p>\n
Another\u00a0way\u00a0of passing the arguments\u00a0is\u00a0to\u00a0create\u00a0a\u00a0parameter\u00a0string<\/p>\n
def\u00a0run_script\u00a0(\u00a0iface\u00a0, **\u00a0myargs\u00a0):<\/p>\n
In\u00a0this\u00a0case,\u00a0you\u00a0will\u00a0have to enter\u00a0the\u00a0different\u00a0arguments as name\/value\u00a0pairs<\/p>\n
$\"\"$ <\/p>\n
In\u00a0your\u00a0code\u00a0you\u00a0access\u00a0the\u00a0different\u00a0arguments as\u00a0:<\/p>\n
def\u00a0run_script\u00a0(\u00a0iface\u00a0, **\u00a0myargs\u00a0):<\/p>\n
data_path\u00a0=\u00a0myargs\u00a0[\u00a0‘\u00a0data_path\u00a0‘]<\/p>\n
my_buffer_size\u00a0=\u00a0myargs\u00a0[\u00a0‘\u00a0buffer_size\u00a0‘]<\/p>\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
The QGis Python ScriptRunner plugin provides a go-between tool for the QGis automatization process, between the Python Interactive Console and the complicated plugins developments. Provides a script management dialog box that you can easily load, create,…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"give_campaign_id":0,"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"sfsi_plus_gutenberg_text_before_share":"","sfsi_plus_gutenberg_show_text_before_share":"","sfsi_plus_gutenberg_icon_type":"","sfsi_plus_gutenberg_icon_alignemt":"","sfsi_plus_gutenburg_max_per_row":"","_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_post_was_ever_published":false},"categories":[1260],"tags":[],"class_list":["post-5774","post","type-post","status-publish","format-standard","hentry","category-non-classe-en"],"aioseo_notices":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p6XU0A-1v8","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/posts\/5774","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/comments?post=5774"}],"version-history":[{"count":0,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/posts\/5774\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/media?parent=5774"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/categories?post=5774"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.sigterritoires.fr\/index.php\/wp-json\/wp\/v2\/tags?post=5774"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}