Apr 18, 2020 · Nov 3, 2018 · Nov 3, 2018 · Nov 3, 2018 · Nov 3, 2018 · Nov 3, 2018
diff --git a/Lib/inspect.py b/Lib/inspect.py
              'Yury Selivanov <yselivanov@sprymix.com>')

 import abc
 import ast
 import dis
 import collections.abc
 import enum
        if builtinobject is object:
            return builtin


 class ClassFoundException(Exception):
    pass


 class _ClassFinder(ast.NodeVisitor):

    def __init__(self, qualname):
        self.stack = []
        self.qualname = qualname

    def visit_FunctionDef(self, node):
        self.stack.append(node.name)
        self.stack.append('<locals>')
        self.generic_visit(node)
        self.stack.pop()
        self.stack.pop()

    visit_AsyncFunctionDef = visit_FunctionDef

    def visit_ClassDef(self, node):
        self.stack.append(node.name)
        if self.qualname == '.'.join(self.stack):
            # Return the decorator for the class if present
            if node.decorator_list:
                line_number = node.decorator_list[0].lineno
            else:
                line_number = node.lineno

            # decrement by one since lines starts with indexing by zero
            line_number -= 1
            raise ClassFoundException(line_number)
        self.generic_visit(node)
        self.stack.pop()


 def findsource(object):
    """Return the entire source file and starting line number for an object.

        return lines, 0

    if isclass(object):
        name = object.__name__
        pat = re.compile(r'^(\s*)class\s*' + name + r'\b')
        # make some effort to find the best matching class definition:
        # use the one with the least indentation, which is the one
        # that's most probably not inside a function definition.
        candidates = []
        for i in range(len(lines)):
            match = pat.match(lines[i])
            if match:
                # if it's at toplevel, it's already the best one
                if lines[i][0] == 'c':
                    return lines, i
                # else add whitespace to candidate list
                candidates.append((match.group(1), i))
        if candidates:
            # this will sort by whitespace, and by line number,
            # less whitespace first
            candidates.sort()
            return lines, candidates[0][1]
        qualname = object.__qualname__
        source = ''.join(lines)
        tree = ast.parse(source)
        class_finder = _ClassFinder(qualname)
        try:
            class_finder.visit(tree)
        except ClassFoundException as e:
            line_number = e.args[0]
            return lines, line_number
        else:
            raise OSError('could not find class definition')

diff --git a/Lib/test/inspect_fodder2.py b/Lib/test/inspect_fodder2.py
            never_reached1
            never_reached2

 #line 141
 # line 141
 class cls142:
    a = """
 class cls149:
    ...
 """

 # line 148
 class cls149:

    def func151(self):
        pass

 '''
 class cls160:
    pass
 '''

 # line 159
 class cls160:

    def func162(self):
        pass

 # line 165
 class cls166:
    a = '''
    class cls175:
        ...
    '''

 # line 172
 class cls173:

    class cls175:
        pass

 # line 178
 class cls179:
    pass

 # line 182
 class cls183:

    class cls185:

        def func186(self):
            pass

 def class_decorator(cls):
    return cls

 # line 193
 @class_decorator
 @class_decorator
 class cls196:

    @class_decorator
    @class_decorator
    class cls200:
        pass

 class cls203:
    class cls204:
        class cls205:
            pass
    class cls207:
        class cls205:
            pass

 # line 211
 def func212():
    class cls213:
        pass
    return cls213

 # line 217
 class cls213:
    def func219(self):
        class cls220:
            pass
        return cls220

 # line 224
 async def func225():
    class cls226:
        pass
    return cls226

 # line 230
 class cls226:
    async def func232(self):
        class cls233:
            pass
        return cls233

 if True:
    class cls238:
        class cls239:
            '''if clause cls239'''
 else:
    class cls238:
        class cls239:
            '''else clause 239'''
            pass

 #line 247
 def positional_only_arg(a, /):
    pass

 #line145
 #line251
 def all_markers(a, b, /, c, d, *, e, f):
    pass

 # line149
 # line255
 def all_markers_with_args_and_kwargs(a, b, /, c, d, *args, e, f, **kwargs):
    pass

 #line153
 #line259
 def all_markers_with_defaults(a, b=1, /, c=2, d=3, *, e=4, f=5):
    pass
diff --git a/Lib/test/test_inspect.py b/Lib/test/test_inspect.py
    def test_getcomments(self):
        self.assertEqual(inspect.getcomments(mod), '# line 1\n')
        self.assertEqual(inspect.getcomments(mod.StupidGit), '# line 20\n')
        self.assertEqual(inspect.getcomments(mod2.cls160), '# line 159\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))
    def test_nested_func(self):
        self.assertSourceEqual(mod2.cls135.func136, 136, 139)

    def test_class_definition_in_multiline_string_definition(self):
        self.assertSourceEqual(mod2.cls149, 149, 152)

    def test_class_definition_in_multiline_comment(self):
        self.assertSourceEqual(mod2.cls160, 160, 163)

    def test_nested_class_definition_indented_string(self):
        self.assertSourceEqual(mod2.cls173.cls175, 175, 176)

    def test_nested_class_definition(self):
        self.assertSourceEqual(mod2.cls183, 183, 188)
        self.assertSourceEqual(mod2.cls183.cls185, 185, 188)

    def test_class_decorator(self):
        self.assertSourceEqual(mod2.cls196, 194, 201)
        self.assertSourceEqual(mod2.cls196.cls200, 198, 201)

    def test_class_inside_conditional(self):
        self.assertSourceEqual(mod2.cls238, 238, 240)
        self.assertSourceEqual(mod2.cls238.cls239, 239, 240)

    def test_multiple_children_classes(self):
        self.assertSourceEqual(mod2.cls203, 203, 209)
        self.assertSourceEqual(mod2.cls203.cls204, 204, 206)
        self.assertSourceEqual(mod2.cls203.cls204.cls205, 205, 206)
        self.assertSourceEqual(mod2.cls203.cls207, 207, 209)
        self.assertSourceEqual(mod2.cls203.cls207.cls205, 208, 209)

    def test_nested_class_definition_inside_function(self):
        self.assertSourceEqual(mod2.func212(), 213, 214)
        self.assertSourceEqual(mod2.cls213, 218, 222)
        self.assertSourceEqual(mod2.cls213().func219(), 220, 221)

    def test_nested_class_definition_inside_async_function(self):
        import asyncio
        self.addCleanup(asyncio.set_event_loop_policy, None)
        self.assertSourceEqual(asyncio.run(mod2.func225()), 226, 227)
        self.assertSourceEqual(mod2.cls226, 231, 235)
        self.assertSourceEqual(asyncio.run(mod2.cls226().func232()), 233, 234)

 class TestNoEOL(GetSourceBase):
    def setUp(self):
diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py
    def test_non_str_name(self):
        # issue14638
        # Treat illegal (non-str) name like no name

        class A:
            __name__ = 42
        class B:
diff --git a/Misc/NEWS.d/next/Library/2018-11-03-16-18-20.bpo-35113.vwvWKG.rst b/Misc/NEWS.d/next/Library/2018-11-03-16-18-20.bpo-35113.vwvWKG.rst
 :meth:`inspect.getsource` now returns correct source code for inner class
 with same name as module level class. Decorators are also returned as part
 of source of the class. Patch by Karthikeyan Singaravelan.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -32,6 +32,7 @@
		'Yury Selivanov <yselivanov@sprymix.com>')

		import abc
		import ast
		import dis
		import collections.abc
		import enum
Expand DownExpand Up		@@ -770,6 +771,42 @@ def getmodule(object, _filename=None):
		if builtinobject is object:
		return builtin


		class ClassFoundException(Exception):
		pass


		class _ClassFinder(ast.NodeVisitor):

		def __init__(self, qualname):
		self.stack = []
		self.qualname = qualname

		def visit_FunctionDef(self, node):
		self.stack.append(node.name)
		self.stack.append('<locals>')
		self.generic_visit(node)
		self.stack.pop()
		self.stack.pop()

		visit_AsyncFunctionDef = visit_FunctionDef

		def visit_ClassDef(self, node):
		self.stack.append(node.name)
		if self.qualname == '.'.join(self.stack):
		# Return the decorator for the class if present
		if node.decorator_list:
		line_number = node.decorator_list[0].lineno
		else:
		line_number = node.lineno

		# decrement by one since lines starts with indexing by zero
		line_number -= 1
		raise ClassFoundException(line_number)
		self.generic_visit(node)
		self.stack.pop()


		def findsource(object):
		"""Return the entire source file and starting line number for an object.

