feat: wrap tooltip strings in translation methods

merydian · merydian · commit 7d442e1f9f57 · 2025-05-05T09:24:45.000+02:00
diff --git a/ORStools/proc/base_processing_algorithm.py b/ORStools/proc/base_processing_algorithm.py
@@ -123,7 +123,7 @@ def provider_parameter(self) -> QgsProcessingParameterEnum:
             defaultValue=providers[0],
         )
 
-        self.setToolTip(parameter, "Select the provider that should be used.")
+        self.setToolTip(parameter, self.tr("Select the provider that should be used."))
 
         return parameter
 
@@ -150,7 +150,7 @@ def output_parameter(self) -> QgsProcessingParameterFeatureSink:
             name=self.OUT,
             description=self.GROUP,
         )
-        self.setToolTip(parameter, "Select where the output should be saved.")
+        self.setToolTip(parameter, self.tr("Select where the output should be saved."))
 
         return parameter
 
@@ -188,10 +188,10 @@ def option_parameters(self) -> [QgsProcessingParameterDefinition]:
             ),
         ]
 
-        self.setToolTip(parameters[0], "Select features that should be avoided by the algorithm.")
-        self.setToolTip(parameters[1], "Select borders that should be avoided by the algorithm.")
-        self.setToolTip(parameters[2], "Select countries that should be avoided by the algorithm.")
-        self.setToolTip(parameters[3], "Select polygons that should be avoided by the algorithm.")
+        self.setToolTip(parameters[0], self.tr("Select features that should be avoided by the algorithm."))
+        self.setToolTip(parameters[1], self.tr("Select borders that should be avoided by the algorithm."))
+        self.setToolTip(parameters[2], self.tr("Select countries that should be avoided by the algorithm."))
+        self.setToolTip(parameters[3], self.tr("Select polygons that should be avoided by the algorithm."))
 
         return parameters
 
diff --git a/ORStools/proc/directions_lines_proc.py b/ORStools/proc/directions_lines_proc.py
@@ -87,14 +87,14 @@ def __init__(self):
         self.setToolTip(self.PARAMETERS[0], "LineString or MultiLineString layer.")
         self.setToolTip(
             self.PARAMETERS[1],
-            "Values will transfer to the output layer and can be used to join layers or group features afterwards.",
+            self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),
         )
         self.setToolTip(
-            self.PARAMETERS[2], "Dictates the cost. For longer routes don't use Shortest Path."
+            self.PARAMETERS[2], self.tr("Dictates the cost. For longer routes don't use Shortest Path.")
         )
         self.setToolTip(
             self.PARAMETERS[3],
-            "You can optionally perform a Traveling Salesman on the waypoints of each MultiPoint feature. Enabling Traveling Salesman will erase all other advanced configuration and assume the preference to be fastest Advanced Parameters: see the documentation for descriptions.",
+            self.tr("You can optionally perform a Traveling Salesman on the waypoints of each MultiPoint feature. Enabling Traveling Salesman will erase all other advanced configuration and assume the preference to be fastest Advanced Parameters: see the documentation for descriptions."),
         )
 
     def processAlgorithm(self, parameters, context, feedback):
diff --git a/ORStools/proc/directions_points_layer_proc.py b/ORStools/proc/directions_points_layer_proc.py
@@ -92,21 +92,21 @@ def __init__(self):
             ),
         ]
 
-        self.setToolTip(self.PARAMETERS[0], "Point or MultiPoint layer.")
+        self.setToolTip(self.PARAMETERS[0], self.tr("Point or MultiPoint layer."))
         self.setToolTip(
             self.PARAMETERS[1],
-            "Values will transfer to the output layer and can be used to join layers or group features afterwards.",
+            self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),
         )
         self.setToolTip(
             self.PARAMETERS[2],
-            "Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x).",
+            self.tr("Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x)."),
         )
         self.setToolTip(
-            self.PARAMETERS[3], "Dictates the cost. For longer routes don't use Shortest Path."
+            self.PARAMETERS[3], self.tr("Dictates the cost. For longer routes don't use Shortest Path.")
         )
         self.setToolTip(
             self.PARAMETERS[4],
-            "You can optionally perform a Traveling Salesman Optimization on the waypoints of each (Multi)Point feature. Enabling Traveling Salesman will erase all other advanced configuration and assume the preference to be fastest.",
+            self.tr("You can optionally perform a Traveling Salesman Optimization on the waypoints of each (Multi)Point feature. Enabling Traveling Salesman will erase all other advanced configuration and assume the preference to be fastest."),
         )
 
     def processAlgorithm(self, parameters, context, feedback):
