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

[processing][API] rename alglist() to printAlgorithms() to improve

Browse Source 
readability. Also introduce algorithmsList() call which returns
available Processing algorithms as list
This commit is contained in:
Alexander Bruy 2017-03-22 19:03:36 +02:00
parent c1e6ba0f40
commit e1a01106dd
1 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
python/plugins/processing/tools/general.py
View File

@ -41,18 +41,38 @@ from processing.core.parameters import ParameterSelection
from processing.gui.Postprocessing import handleAlgorithmResults from processing.gui.Postprocessing import handleAlgorithmResults
def alglist(text=None): def algorithmsList(text=None):
"""Returns list of all available Processing algorithms or list
of algorithms which names contains given text.
Returned list contains algorithm command-line names.
"""
lst = []
for provider in list(algList.algs.values()):
sortedlist = sorted(list(provider.values()), key=lambda alg: alg.name)
for alg in sortedlist:
if text is None or text.lower() in alg.name.lower():
lst.append(alg.commandLineName())
return lst
def printAlgorithms(text=None):
"""Print list of all available Processing algorithms or list
of algorithms which names contains given text.
Prints algorithms user-friendly names as well as command-line
names.
"""
s = '' s = ''
for provider in list(algList.algs.values()): for provider in list(algList.algs.values()):
sortedlist = sorted(list(provider.values()), key=lambda alg: alg.name) sortedlist = sorted(list(provider.values()), key=lambda alg: alg.name)
for alg in sortedlist: for alg in sortedlist:
if text is None or text.lower() in alg.name.lower(): if text is None or text.lower() in alg.name.lower():
s += alg.name.ljust(50, '-') + '--->' + alg.commandLineName() \ s += '{}--->{}\n'.format(alg.name.ljust(50, '-'), alg.commandLineName())
+ '\n'
print(s) print(s)
def algorithmOptions(name): def algorithmOptions(name):
"""Prints all algorithm options with their values.
"""
alg = Processing.getAlgorithm(name) alg = Processing.getAlgorithm(name)
if alg is not None: if alg is not None:
opts = '' opts = ''
@ -67,6 +87,9 @@ def algorithmOptions(name):
def algorithmHelp(name): def algorithmHelp(name):
"""Prints algorithm parameters with their types. Also
provides information about options if any.
"""
alg = Processing.getAlgorithm(name) alg = Processing.getAlgorithm(name)
if alg is not None: if alg is not None:
alg = alg.getCopy() alg = alg.getCopy()
@ -77,12 +100,18 @@ def algorithmHelp(name):
def runalg(algOrName, *args, **kwargs): def runalg(algOrName, *args, **kwargs):
"""Executes given algorithm and returns its outputs as dictionary
object.
"""
alg = Processing.runAlgorithm(algOrName, None, *args, **kwargs) alg = Processing.runAlgorithm(algOrName, None, *args, **kwargs)
if alg is not None: if alg is not None:
return alg.getOutputValuesAsDictionary() return alg.getOutputValuesAsDictionary()
def runandload(name, *args, **kwargs): def runandload(name, *args, **kwargs):
"""Executes given algorithm and load its results into QGIS project
when possible.
"""
return Processing.runAlgorithm(name, handleAlgorithmResults, *args, **kwargs) return Processing.runAlgorithm(name, handleAlgorithmResults, *args, **kwargs)