Expand DownExpand Up		@@ -802,25 +839,15 @@ def findsource(object):
		return lines, 0

		if isclass(object):
		name = object.__name__
		pat = re.compile(r'^(\s)class\s' + name + r'\b')
		# make some effort to find the best matching class definition:
		# use the one with the least indentation, which is the one
		# that's most probably not inside a function definition.
		candidates = []
		for i in range(len(lines)):
		match = pat.match(lines[i])
		if match:
		# if it's at toplevel, it's already the best one
		if lines[i][0] == 'c':
		return lines, i
		# else add whitespace to candidate list
		candidates.append((match.group(1), i))
		if candidates:
		# this will sort by whitespace, and by line number,
		# less whitespace first
		candidates.sort()
		return lines, candidates[0][1]
		qualname = object.__qualname__
		source = ''.join(lines)
		tree = ast.parse(source)
		class_finder = _ClassFinder(qualname)
		try:
		class_finder.visit(tree)
		except ClassFoundException as e:
		line_number = e.args[0]
		return lines, line_number
		else:
		raise OSError('could not find class definition')

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -138,18 +138,124 @@ def func137():
		never_reached1
		never_reached2

		#line 141
		# line 141
		class cls142:
		a = """
		class cls149:
		...
		"""

		# line 148
		class cls149:

		def func151(self):
		pass

		'''
		class cls160:
		pass
		'''

		# line 159
		class cls160:

		def func162(self):
		pass

		# line 165
		class cls166:
		a = '''
		class cls175:
		...
		'''

		# line 172
		class cls173:

		class cls175:
		pass

		# line 178
		class cls179:
		pass

		# line 182
		class cls183:

		class cls185:

		def func186(self):
		pass

		def class_decorator(cls):
		return cls

		# line 193
		@class_decorator
		@class_decorator
		class cls196:

		@class_decorator
		@class_decorator
		class cls200:
		pass

		class cls203:
		class cls204:
		class cls205:
		pass
		class cls207:
		class cls205:
		pass

		# line 211
		def func212():
		class cls213:
		pass
		return cls213

		# line 217
		class cls213:
Copy link Member matrixiseNov 4, 2018 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. should be`cls218` Copy link MemberAuthor tirkarthiNov 4, 2018 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. This to check that the inner class which has the same name`cls213` inside`func212` doesn't conflict with this class`cls213`. Previously regex was used and hence there were cases where two classes with same name defined under different scopes might conflict with each other returning wrong results. serhiy-storchaka reacted with thumbs up emoji
		def func219(self):
		class cls220:
		pass
		return cls220

		# line 224
		async def func225():
		class cls226:
		pass
		return cls226

		# line 230
		class cls226:
Copy link Member matrixiseNov 4, 2018 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. should be`cls231` Copy link MemberAuthor tirkarthiNov 4, 2018 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Same as my above comment but this is to check for`async def` related code. This to check that the inner class which has the same name`cls226` inside`func225` doesn't conflict with this class`cls226`. Previously regex was used and hence there were cases where two classes with same name defined under different scopes might conflict with each other returning wrong results. serhiy-storchaka reacted with thumbs up emoji
		async def func232(self):
		class cls233:
		pass
		return cls233

		if True:
		class cls238:
		class cls239:
		'''if clause cls239'''
		else:
		class cls238:
		class cls239:
		'''else clause 239'''
		pass

		#line 247
		def positional_only_arg(a, /):
		pass

		#line145
		#line251
		def all_markers(a, b, /, c, d, *, e, f):
		pass

		# line149
		# line255
		def all_markers_with_args_and_kwargs(a, b, /, c, d, args, e, f, *kwargs):
		pass

		#line153
		#line259
		def all_markers_with_defaults(a, b=1, /, c=2, d=3, *, e=4, f=5):
		pass
Original file line number	Diff line number	Diff line change
Expand Up		@@ -473,6 +473,7 @@ def test_cleandoc(self):
		def test_getcomments(self):
		self.assertEqual(inspect.getcomments(mod), '# line 1\n')
		self.assertEqual(inspect.getcomments(mod.StupidGit), '# line 20\n')
		self.assertEqual(inspect.getcomments(mod2.cls160), '# line 159\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))
Expand DownExpand Up		@@ -709,6 +710,45 @@ def test_getsource_on_method(self):
		def test_nested_func(self):
		self.assertSourceEqual(mod2.cls135.func136, 136, 139)

		def test_class_definition_in_multiline_string_definition(self):
		self.assertSourceEqual(mod2.cls149, 149, 152)

		def test_class_definition_in_multiline_comment(self):
		self.assertSourceEqual(mod2.cls160, 160, 163)

		def test_nested_class_definition_indented_string(self):
		self.assertSourceEqual(mod2.cls173.cls175, 175, 176)

		def test_nested_class_definition(self):
		self.assertSourceEqual(mod2.cls183, 183, 188)
		self.assertSourceEqual(mod2.cls183.cls185, 185, 188)

		def test_class_decorator(self):
		self.assertSourceEqual(mod2.cls196, 194, 201)
		self.assertSourceEqual(mod2.cls196.cls200, 198, 201)

		def test_class_inside_conditional(self):
		self.assertSourceEqual(mod2.cls238, 238, 240)
		self.assertSourceEqual(mod2.cls238.cls239, 239, 240)

		def test_multiple_children_classes(self):
		self.assertSourceEqual(mod2.cls203, 203, 209)
		self.assertSourceEqual(mod2.cls203.cls204, 204, 206)
		self.assertSourceEqual(mod2.cls203.cls204.cls205, 205, 206)
		self.assertSourceEqual(mod2.cls203.cls207, 207, 209)
		self.assertSourceEqual(mod2.cls203.cls207.cls205, 208, 209)

		def test_nested_class_definition_inside_function(self):
		self.assertSourceEqual(mod2.func212(), 213, 214)
		self.assertSourceEqual(mod2.cls213, 218, 222)
		self.assertSourceEqual(mod2.cls213().func219(), 220, 221)

		def test_nested_class_definition_inside_async_function(self):
		import asyncio
		self.addCleanup(asyncio.set_event_loop_policy, None)
		self.assertSourceEqual(asyncio.run(mod2.func225()), 226, 227)
		self.assertSourceEqual(mod2.cls226, 231, 235)
		self.assertSourceEqual(asyncio.run(mod2.cls226().func232()), 233, 234)

		class TestNoEOL(GetSourceBase):
		def setUp(self):
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -476,6 +476,7 @@ def test_getpager_with_stdin_none(self):
		def test_non_str_name(self):
		# issue14638
		# Treat illegal (non-str) name like no name

		class A:
		__name__ = 42
		class B:
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		:meth:`inspect.getsource` now returns correct source code for inner class
		with same name as module level class. Decorators are also returned as part
		of source of the class. Patch by Karthikeyan Singaravelan.