platypush/platypush
platypush
/
platypush
2
2
Fork 4
Code Issues 44 Pull Requests Packages Projects 4 Releases Wiki Activity

Parse `:return:` definitions from action docstrings too.

This commit is contained in:
Fabio Manganiello 2023-05-21 03:05:19 +02:00
parent 229b8f2985
commit b91c1eba6d
Signed by: blacklight
GPG Key ID: D90FBA7F76362774
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
platypush/plugins/inspect/_model.py
View File

@ -152,13 +152,18 @@ class ActionModel(Model):
return None, {}
for line in docstring.split('\n'):
m = re.match(r'^\s*:param ([^:]+):\s*(.*)', line)
if m:
if m := re.match(r'^\s*:param ([^:]+):\s*(.*)', line):
if cur_param:
params[cur_param] = cur_param_docstring
cur_param = m.group(1)
cur_param_docstring = m.group(2)
elif m := re.match(r'^\s*:return:\s+(.*)', line):
if cur_param:
params[cur_param] = cur_param_docstring
new_docstring += '\n\n**Returns:**\n\n' + m.group(1).strip() + ' '
cur_param = None
elif re.match(r'^\s*:[^:]+:\s*.*', line):
continue
else:
@ -168,9 +173,9 @@ class ActionModel(Model):
cur_param = None
cur_param_docstring = ''
else:
cur_param_docstring += '\n' + line.strip()
cur_param_docstring += '\n' + line.strip() + ' '
else:
new_docstring += line.rstrip() + '\n'
new_docstring += line.strip() + ' '
if cur_param:
params[cur_param] = cur_param_docstring