platypush/platypush
platypush/platypush
2
2
Fork 4
Code Issues 30 Pull requests Projects 4 Releases Packages Wiki Activity

Skip :type: annotations from docstring args documentation.

Browse source
This commit is contained in:
Fabio Manganiello 2023-08-07 10:07:55 +02:00
parent 2a30f060b4
commit 9beb0a7af3
Signed by: blacklight
GPG key ID: D90FBA7F76362774
1 changed files with 15 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
platypush/plugins/inspect/_model.py
View file

@ -34,6 +34,10 @@ class Model:
SchemaParser, SchemaParser,
] ]
_param_docstring_re = re.compile(r'^\s*:param ([^:]+):\s*(.*)')
_type_docstring_re = re.compile(r'^\s*:type ([^:]+):\s*(.*)')
_return_docstring_re = re.compile(r'^\s*:return:\s+(.*)')
def __init__( def __init__(
self, self,
obj_type: type, obj_type: type,
@ -106,7 +110,7 @@ class 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) m = cls._param_docstring_re.match(line)
if m: if m:
if cur_param: if cur_param:
params[cur_param] = cur_param_docstring params[cur_param] = cur_param_docstring
@ -115,7 +119,16 @@ class Model:
cur_param_docstring = m.group(2) cur_param_docstring = m.group(2)
continue continue
m = re.match(r'^\s*:return:\s+(.*)', line) m = cls._type_docstring_re.match(line)
if m:
if cur_param:
cur_param_docstring += '\n**Type:** ' + m.group(2).strip()
params[cur_param] = cur_param_docstring
cur_param = None
continue
m = cls._return_docstring_re.match(line)
if m: if m:
if cur_param: if cur_param:
params[cur_param] = cur_param_docstring params[cur_param] = cur_param_docstring