add info about available processes

Author: vvmruder

src/qgis_server_light/exporter/cli.py

@@ -4,7 +4,11 @@
 import click
 from qgis.analysis import QgsNativeAlgorithms
 from qgis.core import QgsApplication
-from xsdata.formats.dataclass.serializers import JsonSerializer, XmlSerializer
+from xsdata.formats.dataclass.serializers import (
+    DictEncoder,
+    JsonSerializer,
+    XmlSerializer,
+)
 from xsdata.formats.dataclass.serializers.config import SerializerConfig
 
 from qgis_server_light.exporter.common import create_full_pg_service_conf
@@ -98,8 +102,8 @@ def export(
 
 @cli.command("export-processes")
 def export_processes():
-    serializer_config = SerializerConfig(indent="  ")
     registry = qgs.processingRegistry()
+    qgs.setTranslation("en")
     registry.addProvider(QgsNativeAlgorithms())
     process = Process(
         algorithms=[
@@ -116,7 +120,7 @@ def export_processes():
             ]
         ]
     )
-    click.echo(JsonSerializer(config=serializer_config).render(process))
+    click.echo(DictEncoder().encode(process))
 
 
 if __name__ == "__main__":

src/qgis_server_light/exporter/extract.py

@@ -985,10 +985,12 @@ def collect(acc, pair):
                     )
                     acc.append((our_scope_name, list_as_text))
                 else:
-                    acc.append((
-                        our_scope_name,
-                        project.readEntry(qgis_scope_name, key)[0],
-                    ))
+                    acc.append(
+                        (
+                            our_scope_name,
+                            project.readEntry(qgis_scope_name, key)[0],
+                        )
+                    )
 
                 return acc
 
@@ -1136,7 +1138,8 @@ def algorithm_from_qgs_definition(alg: QgsProcessingAlgorithm) -> Algorithm:
         id=alg.id(),
         name=alg.name(),
         display_name=alg.displayName(),
-        help_string=alg.helpString(),
+        short_help_string=alg.shortHelpString(),
+        short_description=alg.shortDescription(),
     )
     for param in alg.parameterDefinitions():
         algorithm.parameters.append(parameter_from_qgs_definition(param))

src/qgis_server_light/interface/exporter/extract.py

@@ -789,7 +789,8 @@ class Algorithm:
     id: str = field(metadata={"type": "Element"})
     name: str = field(metadata={"type": "Element"})
     display_name: str = field(metadata={"type": "Element"})
-    help_string: str | None = field(default=None, metadata={"type": "Element"})
+    short_help_string: str = field(metadata={"type": "Element"})
+    short_description: str = field(metadata={"type": "Element"})
     parameters: list[Parameter] = field(
         default_factory=list, metadata={"type": "Element"}
     )
@@ -802,3 +803,11 @@ class Process:
     algorithms: list[Algorithm] = field(
         default_factory=list, metadata={"type": "Element"}
     )
+
+    def algorithm_by_id(self, algorithm_id: str):
+        for algorithm in self.algorithms:
+            if algorithm.id == algorithm_id:
+                return algorithm
+        raise LookupError(
+            f"Algorithm with {algorithm_id} was not found in {self.algorithms}"
+        )