diff --git a/ORStools/proc/directions_points_layers_proc.py b/ORStools/proc/directions_points_layers_proc.py
@@ -108,30 +108,30 @@ def __init__(self):
                 defaultValue=self.MODE_SELECTION[0],
             ),
         ]
-        self.setToolTip(self.PARAMETERS[0], "Only Point layers are allowed, not MultiPoint.")
+        self.setToolTip(self.PARAMETERS[0], self.tr("Only Point layers are allowed, not MultiPoint."))
         self.setToolTip(
             self.PARAMETERS[1],
-            "Values will transfer to the output layer and can be used to join layers or group features afterwards.",
+            self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),
         )
         self.setToolTip(
             self.PARAMETERS[2],
-            "Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x)",
+            self.tr("Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x)"),
         )
         self.setToolTip(self.PARAMETERS[3], "Only Point layers are allowed, not MultiPoint.")
         self.setToolTip(
             self.PARAMETERS[4],
-            "Values will transfer to the output layer and can be used to join layers or group features afterwards.",
+            self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),
         )
         self.setToolTip(
             self.PARAMETERS[5],
-            "Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x)",
+            self.tr("Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x)"),
         )
         self.setToolTip(
-            self.PARAMETERS[6], "Dictates the cost. For longer routes don't use Shortest Path."
+            self.PARAMETERS[6], self.tr("Dictates the cost. For longer routes don't use Shortest Path.")
         )
         self.setToolTip(
             self.PARAMETERS[7],
-            "Either 'row-by-row' until one layers has no more features or 'all-by-all' for every feature combination",
+            self.tr("Either 'row-by-row' until one layers has no more features or 'all-by-all' for every feature combination"),
         )
 
     # TODO: preprocess parameters to options the range cleanup below:
diff --git a/ORStools/proc/isochrones_layer_proc.py b/ORStools/proc/isochrones_layer_proc.py
@@ -104,22 +104,22 @@ def __init__(self):
             ),
         ]
 
-        self.setToolTip(self.PARAMETERS[0], "Only Point layers are allowed, not MultiPoint.")
+        self.setToolTip(self.PARAMETERS[0], self.tr("Only Point layers are allowed, not MultiPoint."))
         self.setToolTip(
             self.PARAMETERS[1],
-            "Values will transfer to the output layer and can be used to join layers or group features afterwards.",
+            self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),
         )
         self.setToolTip(
             self.PARAMETERS[3],
-            "Parameter needs to be a comma-separated list of integer values, no decimal points.",
+            self.tr("Parameter needs to be a comma-separated list of integer values, no decimal points."),
         )
         self.setToolTip(
             self.PARAMETERS[4],
-            "Applies a level of generalisation to the isochrone polygons generated as a smoothing_factor between 0 and 100.",
+            self.tr("Applies a level of generalisation to the isochrone polygons generated as a smoothing_factor between 0 and 100."),
         )
         self.setToolTip(
             self.PARAMETERS[5],
-            "Start treats the location(s) as starting point, destination as goal.",
+            self.tr("Start treats the location(s) as starting point, destination as goal."),
         )
 
     # Save some important references
diff --git a/ORStools/proc/isochrones_point_proc.py b/ORStools/proc/isochrones_point_proc.py
@@ -90,18 +90,18 @@ def __init__(self):
             ),
         ]
 
