getdoc():

    Remove leading whitespace from first line; remove leading and
    trailing blank lines from docstrings.  (Patch 645938 submitted
    by David Goodger.)

diff --git a/Lib/inspect.py b/Lib/inspect.py
index 96677b7a2369bcd08f28636e5f29d4c59feee8a1..d3fd3ad195a6346a4cda6e8f4c1def0fa39f2b72 100644 (file)
--- a/Lib/inspect.py
+++ b/Lib/inspect.py
@@ -275,15 +275,23 @@ def getdoc(object):
     except UnicodeError:
         return None
     else:
-        margin = None
+        # Find minimum indentation of any non-blank lines after first line.
+        margin = sys.maxint
         for line in lines[1:]:
             content = len(string.lstrip(line))
-            if not content: continue
-            indent = len(line) - content
-            if margin is None: margin = indent
-            else: margin = min(margin, indent)
-        if margin is not None:
+            if content:
+                indent = len(line) - content
+                margin = min(margin, indent)
+        # Remove indentation.
+        if lines:
+            lines[0] = lines[0].lstrip()
+        if margin < sys.maxint:
             for i in range(1, len(lines)): lines[i] = lines[i][margin:]
+        # Remove any trailing or leading blank lines.
+        while lines and not lines[-1]:
+            lines.pop()
+        while lines and not lines[0]:
+            lines.pop(0)
         return string.join(lines, '\n')
 
 def getfile(object):

diff --git a/Lib/test/test_inspect.py b/Lib/test/test_inspect.py
index ccfba34ea680eec688655a42deabb39353015ac7..d253f26a5fd96f45f451dd0fc54321229f2bbf59 100644 (file)
--- a/Lib/test/test_inspect.py
+++ b/Lib/test/test_inspect.py
@@ -144,7 +144,7 @@ test(inspect.getsource(mod.StupidGit) == sourcerange(21, 46),
 test(inspect.getdoc(mod.StupidGit) ==
      'A longer,\n\nindented\n\ndocstring.', 'getdoc(mod.StupidGit)')
 test(inspect.getdoc(git.abuse) ==
-     'Another\n\ndocstring\n\ncontaining\n\ntabs\n\n', 'getdoc(git.abuse)')
+     'Another\n\ndocstring\n\ncontaining\n\ntabs', 'getdoc(git.abuse)')
 test(inspect.getcomments(mod.StupidGit) == '# line 20\n',
      'getcomments(mod.StupidGit)')