mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-24 00:47:57 -05:00
87 lines
3.3 KiB
Python
87 lines
3.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
help.py
|
|
---------------------
|
|
Date : March 2013
|
|
Copyright : (C) 2013 by Victor Olaya
|
|
Email : volayaf at gmail dot com
|
|
***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************
|
|
"""
|
|
|
|
__author__ = 'Victor Olaya'
|
|
__date__ = 'March 2013'
|
|
__copyright__ = '(C) 2013, Victor Olaya'
|
|
# This will get replaced with a git SHA1 when you do a git archive
|
|
__revision__ = '$Format:%H$'
|
|
|
|
from processing.core.Processing import Processing
|
|
import os
|
|
from processing.core.ProcessingUtils import mkdir
|
|
from processing.parameters.ParameterSelection import ParameterSelection
|
|
|
|
def createBaseHelpFile(alg, folder):
|
|
folder = os.path.join(folder, alg.provider.getName().lower())
|
|
mkdir(folder)
|
|
cmdLineName = alg.commandLineName()[alg.commandLineName().find(":") + 1:].lower()
|
|
validChars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
|
|
safeFilename = ''.join(c for c in cmdLineName if c in validChars)
|
|
filepath = os.path.join(folder, safeFilename + ".rst")
|
|
file = open(filepath, "w")
|
|
file.write(alg.name.upper())
|
|
file.write("\n")
|
|
file.write("=" * len(alg.name))
|
|
file.write("\n\n")
|
|
file.write("Description\n")
|
|
file.write("-----------\n\n")
|
|
file.write("Parameters\n")
|
|
file.write("----------\n\n")
|
|
for param in alg.parameters:
|
|
file.write("- ``" + param.description + "[" + param.parameterName()[9:] + "]``:\n")
|
|
file.write("\nOutputs\n")
|
|
file.write("-------\n\n")
|
|
for out in alg.outputs:
|
|
file.write("- ``" + out.description + "[" + out.outputTypeName()[6:] + "]``:\n")
|
|
file.write("\nSee also\n")
|
|
file.write("---------\n\n")
|
|
file.write("\nConsole usage\n")
|
|
file.write("-------------\n\n")
|
|
file.write("\n::\n\n")
|
|
s = "\tprocessing.runalg('" + alg.commandLineName() + "', "
|
|
for param in alg.parameters:
|
|
s+= str(param.name.lower().strip()) + ", "
|
|
for out in alg.outputs:
|
|
if not out.hidden:
|
|
s+=str(out.name.lower().strip()) + ", "
|
|
s = s[:-2] +")\n"
|
|
file.write(s)
|
|
|
|
s =""
|
|
hasSelection = False
|
|
for param in alg.parameters:
|
|
if isinstance(param, ParameterSelection):
|
|
hasSelection = True
|
|
s+="\n\t" + param.name.lower() + "(" + param.description + ")\n"
|
|
i=0
|
|
for option in param.options:
|
|
s+= "\t\t" + str(i) + " - " + str(option) + "\n"
|
|
i+=1
|
|
if hasSelection:
|
|
file.write("\n\tAvailable options for selection parameters:\n")
|
|
file.write(s)
|
|
file.close()
|
|
|
|
|
|
def createBaseHelpFiles(folder):
|
|
for provider in Processing.providers:
|
|
for alg in provider.algs:
|
|
createBaseHelpFile(alg, folder)
|