-        self.setToolTip(self.PARAMETERS[0], "Choose a Point from the map.")
+        self.setToolTip(self.PARAMETERS[0], self.tr("Choose a Point from the map."))
         self.setToolTip(
             self.PARAMETERS[2],
-            "Parameter needs to be a comma-separated list of integer values, no decimal points.",
+            self.tr("Parameter needs to be a comma-separated list of integer values, no decimal points."),
         )
         self.setToolTip(
             self.PARAMETERS[3],
-            "Applies a level of generalisation to the isochrone polygons generated as a smoothing_factor between 0 and 100.",
+            self.tr("Applies a level of generalisation to the isochrone polygons generated as a smoothing_factor between 0 and 100."),
         )
         self.setToolTip(
             self.PARAMETERS[4],
-            "Start treats the location(s) as starting point, destination as goal.",
+            self.tr("Start treats the location(s) as starting point, destination as goal."),
         )
 
     # Save some important references
diff --git a/ORStools/proc/matrix_proc.py b/ORStools/proc/matrix_proc.py
@@ -82,15 +82,15 @@ def __init__(self):
             ),
         ]
 
-        self.setToolTip(self.PARAMETERS[0], "Only Point layers are allowed, not MultiPoint.")
+        self.setToolTip(self.PARAMETERS[0], self.tr("Only Point layers are allowed, not MultiPoint."))
         self.setToolTip(
             self.PARAMETERS[1],
-            "Values will transfer to the output layer and can be used to join layers or group features afterwards.",
+            self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),
         )
         self.setToolTip(self.PARAMETERS[2], "Only Point layers are allowed, not MultiPoint.")
         self.setToolTip(
             self.PARAMETERS[3],
-            "Values will transfer to the output layer and can be used to join layers or group features afterwards.",
+            self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),
         )
 
     def processAlgorithm(self, parameters, context, feedback):

Original file line number	Diff line number	Diff line change
`@@ -87,14 +87,14 @@ def __init__(self):`
`87`	`87`	`self.setToolTip(self.PARAMETERS[0], "LineString or MultiLineString layer.")`
`88`	`88`	`self.setToolTip(`
`89`	`89`	`self.PARAMETERS[1],`
`90`		`- "Values will transfer to the output layer and can be used to join layers or group features afterwards.",`
	`90`	`+ self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),`
`91`	`91`	`)`
`92`	`92`	`self.setToolTip(`
`93`		`- self.PARAMETERS[2], "Dictates the cost. For longer routes don't use Shortest Path."`
	`93`	`+ self.PARAMETERS[2], self.tr("Dictates the cost. For longer routes don't use Shortest Path.")`
`94`	`94`	`)`
`95`	`95`	`self.setToolTip(`
`96`	`96`	`self.PARAMETERS[3],`
`97`		`- "You can optionally perform a Traveling Salesman on the waypoints of each MultiPoint feature. Enabling Traveling Salesman will erase all other advanced configuration and assume the preference to be fastest Advanced Parameters: see the documentation for descriptions.",`
	`97`	`+ self.tr("You can optionally perform a Traveling Salesman on the waypoints of each MultiPoint feature. Enabling Traveling Salesman will erase all other advanced configuration and assume the preference to be fastest Advanced Parameters: see the documentation for descriptions."),`
`98`	`98`	`)`
`99`	`99`
`100`	`100`	`def processAlgorithm(self, parameters, context, feedback):`
Original file line number	Diff line number	Diff line change
`@@ -92,21 +92,21 @@ def __init__(self):`
`92`	`92`	`),`
`93`	`93`	`]`
`94`	`94`
`95`		`- self.setToolTip(self.PARAMETERS[0], "Point or MultiPoint layer.")`
	`95`	`+ self.setToolTip(self.PARAMETERS[0], self.tr("Point or MultiPoint layer."))`
`96`	`96`	`self.setToolTip(`
`97`	`97`	`self.PARAMETERS[1],`
`98`		`- "Values will transfer to the output layer and can be used to join layers or group features afterwards.",`
	`98`	`+ self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),`
`99`	`99`	`)`
`100`	`100`	`self.setToolTip(`
`101`	`101`	`self.PARAMETERS[2],`
`102`		`- "Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x).",`
	`102`	`+ self.tr("Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x)."),`
