VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-07 14:34:31 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix keyword docstring

Browse Source
This commit is contained in:
micbou
2017-07-12 21:34:39 +02:00
committed by Dave Halter
parent 9fb7fb66da
commit f5248250d8
2 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
jedi/api/keywords.py
View File

@@ -76,12 +76,16 @@ class KeywordName(AbstractNameDefinition):
api_type = 'keyword' api_type = 'keyword'
def __init__(self, evaluator, name): def __init__(self, evaluator, name):
self.evaluator = evaluator
self.string_name = name self.string_name = name
self.parent_context = evaluator.BUILTINS self.parent_context = evaluator.BUILTINS
def eval(self): def eval(self):
return set() return set()
def infer(self):
return [Keyword(self.evaluator, self.string_name, (0, 0))]
class Keyword(object): class Keyword(object):
api_type = 'keyword' api_type = 'keyword'
@@ -100,9 +104,8 @@ class Keyword(object):
""" For a `parsing.Name` like comparision """ """ For a `parsing.Name` like comparision """
return [self.name] return [self.name]
@property def py__doc__(self, include_call_signature=False):
def docstr(self): return imitate_pydoc(self.name.string_name)
return imitate_pydoc(self.name)
def __repr__(self): def __repr__(self):
return '<%s: %s>' % (type(self).__name__, self.name) return '<%s: %s>' % (type(self).__name__, self.name)
@@ -136,6 +139,6 @@ def imitate_pydoc(string):
return '' return ''
try: try:
return pydoc_topics.topics[label] if pydoc_topics else '' return pydoc_topics.topics[label].strip() if pydoc_topics else ''
except KeyError: except KeyError:
return '' return ''

10
test/test_evaluate/test_docstring.py
View File

@@ -20,7 +20,7 @@ class TestDocstring(unittest.TestCase):
def func(): def func():
'''Docstring of `func`.''' '''Docstring of `func`.'''
func""").goto_definitions() func""").goto_definitions()
self.assertEqual(defs[0].raw_doc, 'Docstring of `func`.') self.assertEqual(defs[0].docstring(), 'func()\n\nDocstring of `func`.')
@unittest.skip('need evaluator class for that') @unittest.skip('need evaluator class for that')
def test_attribute_docstring(self): def test_attribute_docstring(self):
@@ -28,7 +28,7 @@ class TestDocstring(unittest.TestCase):
x = None x = None
'''Docstring of `x`.''' '''Docstring of `x`.'''
x""").goto_definitions() x""").goto_definitions()
self.assertEqual(defs[0].raw_doc, 'Docstring of `x`.') self.assertEqual(defs[0].docstring(), 'Docstring of `x`.')
@unittest.skip('need evaluator class for that') @unittest.skip('need evaluator class for that')
def test_multiple_docstrings(self): def test_multiple_docstrings(self):
@@ -38,7 +38,7 @@ class TestDocstring(unittest.TestCase):
x = func x = func
'''Docstring of `x`.''' '''Docstring of `x`.'''
x""").goto_definitions() x""").goto_definitions()
docs = [d.raw_doc for d in defs] docs = [d.docstring() for d in defs]
self.assertEqual(docs, ['Original docstring.', 'Docstring of `x`.']) self.assertEqual(docs, ['Original docstring.', 'Docstring of `x`.'])
def test_completion(self): def test_completion(self):
@@ -105,6 +105,10 @@ class TestDocstring(unittest.TestCase):
assert '__init__' in names assert '__init__' in names
assert 'mro' not in names # Exists only for types. assert 'mro' not in names # Exists only for types.
def test_docstring_keyword(self):
completions = jedi.Script('assert').completions()
self.assertIn('assert', completions[0].docstring())
@unittest.skipIf(numpydoc_unavailable, 'numpydoc module is unavailable') @unittest.skipIf(numpydoc_unavailable, 'numpydoc module is unavailable')
def test_numpydoc_docstring(self): def test_numpydoc_docstring(self):
s = dedent(''' s = dedent('''