diff options
| -rw-r--r-- | Lib/ast.py | 4 | ||||
| -rw-r--r-- | Lib/test/test_ast.py | 31 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Library/2018-06-13-15-12-25.bpo-33851.SVbqlz.rst | 1 |
3 files changed, 34 insertions, 2 deletions
@@ -206,7 +206,7 @@ def get_docstring(node, clean=True): """ if not isinstance(node, (AsyncFunctionDef, FunctionDef, ClassDef, Module)): raise TypeError("%r can't have docstrings" % node.__class__.__name__) - if not node.body: + if not(node.body and isinstance(node.body[0], Expr)): return None node = node.body[0].value if isinstance(node, Str): @@ -215,7 +215,7 @@ def get_docstring(node, clean=True): text = node.value else: return None - if clean and text: + if clean: import inspect text = inspect.cleandoc(text) return text diff --git a/Lib/test/test_ast.py b/Lib/test/test_ast.py index ab32d9d..7db40e7 100644 --- a/Lib/test/test_ast.py +++ b/Lib/test/test_ast.py @@ -521,13 +521,44 @@ class ASTHelpers_Test(unittest.TestCase): ) def test_get_docstring(self): + node = ast.parse('"""line one\n line two"""') + self.assertEqual(ast.get_docstring(node), + 'line one\nline two') + + node = ast.parse('class foo:\n """line one\n line two"""') + self.assertEqual(ast.get_docstring(node.body[0]), + 'line one\nline two') + node = ast.parse('def foo():\n """line one\n line two"""') self.assertEqual(ast.get_docstring(node.body[0]), 'line one\nline two') node = ast.parse('async def foo():\n """spam\n ham"""') self.assertEqual(ast.get_docstring(node.body[0]), 'spam\nham') + + def test_get_docstring_none(self): self.assertIsNone(ast.get_docstring(ast.parse(''))) + node = ast.parse('x = "not docstring"') + self.assertIsNone(ast.get_docstring(node)) + node = ast.parse('def foo():\n pass') + self.assertIsNone(ast.get_docstring(node)) + + node = ast.parse('class foo:\n pass') + self.assertIsNone(ast.get_docstring(node.body[0])) + node = ast.parse('class foo:\n x = "not docstring"') + self.assertIsNone(ast.get_docstring(node.body[0])) + node = ast.parse('class foo:\n def bar(self): pass') + self.assertIsNone(ast.get_docstring(node.body[0])) + + node = ast.parse('def foo():\n pass') + self.assertIsNone(ast.get_docstring(node.body[0])) + node = ast.parse('def foo():\n x = "not docstring"') + self.assertIsNone(ast.get_docstring(node.body[0])) + + node = ast.parse('async def foo():\n pass') + self.assertIsNone(ast.get_docstring(node.body[0])) + node = ast.parse('async def foo():\n x = "not docstring"') + self.assertIsNone(ast.get_docstring(node.body[0])) def test_literal_eval(self): self.assertEqual(ast.literal_eval('[1, 2, 3]'), [1, 2, 3]) diff --git a/Misc/NEWS.d/next/Library/2018-06-13-15-12-25.bpo-33851.SVbqlz.rst b/Misc/NEWS.d/next/Library/2018-06-13-15-12-25.bpo-33851.SVbqlz.rst new file mode 100644 index 0000000..b769ff7 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2018-06-13-15-12-25.bpo-33851.SVbqlz.rst @@ -0,0 +1 @@ +Fix :func:`ast.get_docstring` for a node that lacks a docstring. |