sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-10-05 00:09:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add more methods to the Processing script template

Browse Source
This commit is contained in:
Harrissou Sant-anna 2025-06-16 17:43:42 +02:00 committed by Nyall Dawson
parent 174c548d40
commit 8c0a4221e1
1 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
python/plugins/processing/script/ScriptTemplate.py
View File

@ -79,13 +79,21 @@ class ExampleProcessingAlgorithm(QgsProcessingAlgorithm):
"""
return "examplescripts"
def shortDescription(self) -> str:
"""
Returns an optional translated short description of the algorithm, displayed
on hover in Processing Toolbox. This should be at most a single sentence, e.g.,
“Converts 2D features to 3D by sampling a DEM raster.”
"""
return "Example algorithm short description on hover"
def shortHelpString(self) -> str:
"""
Returns a localised short helper string for the algorithm. This string
should provide a basic description about what the algorithm does and the
Returns a localised helper string for the algorithm displayed in the dialog.
This string should provide a basic description about what the algorithm does and the
parameters and outputs associated with it.
"""
return "Example algorithm short description"
return "Example algorithm description"
def initAlgorithm(self, config: Optional[dict[str, Any]] = None):
"""
@ -95,13 +103,14 @@ class ExampleProcessingAlgorithm(QgsProcessingAlgorithm):
# We add the input vector features source. It can have any kind of
# geometry.
self.addParameter(
QgsProcessingParameterFeatureSource(
self.INPUT,
"Input layer",
[QgsProcessing.SourceType.TypeVectorAnyGeometry],
)
input_layer = QgsProcessingParameterFeatureSource(
self.INPUT,
"Input layer",
[QgsProcessing.SourceType.TypeVectorAnyGeometry],
)
input_layer.setHelp("A descriptive, translated string explaining the parameter’s behavior and use in depth.")
self.addParameter(input_layer)
# We add a feature sink in which to store our processed features (this
# usually takes the form of a newly created vector layer when the