Syntactic sugar for PyQGIS

If you are a python coder you probably already know the with-statement.

If yes, you can directly jump to the with edit-section.
If not, here’s a short summing up.

If you want to edit a file you can do:

This is a bad idea. The file is not closed and you should always do that. We can easily add that, right?

Now what happens if do_some_changes_to(f) causes an exception? f.close() is never called.

You may remember something called finally. That can be appended to a try-block and will be executed in the end no-matter-what.

That’s a lot of code for something that was originally very slick. That’s where the with-statement comes into play:

It does the very same thing. Plus it is easier to read and faster to write than the whole try- finally-block.

Now QGIS has the same for editing layers since today (read: shipped with version 2.12).

with edit(layer)

Instead of writing

You can do:

If all goes well, the changes will be saved persistently to the datasource without any call to commitChanges() .

If any exception occurs, the changes will be rolled back. So like for the with -statement for files: it is easier to read, easier to write and it is comparable to a database transaction: Commit everything in the end or nothing at all if an error happens. How cool is that!

Plus you will get a python exception if something went wrong in committing (normally you will have to check the return value of layer.commitChanges() )and who does that anyway?

If you are writing your own .py files you will have to

And a final note since I am already on the topic of modifying data in persistent backends:

Avoid using the dataProvider() methods!

  • You cannot undo them easily
  • They generate one request per call what may reduce performance
  • They do not emit internal signals for map redraws and other refreshes of the user interface
  • They do not take uncommitted changes into account so the python changes will get overwritten by the user when he commits the layer changes

There is a theoretical advantage of slightly more control over how the communication with the backend happens (e.g. how many features are sent per request). But this is hardly ever required in real life unless you are working with really, really, really huge datasets.

Posted in Programming, Python, QGIS
1 Comment » for Syntactic sugar for PyQGIS
  1. Well, thanks for this Python improvement of the QGIS API. I will use it in my code as soon as 2.12 will be out.

Leave a Reply

Contact GmbH
Mythenstrasse 37A
8840 Einsiedeln

Twitter: @OPENGISch
Mobile: +41 (0)79 467 24 70
Skype: mbernasocchi
Support QField development
%d bloggers like this: