mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-30 20:31:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

bpo-16355: Clarify when inspect.getcomments() returns None (#428) (#690)

Browse source 
Initial patch by Vajrasky Kok.

(cherry picked from commit 3f2155ffe6)
This commit is contained in:
Berker Peksag 2017-03-17 14:59:16 +03:00 • committed by GitHub
parent 7c2081122c
commit 948171bf99
2 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Doc/library/inspect.rst
View file

@ -442,7 +442,9 @@ Retrieving source code
Return in a single string any lines of comments immediately preceding the
object's source code (for a class, function, or method), or at the top of the
Python source file (if the object is a module).
Python source file (if the object is a module). If the object's source code
is unavailable, return ``None``. This could happen if the object has been
defined in C or the interactive shell.
.. function:: getfile(object)

5
Lib/test/test_inspect.py
View file

@ -387,6 +387,11 @@ class TestRetrievingSourceCode(GetSourceBase):
def test_getcomments(self):
self.assertEqual(inspect.getcomments(mod), '# line 1\n')
self.assertEqual(inspect.getcomments(mod.StupidGit), '# line 20\n')
# If the object source file is not available, return None.
co = compile('x=1', '_non_existing_filename.py', 'exec')
self.assertIsNone(inspect.getcomments(co))
# If the object has been defined in C, return None.
self.assertIsNone(inspect.getcomments(list))
def test_getmodule(self):
# Check actual module