Fix referenced inherited methods

Author: hasier

aws_xray_sdk/core/patcher.py

@@ -50,7 +50,9 @@ def _is_valid_import(module):
         is_module = os.path.isdir(realpath) and (
             os.path.isfile('{}/__init__.py'.format(module)) or os.path.isfile('{}/__init__.pyc'.format(module))
         )
-        is_file = os.path.isfile('{}.py'.format(module)) or os.path.isfile('{}.pyc'.format(module))
+        is_file = not is_module and (
+                os.path.isfile('{}.py'.format(module)) or os.path.isfile('{}.pyc'.format(module))
+        )
         return is_module or is_file
 
 
@@ -113,6 +115,10 @@ def _patch(module_to_patch):
 
 
 def _patch_func(parent, func_name, func, modifier=lambda x: x):
+    if func_name not in parent.__dict__:
+        # Ignore functions not directly defined in parent, i.e. exclude inherited ones
+        return
+
     from aws_xray_sdk.core import xray_recorder
 
     capture_name = func_name
@@ -129,12 +135,12 @@ def _patch_class(module, cls):
 
     for member_name, member in inspect.getmembers(cls, inspect.ismethod):
         if member.__module__ == module.__name__:
-            # Only patch methods of the class defined in the module, ignore inherited
+            # Only patch methods of the class defined in the module, ignore other modules
             _patch_func(cls, member_name, member)
 
     for member_name, member in inspect.getmembers(cls, inspect.isfunction):
         if member.__module__ == module.__name__:
-            # Only patch static methods of the class defined in the module, ignore inherited
+            # Only patch static methods of the class defined in the module, ignore other modules
             if is_instance_method(cls, member_name, member):
                 _patch_func(cls, member_name, member)
             else:

aws_xray_sdk/core/utils/compat.py

@@ -1,3 +1,4 @@
+import inspect
 import sys
 
 
@@ -13,4 +14,14 @@
 
 
 def is_instance_method(parent_class, func_name, func):
-    return getattr(func, '__self__', None) is None and not isinstance(parent_class.__dict__[func_name], staticmethod)
+    try:
+        func_from_dict = parent_class.__dict__[func_name]
+    except KeyError:
+        for base in inspect.getmro(parent_class):
+            if func_name in base.__dict__:
+                func_from_dict = base.__dict__[func_name]
+                break
+        else:
+            return True
+
+    return getattr(func, '__self__', None) is None and not isinstance(func_from_dict, staticmethod)

tests/mock_module/mock_submodule/mock_subfile.py

@@ -24,3 +24,11 @@ def mock_classmethod(cls):
     @staticmethod
     def mock_staticmethod():
         pass
+
+
+class MockSubclass(MockClass):
+    def __init__(self):
+        super(MockSubclass, self).__init__()
+
+    def mock_submethod(self):
+        pass

tests/test_patcher.py

@@ -68,6 +68,7 @@ def _call_all_mock_functions():
     mock_subfile.MockClass.mock_classmethod()
     mock_subfile.MockClass.mock_staticmethod()
     mock_subfile.MockClass().mock_method()
+    mock_subfile.MockSubclass().mock_submethod()
 
 
 @pytest.mark.parametrize('modules', [
@@ -104,14 +105,16 @@ def test_external_module():
 
     _call_all_mock_functions()
 
-    assert len(xray_recorder.current_segment().subsegments) == 7
+    assert len(xray_recorder.current_segment().subsegments) == 9
     assert xray_recorder.current_segment().subsegments[0].name == 'mock_subinit'
     assert xray_recorder.current_segment().subsegments[1].name == 'mock_subfunc'
     assert xray_recorder.current_segment().subsegments[2].name == 'mock_no_doublepatch'  # Should appear only once
     assert xray_recorder.current_segment().subsegments[3].name == 'mock_classmethod'
     assert xray_recorder.current_segment().subsegments[4].name == 'mock_staticmethod'
     assert xray_recorder.current_segment().subsegments[5].name == 'MockClass.__init__'
     assert xray_recorder.current_segment().subsegments[6].name == 'mock_method'
+    assert xray_recorder.current_segment().subsegments[7].name == 'MockSubclass.__init__'
+    assert xray_recorder.current_segment().subsegments[8].name == 'mock_submethod'
 
 
 def test_external_submodules_full():
@@ -123,7 +126,7 @@ def test_external_submodules_full():
 
     _call_all_mock_functions()
 
-    assert len(xray_recorder.current_segment().subsegments) == 9
+    assert len(xray_recorder.current_segment().subsegments) == 11
     assert xray_recorder.current_segment().subsegments[0].name == 'mock_init'
     assert xray_recorder.current_segment().subsegments[1].name == 'mock_subinit'
     assert xray_recorder.current_segment().subsegments[2].name == 'mock_func'
@@ -133,6 +136,8 @@ def test_external_submodules_full():
     assert xray_recorder.current_segment().subsegments[6].name == 'mock_staticmethod'
     assert xray_recorder.current_segment().subsegments[7].name == 'MockClass.__init__'
     assert xray_recorder.current_segment().subsegments[8].name == 'mock_method'
+    assert xray_recorder.current_segment().subsegments[9].name == 'MockSubclass.__init__'
+    assert xray_recorder.current_segment().subsegments[10].name == 'mock_submethod'
 
 
 def test_external_submodules_ignores_file():
@@ -144,7 +149,7 @@ def test_external_submodules_ignores_file():
 
     _call_all_mock_functions()
 
-    assert len(xray_recorder.current_segment().subsegments) == 8
+    assert len(xray_recorder.current_segment().subsegments) == 10
     assert xray_recorder.current_segment().subsegments[0].name == 'mock_init'
     assert xray_recorder.current_segment().subsegments[1].name == 'mock_subinit'
     assert xray_recorder.current_segment().subsegments[2].name == 'mock_subfunc'
@@ -153,6 +158,8 @@ def test_external_submodules_ignores_file():
     assert xray_recorder.current_segment().subsegments[5].name == 'mock_staticmethod'
     assert xray_recorder.current_segment().subsegments[6].name == 'MockClass.__init__'
     assert xray_recorder.current_segment().subsegments[7].name == 'mock_method'
+    assert xray_recorder.current_segment().subsegments[8].name == 'MockSubclass.__init__'
+    assert xray_recorder.current_segment().subsegments[9].name == 'mock_submethod'
 
 
 def test_external_submodules_ignores_module():