PyQGISdevelopercookbook
                                            Release 2.18
                                           QGISProject
                                                April 08, 2019
                                                                                                                                                                                                    Contents
                             1     Introduction                                                                                                                                                                  1
                                   1.1        RunPythoncodewhenQGISstarts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                      1
                                   1.2        Python Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                             2
                                   1.3        Python Plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                             3
                                   1.4        Python Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                              3
                             2     LoadingProjects                                                                                                                                                               7
                             3     LoadingLayers                                                                                                                                                                 9
                                   3.1        Vector Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                            9
                                   3.2        Raster Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                          11
                                   3.3        MapLayerRegistry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                               11
                             4     Using Raster Layers                                                                                                                                                         13
                                   4.1        Layer Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                          13
                                   4.2        Renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                           13
                                   4.3        Refreshing Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                            15
                                   4.4        Query Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                           15
                             5     Using Vector Layers                                                                                                                                                         17
                                   5.1        Retrieving information about attributes                          .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  . . . . . . . .            17
                                   5.2        Selecting features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                         18
                                   5.3        Iterating over Vector Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                          18
                                   5.4        Modifying Vector Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                            20
                                   5.5        Modifying Vector Layers with an Editing Buffer . . . . . . . . . . . . . . . . . . . . . . . . . .                                                               22
                                   5.6        Using Spatial Index                .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  . . . . . . . . . .              23
                                   5.7        Writing Vector Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                            23
                                   5.8        MemoryProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                             24
                                   5.9        Appearance (Symbology) of Vector Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                26
                                   5.10 Further Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                 33
                             6     GeometryHandling                                                                                                                                                            35
                                   6.1        Geometry Construction                    .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  . . . . . . . . . .              35
                                   6.2        Access to Geometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                             36
                                   6.3        Geometry Predicates and Operations                            .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  . . . . . . . . .             36
                             7     Projections Support                                                                                                                                                         39
                                   7.1        Coordinate reference systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                             39
                                   7.2        Projections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                          40
                             8     Using MapCanvas                                                                                                                                                             41
                                   8.1        EmbeddingMapCanvas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                 41
                                   8.2        Using Map Tools with Canvas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                              42
                                                                                                                                                                                                                  i
                                   8.3        Rubber Bands and Vertex Markers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                              43
                                   8.4        Writing Custom Map Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                               44
                                   8.5        Writing Custom Map Canvas Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                45
                             9     MapRenderingandPrinting                                                                                                                                                     47
                                   9.1        Simple Rendering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                             47
                                   9.2        Rendering layers with different CRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                            48
                                   9.3        Output using Map Composer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                              48
                             10 Expressions, Filtering and Calculating Values                                                                                                                                  51
                                   10.1 Parsing Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                  52
                                   10.2 Evaluating Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                 52
                                   10.3 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                 53
                             11 ReadingAndStoringSettings                                                                                                                                                      55
                             12 Communicatingwiththeuser                                                                                                                                                       57
                                   12.1 Showingmessages. The QgsMessageBarclass . . . . . . . . . . . . . . . . . . . . . . . . .                                                                              57
                                   12.2 Showingprogress                       .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  . . . . . . . . . . . .                58
                                   12.3 Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                59
                             13 Developing Python Plugins                                                                                                                                                      61
                                   13.1 Writing a plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                 62
                                   13.2 Plugin content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                 62
                                   13.3 Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                  66
                                   13.4 Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                67
                             14 Authentication infrastructure                                                                                                                                                  69
                                   14.1 Introduction                 .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  . . . . . . . . . . . .                69
                                   14.2 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                 69
                                   14.3 QgsAuthManagertheentrypoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                        70
                                   14.4 Adaptplugins to use Authentication infrastructure . . . . . . . . . . . . . . . . . . . . . . . . .                                                                    73
                                   14.5 Authentication GUIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                  73
                             15 IDEsettings for writing and debugging plugins                                                                                                                                  77
                                   15.1 AnoteonconfiguringyourIDEonWindows . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                              77
                                   15.2 Debuggingusing Eclipse and PyDev                                    .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  . . . . . . . . . .              78
                                   15.3 Debuggingusing PDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                     82
                             16 Using Plugin Layers                                                                                                                                                            83
                                   16.1 Subclassing QgsPluginLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                   83
                             17 Compatibility with older QGIS versions                                                                                                                                         85
                                   17.1 Plugin menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                  85
                             18 Releasing your plugin                                                                                                                                                          87
                                   18.1 Metadata and names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                   87
                                   18.2 Codeandhelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                    87
                                   18.3 Official python plugin repository                              .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  .  . . . . . . . . . .              88
                             19 CodeSnippets                                                                                                                                                                   91
                                   19.1 Howtocallamethodbyakeyshortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                           91
                                   19.2 HowtotoggleLayers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                      91
                                   19.3 Howtoaccessattribute table of selected features . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                    91
                             20 Writing a Processing plugin                                                                                                                                                    93
                                   20.1 Creating a plugin that adds an algorithm provider . . . . . . . . . . . . . . . . . . . . . . . . . .                                                                  93
                                   20.2 Creating a plugin that contains a set of processing scripts . . . . . . . . . . . . . . . . . . . . . .                                                                93
                             ii