VimPlug/jedi-fork
1
0
Fork 0
forked from VimPlug/jedi
Code Pull Requests Activity

Support for Epydoc format in docstrings

Browse Source
This commit is contained in:
Yakov Borevich
2012-12-26 21:18:06 +04:00
parent e94376095f
commit 46a3ecc7d8
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
jedi/docstrings.py
View File

@@ -5,6 +5,11 @@ import re
import evaluate import evaluate
import parsing import parsing
DOCSTRING_PARAM_PATTERNS = [
r'\s*:type\s+%s:\s*([\d\w_]+)', # Sphinx
r'\s*@type\s+%s:\s*([\d\w_]+)', # Epidoc
r'\s*%s\s+\(([^()]+)\)' # googley
]
#@cache.memoize_default() # TODO add #@cache.memoize_default() # TODO add
def follow_param(param): def follow_param(param):
@@ -21,15 +26,12 @@ def follow_param(param):
def search_param_in_docstr(docstr, param_str): def search_param_in_docstr(docstr, param_str):
lines = docstr.split('\n') lines = docstr.split('\n')
# look at #40 to see definitions of those params # look at #40 to see definitions of those params
sphinx_comp = ':type %s:' % param_str patterns = [ re.compile(p % re.escape(param_str)) for p in DOCSTRING_PARAM_PATTERNS ]
googley_comp = re.compile('\s*%s\s+\(([^()]+)\)' % re.escape(param_str))
for l in lines: for l in lines:
if l.startswith(sphinx_comp): for pattern in patterns:
return l.replace(sphinx_comp, '', 1).strip() match = pattern.match(l)
if match:
return match.group(1)
r = re.match(googley_comp, l)
if r is not None:
return r.group(1)
return None return None