Fix RuntimeError: maximum recursion depth exceeded in cmp happened (appium#343)

KazuCocoa · web-flow · commit e3f8cb3a377f · 2019-03-14T15:48:54.000+09:00
* fix maximum recursion depth exceeded in sub classes

* add docstring

* add comparison of a number of commands

* use issubclass to ensure the class is sub
diff --git a/appium/webdriver/webdriver.py b/appium/webdriver/webdriver.py
@@ -596,8 +596,10 @@ def battery_info(self):
     # pylint: disable=protected-access
 
     def _addCommands(self):
-        # call the overridden command binders from all mixin classes
-        for mixin_class in filter(lambda x: x is not self.__class__, self.__class__.__mro__):
+        # call the overridden command binders from all mixin classes except for
+        # appium.webdriver.webdriver.WebDriver and its sub-classes
+        # https://github.com/appium/python-client/issues/342
+        for mixin_class in filter(lambda x: not issubclass(x, WebDriver), self.__class__.__mro__):
             if hasattr(mixin_class, self._addCommands.__name__):
                 getattr(mixin_class, self._addCommands.__name__, None)(self)
 
diff --git a/test/unit/webdriver/webdriver_test.py b/test/unit/webdriver/webdriver_test.py
@@ -23,6 +23,7 @@
     android_w3c_driver,
     get_httpretty_request_body
 )
+from appium.webdriver.webdriver import WebDriver
 
 
 class TestWebDriverWebDriver(object):
@@ -251,3 +252,100 @@ def test_create_session_register_uridirect_no_direct_connect_path(self):
 
         assert 'http://localhost:4723/wd/hub' == driver.command_executor._url
         assert ['NATIVE_APP', 'CHROMIUM'] == driver.contexts
+
+
+class SubWebDriver(WebDriver):
+    def __init__(self, command_executor, desired_capabilities, direct_connection=False):
+        super(SubWebDriver, self).__init__(
+            command_executor=command_executor,
+            desired_capabilities=desired_capabilities,
+            direct_connection=direct_connection
+        )
+
+
+class SubSubWebDriver(SubWebDriver):
+    def __init__(self, command_executor, desired_capabilities, direct_connection=False):
+        super(SubSubWebDriver, self).__init__(
+            command_executor=command_executor,
+            desired_capabilities=desired_capabilities,
+            direct_connection=direct_connection
+        )
+
+
+class TestSubModuleWebDriver(object):
+    def android_w3c_driver(self, driver_class):
+        response_body_json = json.dumps(
+            {
+                'value': {
+                    'sessionId': '1234567890',
+                    'capabilities': {
+                        'platform': 'LINUX',
+                        'desired': {
+                            'platformName': 'Android',
+                            'automationName': 'uiautomator2',
+                            'platformVersion': '7.1.1',
+                            'deviceName': 'Android Emulator',
+                            'app': '/test/apps/ApiDemos-debug.apk',
+                        },
+                        'platformName': 'Android',
+                        'automationName': 'uiautomator2',
+                        'platformVersion': '7.1.1',
+                        'deviceName': 'emulator-5554',
+                        'app': '/test/apps/ApiDemos-debug.apk',
+                        'deviceUDID': 'emulator-5554',
+                        'appPackage': 'com.example.android.apis',
+                        'appWaitPackage': 'com.example.android.apis',
+                        'appActivity': 'com.example.android.apis.ApiDemos',
+                        'appWaitActivity': 'com.example.android.apis.ApiDemos'
+                    }
+                }
+            }
+        )
+
+        httpretty.register_uri(
+            httpretty.POST,
+            appium_command('/session'),
+            body=response_body_json
+        )
+
+        desired_caps = {
+            'platformName': 'Android',
+            'deviceName': 'Android Emulator',
+            'app': 'path/to/app',
+            'automationName': 'UIAutomator2'
+        }
+
+        driver = driver_class(
+            'http://localhost:4723/wd/hub',
+            desired_caps
+        )
+        return driver
+
+    @httpretty.activate
+    def test_clipboard_with_subclass(self):
+        driver = self.android_w3c_driver(SubWebDriver)
+        httpretty.register_uri(
+            httpretty.GET,
+            appium_command('/session/1234567890/context'),
+            body='{"value": "NATIVE"}'
+        )
+        assert driver.current_context == 'NATIVE'
+
+    @httpretty.activate
+    def test_clipboard_with_subsubclass(self):
+        driver = self.android_w3c_driver(SubSubWebDriver)
+        httpretty.register_uri(
+            httpretty.GET,
+            appium_command('/session/1234567890/context'),
+            body='{"value": "NATIVE"}'
+        )
+        assert driver.current_context == 'NATIVE'
+
+    @httpretty.activate
+    def test_compare_commands(self):
+        driver_base = android_w3c_driver()
+        driver_sub = self.android_w3c_driver(SubWebDriver)
+        driver_subsub = self.android_w3c_driver(SubSubWebDriver)
+
+        assert len(driver_base.command_executor._commands) == len(driver_sub.command_executor._commands)
+        assert len(driver_base.command_executor._commands) == len(driver_subsub.command_executor._commands)
