Skip to content

Commit

Permalink
enable custom help in python expressions
Browse files Browse the repository at this point in the history
  • Loading branch information
Gustry authored and m-kuhn committed Aug 23, 2017
1 parent 8a2cf3f commit c606abc
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
2 changes: 1 addition & 1 deletion python/core/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ def referencedColumns(self, node):

helptemplate = string.Template("""<h3>$name function</h3><br>$doc""")
name = kwargs.get('name', function.__name__)
helptext = function.__doc__ or ''
helptext = kwargs.get('helpText') or function.__doc__ or ''
helptext = helptext.strip()
expandargs = False

Expand Down
23 changes: 23 additions & 0 deletions tests/src/python/test_qgsexpression.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,18 @@ def special(values, feature, parent):
def sqrt(values, feature, parent):
pass

@qgsfunction(1, 'testing', register=False)
def help_with_docstring(values, feature, parent):
"""The help comes from the python docstring."""
pass

help_text = 'The help comes from a variable.'

@qgsfunction(1, 'testing', register=False, helpText=help_text)
def help_with_variable(values, feature, parent):
"""This docstring is not used for the help."""
pass

@qgsfunction(1, 'testing', register=False, usesgeometry=True)
def geomtest(values, feature, parent):
pass
Expand All @@ -68,6 +80,17 @@ def testAutoCountsCorrectArgs(self):
args = function.params()
self.assertEqual(args, 3)

def testHelp(self):
QgsExpression.registerFunction(self.help_with_variable)
html = ('<h3>help_with_variable function</h3><br>'
'The help comes from a variable.')
self.assertEqual(self.help_with_variable.helpText(), html)

QgsExpression.registerFunction(self.help_with_docstring)
html = ('<h3>help_with_docstring function</h3><br>'
'The help comes from the python docstring.')
self.assertEqual(self.help_with_docstring.helpText(), html)

def testAutoArgsAreExpanded(self):
function = self.expandargs
args = function.params()
Expand Down

0 comments on commit c606abc

Please sign in to comment.