Expose setAllowCommit to Python (and other functions) by sewe2000 · Pull Request #62951 · qgis/QGIS

sewe2000 · 2025-08-25T12:06:03Z

Description

Hi.
I wanted to start a broader discussion about Python validation bindings. I would like to carry on with the idea represented in the PR #41455.

This PR is my solution to the problem. Please feel free to correct me. Any piece of advice is very valuable to me since I'm relatively new to the QGIS codebase.

Solves #53813

github-actions · 2025-09-09T02:52:46Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

sewe2000 · 2025-09-11T12:48:14Z

@qgis

src/core/vector/qgsvectorlayer.cpp

nyalldawson · 2025-09-17T23:17:00Z

I'm -1 to the current approach used in this PR -- I think it's too complex and fragile to be suitable.

I'd propose an alternative:

Introduce an interface class which is modelled after QgsApplicationExitBlockerInterface (Eg something like QgsLayerChangesCommitBlockerInterface). This would have a pure virtual method bool allowCommit( QgsMaplayer* layer ) = 0.
Follow the approach used for registering/unregistering application exit blockers (see eg QgsInterface::registerApplicationExitBlocker / QgisInterface::unregisterApplicationExitBlocker ), and their equivalents in QgisApp
Only target the changes at the app level, and don't modify any of the core classes. The blocking would happen in the app UI, after the actions which will commit changes to the layer are triggered (but before they the actual commitChanges call occurs). There we'd iterate through all the registered QgsLayerChangesCommitBlockerInterface objects, and if any of them return true, we'd abort the commit (with appropriate GUI feedback -- use the message bar for this).

github-actions · 2025-10-02T02:49:13Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

github-actions · 2025-10-02T14:35:15Z

🪟 Windows Qt6 builds

Download Windows Qt6 builds of this PR for testing.
(Built from commit d930c71)

🍎 MacOS Qt6 builds

Download MacOS Qt6 builds of this PR for testing.
This app is not notarized, run sudo xattr -d com.apple.quarantine /Applications/QGIS*.app to avoid the warning
(Built from commit d930c71)

github-actions · 2025-10-21T02:55:48Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

sewe2000 · 2025-10-21T14:59:16Z

@nyalldawson I think it's ready to be reviewed

src/gui/qgisinterface.h

src/gui/qgslayerchangescommitblockerinterface.h

src/app/gps/qgsappgpsdigitizing.cpp

github-actions · 2025-11-20T02:58:53Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

sewe2000 · 2026-01-14T11:26:23Z

@nyalldawson

github-actions · 2026-02-11T03:33:16Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

ostr00000 · 2026-02-11T17:52:25Z

What is the status of this PR? is it going to be merged soon, or there is something more needed? (or are they any meta issues like dev team is too busy at the moment)?

I am interested in this feature, but I would like to know about estimated schedule for this change (is it worth to wait for this a bit longer?).

elpaso · 2026-02-11T17:57:43Z

What is the status of this PR? is it going to be merged soon, or there is something more needed? (or are they any meta issues like dev team is too busy at the moment)?

I am interested in this feature, but I would like to know about estimated schedule for this change (is it worth to wait for this a bit longer?).

I didn't review your PR but I noticed that a couple of tests are failing: this is a blocker for merging in any situation.

…dation-bindings

src/gui/qgslayerchangescommitblockerinterface.h

nyalldawson · 2026-02-13T07:17:32Z

python/gui/auto_generated/qgslayerchangescommitblockerinterface.sip.in

+              return True
+
+       my_blocker = MyPluginCommitBlocker()
+       iface.registerApplicationExitBlocker(my_blocker)


Suggested change

iface.registerApplicationExitBlocker(my_blocker)

iface.registerLayerChangesCommitBlocker(my_blocker)

Please don't mark things resolved which aren't -- this makes reviewing VERY hard, and is part of the reason this PR is taking so long to get merged 😭

nyalldawson · 2026-02-13T07:17:55Z

python/plugins/grassprovider/tests/testdata/pol.gpkg

Revert changes

src/app/gps/qgsappgpsdigitizing.cpp

