ci: add pylint_quotes for pylint to use single quote as primary method (#886)

Author: KazuCocoa

.pylintrc

@@ -551,3 +551,7 @@ known-third-party=enchant
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception"
 overgeneral-exceptions=Exception
+
+string-quote=single
+triple-quote=single
+docstring-quote=double

Makefile

@@ -16,7 +16,7 @@ black: ## Run black
 .PHONY: pylint
 pylint: ## Run pylint
     # TODO Remove --disable=E1136 when no errors in py39
-	python -m pylint $(ARGS) --rcfile .pylintrc appium test --disable=E1136
+	python -m pylint $(ARGS) --load-plugins pylint_quotes --rcfile .pylintrc appium test --disable=E1136
 
 .PHONY: mypy
 mypy:  ## Run mypy

Pipfile

@@ -11,6 +11,7 @@ mypy = "<2.0"
 mock = "~=5.0"
 pre-commit = "~=2.21"
 pylint = "~=2.17.3"
+pylint-quotes = "~=0.2.3"
 pytest = "~=7.4"
 pytest-cov = "~=4.1"
 python-dateutil = "~=2.8"

appium/webdriver/common/multi_action.py

@@ -38,7 +38,7 @@ class MultiAction:
 
     def __init__(self, driver: 'WebDriver', element: Optional['WebElement'] = None) -> None:
         warnings.warn(
-            "[Deprecated] 'MultiAction' action is deprecated. Please use W3C actions instead.", DeprecationWarning
+            '[Deprecated] \'MultiAction\' action is deprecated. Please use W3C actions instead.', DeprecationWarning
         )
 
         self._driver = driver

appium/webdriver/common/touch_action.py

@@ -42,7 +42,7 @@ class TouchAction:
 
     def __init__(self, driver: Optional['WebDriver'] = None):
         warnings.warn(
-            "[Deprecated] 'TouchAction' action is deprecated. Please use W3C actions instead.", DeprecationWarning
+            '[Deprecated] \'TouchAction\' action is deprecated. Please use W3C actions instead.', DeprecationWarning
         )
 
         self._driver = driver

appium/webdriver/extensions/action_helpers.py

@@ -46,7 +46,7 @@ def scroll(self, origin_el: WebElement, destination_el: WebElement, duration: Op
         if duration is None:
             duration = 600
 
-        touch_input = PointerInput(interaction.POINTER_TOUCH, "touch")
+        touch_input = PointerInput(interaction.POINTER_TOUCH, 'touch')
 
         actions = ActionChains(self)
         actions.w3c_actions = ActionBuilder(self, mouse=touch_input)
@@ -96,7 +96,7 @@ def tap(self, positions: List[Tuple[int, int]], duration: Optional[int] = None)
         """
         if len(positions) == 1:
             actions = ActionChains(self)
-            actions.w3c_actions = ActionBuilder(self, mouse=PointerInput(interaction.POINTER_TOUCH, "touch"))
+            actions.w3c_actions = ActionBuilder(self, mouse=PointerInput(interaction.POINTER_TOUCH, 'touc'))
             x = positions[0][0]
             y = positions[0][1]
             actions.w3c_actions.pointer_action.move_to_location(x, y)
@@ -145,7 +145,7 @@ def swipe(self, start_x: int, start_y: int, end_x: int, end_y: int, duration: in
         Returns:
             Union['WebDriver', 'ActionHelpers']: Self instance
         """
-        touch_input = PointerInput(interaction.POINTER_TOUCH, "touch")
+        touch_input = PointerInput(interaction.POINTER_TOUCH, 'touch')
 
         actions = ActionChains(self)
         actions.w3c_actions = ActionBuilder(self, mouse=touch_input)
@@ -174,7 +174,7 @@ def flick(self, start_x: int, start_y: int, end_x: int, end_y: int) -> 'WebDrive
             Union['WebDriver', 'ActionHelpers']: Self instance
         """
         actions = ActionChains(self)
-        actions.w3c_actions = ActionBuilder(self, mouse=PointerInput(interaction.POINTER_TOUCH, "touch"))
+        actions.w3c_actions = ActionBuilder(self, mouse=PointerInput(interaction.POINTER_TOUCH, 'touch'))
         actions.w3c_actions.pointer_action.move_to_location(start_x, start_y)
         actions.w3c_actions.pointer_action.pointer_down()
         actions.w3c_actions.pointer_action.move_to_location(end_x, end_y)

appium/webdriver/extensions/location.py

@@ -63,9 +63,9 @@ def set_location(
             Union['WebDriver', 'Location']: Self instance
         """
         data = {
-            "location": {
-                "latitude": latitude,
-                "longitude": longitude,
+            'location': {
+                'latitude': latitude,
+                'longitude': longitude,
             }
         }
         if altitude is not None:

appium/webdriver/extensions/settings.py

@@ -42,7 +42,7 @@ def update_settings(self, settings: Dict[str, Any]) -> 'WebDriver':
         Args:
             settings: dictionary of settings to apply to the current test session
         """
-        self.execute(Command.UPDATE_SETTINGS, {"settings": settings})
+        self.execute(Command.UPDATE_SETTINGS, {'settings': settings})
         return cast('WebDriver', self)
 
     def _add_commands(self) -> None:

appium/webdriver/webdriver.py

@@ -285,7 +285,7 @@ def __init__(
             instance = extension(self.execute)
             method_name = instance.method_name()
             if hasattr(WebDriver, method_name):
-                logger.debug(f"Overriding the method '{method_name}'")
+                logger.debug(f'Overriding the method \'{method_name}\'')
 
             # add a new method named 'instance.method_name()' and call it
             setattr(WebDriver, method_name, getattr(instance, method_name))
@@ -519,7 +519,7 @@ def orientation(self, value: str) -> None:
         if value.upper() in allowed_values:
             self.execute(Command.SET_SCREEN_ORIENTATION, {'orientation': value})
         else:
-            raise WebDriverException("You can only set the orientation to 'LANDSCAPE' and 'PORTRAIT'")
+            raise WebDriverException('You can only set the orientation to \'LANDSCAPE\' and \'PORTRAIT\'')
 
     def assert_extension_exists(self, ext_name: str) -> 'WebDriver':
         """

appium/webdriver/webelement.py

@@ -112,7 +112,7 @@ def find_element(self, by: str = AppiumBy.ID, value: Union[str, Dict, None] = No
         #     by = By.CSS_SELECTOR
         #     value = '[name="%s"]' % value
 
-        return self._execute(RemoteCommand.FIND_CHILD_ELEMENT, {"using": by, "value": value})['value']
+        return self._execute(RemoteCommand.FIND_CHILD_ELEMENT, {'using': by, 'value': value})['value']
 
     def find_elements(self, by: str = AppiumBy.ID, value: Union[str, Dict, None] = None) -> List['WebElement']:
         """Find elements given a AppiumBy strategy and locator
@@ -142,7 +142,7 @@ def find_elements(self, by: str = AppiumBy.ID, value: Union[str, Dict, None] = N
         #     by = By.CSS_SELECTOR
         #     value = '[name="%s"]' % value
 
-        return self._execute(RemoteCommand.FIND_CHILD_ELEMENTS, {"using": by, "value": value})['value']
+        return self._execute(RemoteCommand.FIND_CHILD_ELEMENTS, {'using': by, 'value': value})['value']
 
     def clear(self) -> 'WebElement':
         """Clears text.

test/functional/android/activities_tests.py

@@ -22,17 +22,17 @@ def test_current_activity(self) -> None:
         assert '.ApiDemos' == activity
 
     def test_start_activity_this_app(self) -> None:
-        self.driver.start_activity(APIDEMO_PKG_NAME, ".ApiDemos")
+        self.driver.start_activity(APIDEMO_PKG_NAME, '.ApiDemos')
         self._assert_activity_contains('Demos')
 
-        self.driver.start_activity(APIDEMO_PKG_NAME, ".accessibility.AccessibilityNodeProviderActivity")
+        self.driver.start_activity(APIDEMO_PKG_NAME, '.accessibility.AccessibilityNodeProviderActivity')
         self._assert_activity_contains('Node')
 
     def test_start_activity_other_app(self) -> None:
-        self.driver.start_activity(APIDEMO_PKG_NAME, ".ApiDemos")
+        self.driver.start_activity(APIDEMO_PKG_NAME, '.ApiDemos')
         self._assert_activity_contains('Demos')
 
-        self.driver.start_activity("com.google.android.deskclock", "com.android.deskclock.DeskClock")
+        self.driver.start_activity('com.google.android.deskclock', 'com.android.deskclock.DeskClock')
         self._assert_activity_contains('Clock')
 
     def _assert_activity_contains(self, activity: str) -> None:

test/functional/android/context_switching_tests.py

@@ -23,7 +23,7 @@
 from .helper import desired_capabilities
 
 
-@pytest.mark.skip(reason="Need to fix broken test")
+@pytest.mark.skip(reason='Need to fix broken test')
 class TestContextSwitching(object):
     def setup_method(self) -> None:
         caps = desired_capabilities.get_desired_capabilities('selendroid-test-app.apk')
@@ -44,7 +44,7 @@ def test_move_to_correct_context(self) -> None:
     def test_actually_in_webview(self) -> None:
         self._enter_webview()
         self.driver.find_element(by=AppiumBy.CSS_SELECTOR, value='input[type=submit]').click()
-        el = self.driver.find_element(by=AppiumBy.XPATH, value="//h1[contains(., 'This is my way')]")
+        el = self.driver.find_element(by=AppiumBy.XPATH, value='//h1[contains(., \'This is my way\')]')
         assert el is not None
 
     def test_move_back_to_native_context(self) -> None:

test/functional/android/helper/test_helper.py

@@ -44,6 +44,6 @@ def teardown_method(self, method) -> None:  # type: ignore
         if is_ci():
             payload = self.driver.stop_recording_screen()
             video_path = os.path.join(os.getcwd(), method.__name__ + '.mp4')
-            with open(video_path, "wb") as fd:
+            with open(video_path, 'wb') as fd:
                 fd.write(base64.b64decode(payload))
         self.driver.quit()

test/functional/android/search_context/find_by_image_tests.py

@@ -32,7 +32,7 @@ def setup_method(self) -> None:
 
         # relax template matching
         self.driver.update_settings(
-            {"fixImageFindScreenshotDims": False, "fixImageTemplateSize": True, "autoUpdateImageElementPosition": True}
+            {'fixImageFindScreenshotDims': False, 'fixImageTemplateSize': True, 'autoUpdateImageElementPosition': True}
         )
 
     def teardown_method(self) -> None:
@@ -57,14 +57,14 @@ def test_find_based_on_image_template(self) -> None:
         assert rect['y'] is not None
         assert el.is_displayed()
         el.click()
-        wait_for_element(self.driver, AppiumBy.ACCESSIBILITY_ID, "Alarm")
+        wait_for_element(self.driver, AppiumBy.ACCESSIBILITY_ID, 'Alarm')
 
     def test_find_multiple_elements_by_image_just_returns_one(self) -> None:
-        wait_for_element(self.driver, AppiumBy.ACCESSIBILITY_ID, "App")
+        wait_for_element(self.driver, AppiumBy.ACCESSIBILITY_ID, 'App')
         image_path = desired_capabilities.PATH('file/find_by_image_success.png')
         els = self.driver.find_elements_by_image(image_path)
         els[0].click()
-        wait_for_element(self.driver, AppiumBy.ACCESSIBILITY_ID, "Alarm")
+        wait_for_element(self.driver, AppiumBy.ACCESSIBILITY_ID, 'Alarm')
 
     def test_find_throws_no_such_element(self) -> None:
         image_path = desired_capabilities.PATH('file/find_by_image_failure.png')

test/functional/android/search_context/find_by_uiautomator_tests.py

@@ -19,7 +19,7 @@
 from test.functional.android.helper.test_helper import BaseTestCase
 
 
-@pytest.mark.skip(reason="Need to fix flaky test")
+@pytest.mark.skip(reason='Need to fix flaky test')
 class TestFindByUIAutomator(BaseTestCase):
     def test_find_single_element(self) -> None:
         el = self.driver.find_element(by=AppiumBy.ANDROID_UIAUTOMATOR, value='new UiSelector().text("Animation")')

test/functional/android/settings_tests.py

@@ -22,6 +22,6 @@ def test_get_settings(self) -> None:
         assert settings is not None
 
     def test_update_settings(self) -> None:
-        self.driver.update_settings({"waitForIdleTimeout": 10001})
+        self.driver.update_settings({'waitForIdleTimeout': 10001})
         settings = self.driver.get_settings()
-        assert settings["waitForIdleTimeout"] == 10001
+        assert settings['waitForIdleTimeout'] == 10001

test/functional/android/touch_action_tests.py

@@ -51,7 +51,7 @@ def test_tap_twice(self) -> None:
         action.tap(el, count=2).perform()
 
         els = self.driver.find_elements(by=AppiumBy.CLASS_NAME, value='android.widget.TextView')
-        assert 'This is a test\nThis is a test\n' == els[1].get_attribute("text")
+        assert 'This is a test\nThis is a test\n' == els[1].get_attribute('text')
 
     def test_press_and_immediately_release(self) -> None:
         el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='Animation')

test/functional/android/webelement_tests.py

@@ -43,7 +43,7 @@ def test_set_text(self) -> None:
 
     def test_send_keys(self) -> None:
         for text in ['App', 'Activity', 'Custom Title']:
-            wait_for_element(self.driver, AppiumBy.XPATH, f"//android.widget.TextView[@text='{text}']").click()
+            wait_for_element(self.driver, AppiumBy.XPATH, f'//android.widget.TextView[@text=\'{text}\']').click()
 
         el = wait_for_element(self.driver, AppiumBy.ID, '{}:id/left_text_edit'.format(APIDEMO_PKG_NAME))
         el.send_keys(' text')

test/functional/ios/applications_tests.py

@@ -28,6 +28,6 @@ def test_app_management(self) -> None:
         self.driver.background_app(-1)
         assert wait_for_condition(
             lambda: self.driver.query_app_state(desired_capabilities.BUNDLE_ID) < ApplicationState.RUNNING_IN_FOREGROUND
-        ), "The app didn't go to background."
+        ), 'The app didn\'t go to background.'
         self.driver.activate_app(desired_capabilities.BUNDLE_ID)
         assert self.driver.query_app_state(desired_capabilities.BUNDLE_ID) == ApplicationState.RUNNING_IN_FOREGROUND

test/functional/ios/helper/test_helper.py

@@ -37,6 +37,6 @@ def teardown_method(self, method) -> None:  # type: ignore
         if is_ci():
             payload = self.driver.stop_recording_screen()
             video_path = os.path.join(os.getcwd(), method.__name__ + '.mp4')
-            with open(video_path, "wb") as fd:
+            with open(video_path, 'wb') as fd:
                 fd.write(base64.b64decode(payload))
         self.driver.quit()

test/functional/ios/safari_tests.py

@@ -36,7 +36,7 @@ def test_context(self) -> None:
         assert 'WEBVIEW_' in self.driver.current_context
 
     def test_get(self) -> None:
-        self.driver.get("http://google.com")
+        self.driver.get('http://google.com')
         for _ in range(5):
             time.sleep(0.5)
             if 'Google' == self.driver.title:

test/functional/ios/webdriver_tests.py

@@ -66,7 +66,7 @@ def test_app_management(self) -> None:
         assert wait_for_condition(
             lambda: self.driver.query_app_state(desired_capabilities.BUNDLE_ID)
             < ApplicationState.RUNNING_IN_FOREGROUND,
-        ), "The app didn't go to background."
+        ), 'The app didn\'t go to background.'
         self.driver.activate_app(desired_capabilities.BUNDLE_ID)
         assert self.driver.query_app_state(desired_capabilities.BUNDLE_ID) == ApplicationState.RUNNING_IN_FOREGROUND
 
@@ -97,7 +97,7 @@ def test_clear(self) -> None:
         assert text == def_text
 
     def test_press_button(self) -> None:
-        self.driver.press_button("Home")
+        self.driver.press_button('Home')
         if float(desired_capabilities.get_desired_capabilities(desired_capabilities.BUNDLE_ID)['platformVersion']) < 11:
             return
         assert self.driver.query_app_state(desired_capabilities.BUNDLE_ID) == ApplicationState.RUNNING_IN_FOREGROUND