Hiding advanced parameters in QGIS Processing Algorithm Script

Question

There is an option, in the graphical modeler of QGIS 3.10, to mark input fields as "advanced" to hide them from user by default (advanced model parameters). I wonder how to achieve it from a Python script? I have tried to create a model from the graphical modeler and then convert it to a python script but it's not working (no "advanced" fields are marked in any way). I thought the addParameter() method of QgsProcessingAlgorithm class should have an additional parameter but it's not.

Is there a different way to create a collapsable box of advanced parameters in a processing algorithm window?

Answer 1

Indeed, it seems the "Export to Python" doesn't follow the advanced setting. You need to adapt the code a little bit.

When you have a new parameter like in the exported model:

self.addParameter(QgsProcessingParameterString(your python code))

You need to update to:

parameter = QgsProcessingParameterString(your python code)
parameter.setFlags(parameter.flags() | QgsProcessingParameterDefinition.FlagAdvanced)
self.addParameter(parameter)

And also you need to import on top of the file:

from qgis.core import QgsProcessingParameterDefinition

I think you can create a ticket saying that "Export to python doesn't follow the "Advanced" panel settings.

Side note, as this advanced setting is new in QGIS 3.10, better check if the model can still run on older version of QGIS. (> 3.4)

Answer 2

This falls under the QgsProcessingParameterDefinition class where you can specify the flag for the advanced parameter:

QgsProcessingParameterDefinition.FlagAdvanced

You can check a number of scripts which use this method in the QGIS GitHub to see how it it used.