`103`	`103`	`)`
`104`	`104`	`self.setToolTip(`
`105`		`- self.PARAMETERS[3], "Dictates the cost. For longer routes don't use Shortest Path."`
	`105`	`+ self.PARAMETERS[3], self.tr("Dictates the cost. For longer routes don't use Shortest Path.")`
`106`	`106`	`)`
`107`	`107`	`self.setToolTip(`
`108`	`108`	`self.PARAMETERS[4],`
`109`		`- "You can optionally perform a Traveling Salesman Optimization on the waypoints of each (Multi)Point feature. Enabling Traveling Salesman will erase all other advanced configuration and assume the preference to be fastest.",`
	`109`	`+ self.tr("You can optionally perform a Traveling Salesman Optimization on the waypoints of each (Multi)Point feature. Enabling Traveling Salesman will erase all other advanced configuration and assume the preference to be fastest."),`
`110`	`110`	`)`
`111`	`111`
`112`	`112`	`def processAlgorithm(self, parameters, context, feedback):`
Original file line number	Diff line number	Diff line change
`@@ -108,30 +108,30 @@ def __init__(self):`
`108`	`108`	`defaultValue=self.MODE_SELECTION[0],`
`109`	`109`	`),`
`110`	`110`	`]`
`111`		`- self.setToolTip(self.PARAMETERS[0], "Only Point layers are allowed, not MultiPoint.")`
	`111`	`+ self.setToolTip(self.PARAMETERS[0], self.tr("Only Point layers are allowed, not MultiPoint."))`
`112`	`112`	`self.setToolTip(`
`113`	`113`	`self.PARAMETERS[1],`
`114`		`- "Values will transfer to the output layer and can be used to join layers or group features afterwards.",`
	`114`	`+ self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),`
`115`	`115`	`)`
`116`	`116`	`self.setToolTip(`
`117`	`117`	`self.PARAMETERS[2],`
`118`		`- "Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x)",`
	`118`	`+ self.tr("Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x)"),`
`119`	`119`	`)`
`120`	`120`	`self.setToolTip(self.PARAMETERS[3], "Only Point layers are allowed, not MultiPoint.")`
`121`	`121`	`self.setToolTip(`
`122`	`122`	`self.PARAMETERS[4],`
`123`		`- "Values will transfer to the output layer and can be used to join layers or group features afterwards.",`
	`123`	`+ self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),`
`124`	`124`	`)`
`125`	`125`	`self.setToolTip(`
`126`	`126`	`self.PARAMETERS[5],`
`127`		`- "Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x)",`
	`127`	`+ self.tr("Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x)"),`
`128`	`128`	`)`
`129`	`129`	`self.setToolTip(`
`130`		`- self.PARAMETERS[6], "Dictates the cost. For longer routes don't use Shortest Path."`
	`130`	`+ self.PARAMETERS[6], self.tr("Dictates the cost. For longer routes don't use Shortest Path.")`
`131`	`131`	`)`
`132`	`132`	`self.setToolTip(`
`133`	`133`	`self.PARAMETERS[7],`
`134`		`- "Either 'row-by-row' until one layers has no more features or 'all-by-all' for every feature combination",`
	`134`	`+ self.tr("Either 'row-by-row' until one layers has no more features or 'all-by-all' for every feature combination"),`
`135`	`135`	`)`
`136`	`136`
`137`	`137`	`# TODO: preprocess parameters to options the range cleanup below:`
Original file line number	Diff line number	Diff line change
`@@ -104,22 +104,22 @@ def __init__(self):`
`104`	`104`	`),`
`105`	`105`	`]`
`106`	`106`
`107`		`- self.setToolTip(self.PARAMETERS[0], "Only Point layers are allowed, not MultiPoint.")`
	`107`	`+ self.setToolTip(self.PARAMETERS[0], self.tr("Only Point layers are allowed, not MultiPoint."))`
