VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2026-01-10 22:12:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'sphinx-class-type' into dotted-docstr-type

Browse Source
This commit is contained in:
Takafumi Arakaki
2013-01-30 21:10:30 +01:00
parent 691177c20c a7131fa949
commit b8f139d574
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
jedi/docstrings.py
View File

@@ -39,12 +39,29 @@ def follow_param(param):
def search_param_in_docstr(docstr, param_str):
"""
Search `docstr` for a type of `param_str`.
>>> search_param_in_docstr(':type param: int', 'param')
'int'
>>> search_param_in_docstr('@type param: int', 'param')
'int'
>>> search_param_in_docstr(
... ':type param: :class:`threading.Thread`', 'param')
'threading.Thread'
>>> search_param_in_docstr('no document', 'param') is None
True
"""
# look at #40 to see definitions of those params
patterns = [ re.compile(p % re.escape(param_str)) for p in DOCSTRING_PARAM_PATTERNS ]
for pattern in patterns:
match = pattern.search(docstr)
if match:
return match.group(1)
type_str = match.group(1)
if type_str.startswith(':class:'):
type_str = type_str[len(':class:'):].strip('`')
return type_str
return None