nyalldawson · 2026-02-13T07:20:19Z

src/app/gps/qgsappgpsdigitizing.cpp

          if ( QgsProject::instance()->gpsSettings()->automaticallyCommitFeatures() )
          {
+            if (!QgisApp::instance()->tryCommitChanges(vlayer)) {
+              vlayer->startEditing();


Suggested change

vlayer->startEditing();

nyalldawson · 2026-02-13T07:22:07Z

src/app/qgisapp.cpp

+  if (!QgisApp::instance()->tryCommitChanges(vlayer)) {
+    mSaveRollbackInProgress = false;
+    return;
+  }


Let's move this up a couple of lines, so that it's included in this check:

if ( !vlayer || !vlayer->isEditable() || !vlayer->isModified() || !tryCommitChanges( vlayer ) )

That'd avoid the extra complication with the mSaveRollbackInProgress handling

nyalldawson · 2026-02-13T07:23:58Z

src/app/qgisapp.cpp

+        messageBar()->pushWarning( tr("Committing changes to the layer is blocked"), 
+        tr("The ability to commit changes to the '%1' layer has been blocked by a plugin or script").arg( layer->name() ));


The docs for QgsLayerChangesCommitBlockerInterface state "It is safe to use GUI widgets in implementations of this function, including message boxes or custom dialogs with event loops.". I'd leave responsibility for advising users of the situation entirely up to the QgsLayerChangesCommitBlockerInterface implementation -- that way the plugin/script can decide the best way to notify users, and avoid a potentially redundant generic warning showing here.

nyalldawson · 2026-02-13T07:24:33Z

src/app/qgisapp.h

+    /**
+     * Displays a warning about layer `layer` being blocked from the process of
+     * committing changes using the messagebar.
+     *
+    **/
+


Not resolved

src/app/qgisapp.h

nyalldawson · 2026-02-13T07:25:23Z

src/app/qgsguivectorlayertools.cpp

      case QMessageBox::Save:
+        if (!QgisApp::instance()->tryCommitChanges(layer)) {
+          res = false;
+          layer->triggerRepaint();


Suggested change

layer->triggerRepaint();

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

…e.sip.in Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

…dings' into bug_18101-python-validation-bindings # Conflicts: # src/app/gps/qgsappgpsdigitizing.cpp

# Conflicts: # python/gui/auto_additions/qgisinterface.py # python/gui/auto_generated/qgisinterface.sip.in # python/gui/gui_auto.sip

…ings Update branch and fix pre-commit errors

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

remove this nasty space from code-review suggestion at the end of line

previously there were some IDE "improvements"

there was a some error when commiting suggestion from github

github-actions · 2026-03-01T03:30:30Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

…dation-bindings

github-actions bot added this to the 4.0.0 milestone Aug 25, 2025

sewe2000 changed the title ~~Python layer validation bindings~~ Expose setAllowCommit to Python Aug 25, 2025

sewe2000 changed the title ~~Expose setAllowCommit to Python~~ Expose setAllowCommit to Python (and extend functionality) Aug 25, 2025

sewe2000 changed the title ~~Expose setAllowCommit to Python (and extend functionality)~~ Expose setAllowCommit to Python Aug 25, 2025

sewe2000 changed the title ~~Expose setAllowCommit to Python~~ Expose setAllowCommit to Python (and other functions) Aug 25, 2025

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Sep 9, 2025

github-actions bot removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Sep 11, 2025

nyalldawson reviewed Sep 17, 2025

View reviewed changes

src/core/vector/qgsvectorlayer.cpp Outdated Show resolved Hide resolved

github-actions bot added stale Uh oh! Seems this work is abandoned, and the PR is about to close. and removed stale Uh oh! Seems this work is abandoned, and the PR is about to close. labels Oct 2, 2025

sewe2000 force-pushed the bug_18101-python-validation-bindings branch from 6833f4a to 19d4630 Compare October 2, 2025 05:59

sewe2000 marked this pull request as draft October 2, 2025 06:00

sewe2000 force-pushed the bug_18101-python-validation-bindings branch 2 times, most recently from 5271b22 to be00190 Compare October 2, 2025 11:44

sewe2000 marked this pull request as ready for review October 6, 2025 13:08

sewe2000 requested a review from nyalldawson October 6, 2025 13:08

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Oct 21, 2025

github-actions bot removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Oct 21, 2025

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Nov 5, 2025

nyalldawson reviewed Nov 5, 2025

View reviewed changes

qgis deleted a comment from github-actions bot Nov 5, 2025

nyalldawson removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Nov 5, 2025

github-actions bot removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Jan 14, 2026

nyalldawson added the API API improvement only, no visible user interface changes label Jan 27, 2026

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Feb 11, 2026

github-actions bot removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Feb 11, 2026

ostr00000 added 2 commits February 11, 2026 19:13

Merge remote-tracking branch 'base/master' into bug_18101-python-vali…

3f53cf3

…dation-bindings

fix pre-commit errors (maily formatting)

d698ac5

nyalldawson reviewed Feb 13, 2026

View reviewed changes

Update src/gui/qgslayerchangescommitblockerinterface.h

853678c

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

github-actions bot added the GRASS label Feb 13, 2026

sewe2000 and others added 11 commits February 13, 2026 14:23

Update python/gui/auto_generated/qgslayerchangescommitblockerinterfac…

84732d7

…e.sip.in Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

Update src/app/gps/qgsappgpsdigitizing.cpp

9552fa0

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

Merge remote-tracking branch 'seweryn/bug_18101-python-validation-bin…

51de69e

…dings' into bug_18101-python-validation-bindings # Conflicts: # src/app/gps/qgsappgpsdigitizing.cpp

Merge branch 'master' into bug_18101-python-validation-bindings

8381034

# Conflicts: # python/gui/auto_additions/qgisinterface.py # python/gui/auto_generated/qgisinterface.sip.in # python/gui/gui_auto.sip

fix pre-commit errors

592cf5a

Merge pull request #1 from ostr00000/bug_18101-python-validation-bind…

5018ee9

…ings Update branch and fix pre-commit errors

removing unnecessary repaint, startEditing, imporving grammar in comment

b5bcc52

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

reverting unnecessary change in pol.gpkg

d80fbf4

fix pre-commit

0f9f143

remove this nasty space from code-review suggestion at the end of line

revert again pol.gpkg

9a5232c

previously there were some IDE "improvements"

removing unnecessary repaint, startEditing (again)

5e47b39

there was a some error when commiting suggestion from github

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Mar 1, 2026

Merge remote-tracking branch 'base/master' into bug_18101-python-vali…

d930c71

…dation-bindings

github-actions bot removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Mar 2, 2026

nyalldawson added Frozen Feature freeze - Do not merge! and removed Frozen Feature freeze - Do not merge! labels Mar 6, 2026

	iface.registerApplicationExitBlocker(my_blocker)
	iface.registerLayerChangesCommitBlocker(my_blocker)

		messageBar()->pushWarning( tr("Committing changes to the layer is blocked"),
		tr("The ability to commit changes to the '%1' layer has been blocked by a plugin or script").arg( layer->name() ));

Uh oh!

Conversation

sewe2000 commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

github-actions bot commented Sep 9, 2025

Uh oh!

sewe2000 commented Sep 11, 2025

Uh oh!

Uh oh!

nyalldawson commented Sep 17, 2025

Uh oh!

github-actions bot commented Oct 2, 2025

Uh oh!

github-actions bot commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🪟 Windows Qt6 builds

🍎 MacOS Qt6 builds

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

sewe2000 commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Nov 20, 2025

Uh oh!

sewe2000 commented Jan 14, 2026

Uh oh!

github-actions bot commented Feb 11, 2026

Uh oh!

ostr00000 commented Feb 11, 2026

Uh oh!

elpaso commented Feb 11, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sewe2000 commented Aug 25, 2025 •

edited

Loading

github-actions bot commented Oct 2, 2025 •

edited

Loading

sewe2000 commented Oct 21, 2025 •

edited

Loading