`108`	`108`	`self.setToolTip(`
`109`	`109`	`self.PARAMETERS[1],`
`110`		`- "Values will transfer to the output layer and can be used to join layers or group features afterwards.",`
	`110`	`+ self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),`
`111`	`111`	`)`
`112`	`112`	`self.setToolTip(`
`113`	`113`	`self.PARAMETERS[3],`
`114`		`- "Parameter needs to be a comma-separated list of integer values, no decimal points.",`
	`114`	`+ self.tr("Parameter needs to be a comma-separated list of integer values, no decimal points."),`
`115`	`115`	`)`
`116`	`116`	`self.setToolTip(`
`117`	`117`	`self.PARAMETERS[4],`
`118`		`- "Applies a level of generalisation to the isochrone polygons generated as a smoothing_factor between 0 and 100.",`
	`118`	`+ self.tr("Applies a level of generalisation to the isochrone polygons generated as a smoothing_factor between 0 and 100."),`
`119`	`119`	`)`
`120`	`120`	`self.setToolTip(`
`121`	`121`	`self.PARAMETERS[5],`
`122`		`- "Start treats the location(s) as starting point, destination as goal.",`
	`122`	`+ self.tr("Start treats the location(s) as starting point, destination as goal."),`
`123`	`123`	`)`
`124`	`124`
`125`	`125`	`# Save some important references`
Original file line number	Diff line number	Diff line change
`@@ -90,18 +90,18 @@ def __init__(self):`
`90`	`90`	`),`
`91`	`91`	`]`
`92`	`92`
`93`		`- self.setToolTip(self.PARAMETERS[0], "Choose a Point from the map.")`
	`93`	`+ self.setToolTip(self.PARAMETERS[0], self.tr("Choose a Point from the map."))`
`94`	`94`	`self.setToolTip(`
`95`	`95`	`self.PARAMETERS[2],`
`96`		`- "Parameter needs to be a comma-separated list of integer values, no decimal points.",`
	`96`	`+ self.tr("Parameter needs to be a comma-separated list of integer values, no decimal points."),`
`97`	`97`	`)`
`98`	`98`	`self.setToolTip(`
`99`	`99`	`self.PARAMETERS[3],`
`100`		`- "Applies a level of generalisation to the isochrone polygons generated as a smoothing_factor between 0 and 100.",`
	`100`	`+ self.tr("Applies a level of generalisation to the isochrone polygons generated as a smoothing_factor between 0 and 100."),`
`101`	`101`	`)`
`102`	`102`	`self.setToolTip(`
`103`	`103`	`self.PARAMETERS[4],`
`104`		`- "Start treats the location(s) as starting point, destination as goal.",`
	`104`	`+ self.tr("Start treats the location(s) as starting point, destination as goal."),`
`105`	`105`	`)`
`106`	`106`
`107`	`107`	`# Save some important references`
Original file line number	Diff line number	Diff line change
`@@ -82,15 +82,15 @@ def __init__(self):`
`82`	`82`	`),`
`83`	`83`	`]`
`84`	`84`
`85`		`- self.setToolTip(self.PARAMETERS[0], "Only Point layers are allowed, not MultiPoint.")`
	`85`	`+ self.setToolTip(self.PARAMETERS[0], self.tr("Only Point layers are allowed, not MultiPoint."))`
`86`	`86`	`self.setToolTip(`
`87`	`87`	`self.PARAMETERS[1],`
`88`		`- "Values will transfer to the output layer and can be used to join layers or group features afterwards.",`
	`88`	`+ self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),`
`89`	`89`	`)`
`90`	`90`	`self.setToolTip(self.PARAMETERS[2], "Only Point layers are allowed, not MultiPoint.")`
`91`	`91`	`self.setToolTip(`
`92`	`92`	`self.PARAMETERS[3],`
`93`		`- "Values will transfer to the output layer and can be used to join layers or group features afterwards.",`
	`93`	`+ self.tr("Values will transfer to the output layer and can be used to join layers or group features afterwards."),`
`94`	`94`	`)`
`95`	`95`
`96`	`96`	`def processAlgorithm(self, parameters, context, feedback):`