support grass algorithms in profile folder #53246

AlisterH · 2023-05-26T15:20:45Z

Description

Allow users to create algorithm descriptions in [QGIS profile folder]/processing/grassaddons/description.
An addon shipped with QGIS can also be overridden by creating a modified version here.
The ext mechanism is supported at [QGIS profile folder]/processing/grassaddons/ext.

This follows on from #53049, to implement #53048.

AlisterH · 2023-05-28T18:02:23Z

I have tried to implement this as simply as possible; not sure what someone more competent would think.
We should probably do a couple more things:

create [QGIS profile folder]/processing/grassaddons/ext
put a copy of python\plugins\grassprovider\grass7.txt in [QGIS profile folder]/processing/grassaddons/

But I guess the big question is whether [QGIS profile folder]/processing/grassaddons/ is the best place to use.

nicogodet · 2023-05-29T06:27:37Z

An addon shipped with QGIS can also be overridden by creating a modified version here

Looking at current implementation, it seems that user defined description will be added first then shipped desc and override user one ?

createAlgsList can return duplicated alg and it may lead to unwanted behavior. It may be worth checking is alg exists before adding it to list and raise a warning.

AlisterH · 2023-05-30T00:41:41Z

I believe this is correctly handled by qgsprocessingprovider.cpp
It raises a warning "Duplicate algorithm name..."
And algorithms in [QGIS profile folder]/processing/grassaddons seem to override those in python\plugins\grassprovider\ as desired.

Do you want an additional check anyway?
I guess it would make the provider load a bit faster, in case someone wanted to override a large number of algorithms.

AlisterH · 2023-05-30T11:32:53Z

When I say "override" I mean "are loaded in preference to".

nyalldawson · 2023-05-30T23:50:49Z

python/plugins/grassprovider/Grass7Algorithm.py

+                spec = importlib.util.spec_from_file_location('grassprovider.ext.' + name, extpath)
+                self.module = importlib.util.module_from_spec(spec)
+                spec.loader.exec_module(self.module)
+        except Exception:


can we avoid the broad exception here and catch specific ones instead?

Any advice on what to catch, given that we're loading code written by the user?

Maybe we just need to be more informative?:

except Exception as e: QgsMessageLog.logMessage(self.tr('Failed to load: {0}\n{1}').format(extpath, str(e)), 'Processing', Qgis.Critical) pass

Are you happy with pass rather than raise e? This means if someone has written a working algorithm description, in most cases it will be useable even if they are struggling with getting an ext module module they're writing to work.

Should Qgis.Critical be downgraded? With the current pull request we get a Qgis.Critical Could not open GRASS GIS 7 algorithm:, with the exception, so I presume we should stick with Qgis.Critical

I'm fine with a QgsMessage.

I've added that to the pull request.

I did wonder if we should add something like this, but it didn't seem right when we don't show a message even when we fail to load an algorithm:

iface.messageBar().pushMessage("Warning", "GRASS algorithm " + self.name() + " failed to load ext module - see Processing log messages", 1)

python/plugins/grassprovider/Grass7AlgorithmProvider.py

Co-authored-by: Nicolas Godet <39594821+nicogodet@users.noreply.github.com>

python/plugins/grassprovider/Grass7Utils.py

Co-authored-by: Loïc Bartoletti <lbartoletti@users.noreply.github.com>

github-actions · 2023-06-20T02:41:32Z

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.

AlisterH · 2023-06-20T03:23:36Z

Bumping to stop the bot killing us.

github-actions · 2023-07-05T02:52:07Z

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.

AlisterH · 2023-07-05T03:11:59Z

Bumping again to stay alive.

support grass algorithms in profile folder

08d69c6

github-actions bot added the GRASS label May 26, 2023

github-actions bot added this to the 3.32.0 milestone May 26, 2023

fix lint errors

18e2d1f

nyalldawson reviewed May 30, 2023

View reviewed changes

