blacklight/platypush
1
0
Fork 0
forked from platypush/platypush
Code Issues Pull requests Projects Releases Packages Wiki Activity

Parse :return: definitions from action docstrings too.

Browse source
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, {} return None, {}
for line in docstring.split('\n'): for line in docstring.split('\n'):
m = re.match(r'^\s*:param ([^:]+):\s*(.*)', line) if m := re.match(r'^\s*:param ([^:]+):\s*(.*)', line):
if m:
if cur_param: if cur_param:
params[cur_param] = cur_param_docstring params[cur_param] = cur_param_docstring
cur_param = m.group(1) cur_param = m.group(1)
cur_param_docstring = m.group(2) 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): elif re.match(r'^\s*:[^:]+:\s*.*', line):
continue continue
else: else:
@ -168,9 +173,9 @@ class ActionModel(Model):
cur_param = None cur_param = None
cur_param_docstring = '' cur_param_docstring = ''
else: else:
cur_param_docstring += '\n' + line.strip() cur_param_docstring += '\n' + line.strip() + ' '
else: else:
new_docstring += line.rstrip() + '\n' new_docstring += line.strip() + ' '
if cur_param: if cur_param:
params[cur_param] = cur_param_docstring params[cur_param] = cur_param_docstring