summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Bussonnier <bussonniermatthias@gmail.com>2017-02-23 22:44:19 -0800
committerINADA Naoki <methane@users.noreply.github.com>2017-02-24 15:44:19 +0900
commit41cea70aa38de50c1d714209aa2b7694d86a7e0c (patch)
tree827564c200fe9efdb2fc2545e912018c311a378f
parent357bad7101df196d7f4ea3dc6ed9a6436afb022c (diff)
downloadcpython-git-41cea70aa38de50c1d714209aa2b7694d86a7e0c.tar.gz
bpo-29637: clean docstring only if not None (GH-267)
-rw-r--r--Lib/ast.py5
-rw-r--r--Lib/test/test_ast.py1
2 files changed, 5 insertions, 1 deletions
diff --git a/Lib/ast.py b/Lib/ast.py
index 0729ee71af..070c2bee7f 100644
--- a/Lib/ast.py
+++ b/Lib/ast.py
@@ -194,11 +194,14 @@ def get_docstring(node, clean=True):
Return the docstring for the given node or None if no docstring can
be found. If the node provided does not have docstrings a TypeError
will be raised.
+
+ If *clean* is `True`, all tabs are expanded to spaces and any whitespace
+ that can be uniformly removed from the second line onwards is removed.
"""
if not isinstance(node, (AsyncFunctionDef, FunctionDef, ClassDef, Module)):
raise TypeError("%r can't have docstrings" % node.__class__.__name__)
text = node.docstring
- if clean:
+ if clean and text:
import inspect
text = inspect.cleandoc(text)
return text
diff --git a/Lib/test/test_ast.py b/Lib/test/test_ast.py
index 366269fe40..2f59527cb8 100644
--- a/Lib/test/test_ast.py
+++ b/Lib/test/test_ast.py
@@ -532,6 +532,7 @@ class ASTHelpers_Test(unittest.TestCase):
node = ast.parse('async def foo():\n """spam\n ham"""')
self.assertEqual(ast.get_docstring(node.body[0]), 'spam\nham')
+ self.assertIsNone(ast.get_docstring(ast.parse('')))
def test_literal_eval(self):
self.assertEqual(ast.literal_eval('[1, 2, 3]'), [1, 2, 3])