AlisterH added 2 commits May 31, 2023 20:16

add userDescriptionFolder() method

7b0a8a2

Add comments

4731068

nicogodet reviewed May 31, 2023

View reviewed changes

python/plugins/grassprovider/Grass7AlgorithmProvider.py Outdated Show resolved Hide resolved

python/plugins/grassprovider/Grass7AlgorithmProvider.py Outdated Show resolved Hide resolved

AlisterH and others added 2 commits May 31, 2023 21:36

Update python/plugins/grassprovider/Grass7AlgorithmProvider.py

62c8321

Co-authored-by: Nicolas Godet <39594821+nicogodet@users.noreply.github.com>

Update python/plugins/grassprovider/Grass7AlgorithmProvider.py

ac92019

Co-authored-by: Nicolas Godet <39594821+nicogodet@users.noreply.github.com>

lbartoletti reviewed Jun 2, 2023

View reviewed changes

python/plugins/grassprovider/Grass7Utils.py Show resolved Hide resolved

lbartoletti reviewed Jun 2, 2023

View reviewed changes

python/plugins/grassprovider/Grass7Utils.py Outdated Show resolved Hide resolved

AlisterH and others added 4 commits June 6, 2023 08:39

Update python/plugins/grassprovider/Grass7Utils.py

c5bd4fd

Co-authored-by: Loïc Bartoletti <lbartoletti@users.noreply.github.com>

More informative message if ext module fails to load

f129590

Use more pathlib instead of os module

1e81fe4

remove unnecessary casts from last commit

27781bc

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Jun 20, 2023

github-actions bot removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Jun 20, 2023

AlisterH mentioned this pull request Jul 3, 2023

Add g.version algorithm #53635

Closed

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

github-actions bot removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Jul 5, 2023

nyalldawson approved these changes Jul 6, 2023

View reviewed changes

nyalldawson merged commit 75420de into qgis:master Jul 6, 2023
28 checks passed

agiudiceandrea mentioned this pull request Sep 15, 2023

r.tpi is missing from QGIS GRASS support #54619

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support grass algorithms in profile folder #53246

support grass algorithms in profile folder #53246

AlisterH commented May 26, 2023 •

edited

Loading

AlisterH commented May 28, 2023 •

edited

Loading

nicogodet commented May 29, 2023

AlisterH commented May 30, 2023 •

edited

Loading

AlisterH commented May 30, 2023

nyalldawson May 30, 2023

AlisterH May 31, 2023 •

edited

Loading

lbartoletti Jun 2, 2023

AlisterH Jun 5, 2023

AlisterH Jun 5, 2023

github-actions bot commented Jun 20, 2023

AlisterH commented Jun 20, 2023

github-actions bot commented Jul 5, 2023

AlisterH commented Jul 5, 2023

support grass algorithms in profile folder #53246

support grass algorithms in profile folder #53246

Conversation

AlisterH commented May 26, 2023 • edited Loading

Description

AlisterH commented May 28, 2023 • edited Loading

nicogodet commented May 29, 2023

AlisterH commented May 30, 2023 • edited Loading

AlisterH commented May 30, 2023

nyalldawson May 30, 2023

Choose a reason for hiding this comment

AlisterH May 31, 2023 • edited Loading

Choose a reason for hiding this comment

lbartoletti Jun 2, 2023

Choose a reason for hiding this comment

AlisterH Jun 5, 2023

Choose a reason for hiding this comment

AlisterH Jun 5, 2023

Choose a reason for hiding this comment

github-actions bot commented Jun 20, 2023

AlisterH commented Jun 20, 2023

github-actions bot commented Jul 5, 2023

AlisterH commented Jul 5, 2023

AlisterH commented May 26, 2023 •

edited

Loading

AlisterH commented May 28, 2023 •

edited

Loading

AlisterH commented May 30, 2023 •

edited

Loading

AlisterH May 31, 2023 •

edited

Loading