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

Fix an issue with docstrings that contain errors

Browse Source
This commit is contained in:
Dave Halter
2018-03-20 00:56:53 +01:00
parent 305fd66e1c
commit a61742728b
3 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
jedi/evaluate/docstrings.py
View File

@@ -18,7 +18,7 @@ annotations.
import re import re
from textwrap import dedent from textwrap import dedent
from parso import parse from parso import parse, ParserSyntaxError
from jedi._compatibility import u from jedi._compatibility import u
from jedi.evaluate.utils import indent_block from jedi.evaluate.utils import indent_block
@@ -202,7 +202,10 @@ def _evaluate_for_statement_string(module_context, string):
# will be impossible to use `...` (Ellipsis) as a token. Docstring types # will be impossible to use `...` (Ellipsis) as a token. Docstring types
# don't need to conform with the current grammar. # don't need to conform with the current grammar.
grammar = module_context.evaluator.latest_grammar grammar = module_context.evaluator.latest_grammar
module = grammar.parse(code.format(indent_block(string))) try:
module = grammar.parse(code.format(indent_block(string)), error_recovery=False)
except ParserSyntaxError:
return []
try: try:
funcdef = next(module.iter_funcdefs()) funcdef = next(module.iter_funcdefs())
# First pick suite, then simple_stmt and then the node, # First pick suite, then simple_stmt and then the node,

4
jedi/evaluate/syntax_tree.py
View File

@@ -125,7 +125,9 @@ def eval_node(context, element):
# Must be an ellipsis, other operators are not evaluated. # Must be an ellipsis, other operators are not evaluated.
# In Python 2 ellipsis is coded as three single dot tokens, not # In Python 2 ellipsis is coded as three single dot tokens, not
# as one token 3 dot token. # as one token 3 dot token.
assert element.value in ('.', '...'), "The unhandled operator %s" % repr(element.value) if element.value not in ('.', '...'):
origin = element.parent
raise AssertionError("unhandled operator %s in %s " % (repr(element.value), origin))
return ContextSet(compiled.builtin_from_name(evaluator, u'Ellipsis')) return ContextSet(compiled.builtin_from_name(evaluator, u'Ellipsis'))
elif typ == 'dotted_name': elif typ == 'dotted_name':
context_set = eval_atom(context, element.children[0]) context_set = eval_atom(context, element.children[0])

15
test/test_evaluate/test_docstring.py
View File

@@ -196,6 +196,21 @@ def test_numpydoc_parameters_alternative_types():
assert 'append' in names assert 'append' in names
@pytest.mark.skipif(numpydoc_unavailable,
reason='numpydoc module is unavailable')
def test_numpydoc_invalid():
s = dedent('''
def foobar(x, y):
"""
Parameters
----------
x : int (str, py.path.local
"""
x.''')
assert not jedi.Script(s).completions()
@pytest.mark.skipif(numpydoc_unavailable, @pytest.mark.skipif(numpydoc_unavailable,
reason='numpydoc module is unavailable') reason='numpydoc module is unavailable')
def test_numpydoc_returns(): def test_numpydoc_returns():