chore: Apply Black code formatter (appium#571)

* Applied black (length: 120, String skipped)

* Updated related to ci

* Update README

Author: ki4070ma

.pre-commit-config.yaml

@@ -1,8 +1,3 @@
--   repo: https://github.com/pre-commit/mirrors-autopep8
-    rev: v1.5.4
-    hooks:
-    -   id: autopep8
-        args: ["-a", "-i"]
 -   repo: https://github.com/pre-commit/mirrors-isort
     rev: v4.3.21
     hooks:
@@ -14,3 +9,8 @@
     -   id: mypy
         entry: mypy appium/ test/
         pass_filenames: false
+-   repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+    -   id: black
+        args: [".", "-l", "120", "-S"]

Makefile

@@ -9,9 +9,9 @@ check-all: ## Run all lint checks and unittest
 isort: ## Run isort
 	python -m isort $(ARGS) -rc .
 
-.PHONY: autopep8
-autopep8: ## Run autopep8
-	python -m autopep8 $(ARGS) -a -r -i .
+.PHONY: black
+black: ## Run black
+	python -m black $(ARGS) . -l 120 -S
 
 .PHONY: pylint
 pylint: ## Run pylint

Pipfile

@@ -9,7 +9,7 @@ pre-commit = "~=2.6"
 [packages]
 selenium = "~=3.141"
 
-autopep8 = "~=1.5"
+black = "==20.8b1"
 
 pytest = "~=6.0"
 pytest-cov = "~=2.10"

README.md

@@ -6,6 +6,8 @@
 [![Build Status](https://travis-ci.org/appium/python-client.svg?branch=master)](https://travis-ci.org/appium/python-client)
 [![Build Status](https://dev.azure.com/AppiumCI/Appium%20CI/_apis/build/status/appium.python-client?branchName=master)](https://dev.azure.com/AppiumCI/Appium%20CI/_build/latest?definitionId=56&branchName=master)
 
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
 An extension library for adding [Selenium 3.0 draft](https://dvcs.w3.org/hg/webdriver/raw-file/tip/webdriver-spec.html) and [Mobile JSON Wire Protocol Specification draft](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md)
 functionality to the Python language bindings, for use with the mobile testing
 framework [Appium](https://appium.io).
@@ -139,7 +141,7 @@ https://appium.github.io/python-client-sphinx/ is detailed documentation
 ## Development
 
 - Code Style: [PEP-0008](https://www.python.org/dev/peps/pep-0008/)
-  - Apply `autopep8`, `isort` and `mypy` as pre commit hook
+  - Apply `black`, `isort` and `mypy` as pre commit hook
   - Run `make` command for development. See `make help` output for details
 - Docstring style: [Google Style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
 - `gitchangelog` generates `CHANGELOG.rst`

appium/common/exceptions.py

@@ -24,4 +24,5 @@ class NoSuchContextException(InvalidSwitchToTargetException):
         print(driver.contexts)
 
     """
+
     pass

appium/common/helper.py

@@ -26,12 +26,12 @@ def extract_const_attributes(cls: type) -> Dict[str, Any]:
     Returns:
         dict with constants attributes and values in the class
     """
-    return dict([(attr, value) for attr, value in vars(cls).items()
-                 if not callable(getattr(cls, attr)) and attr.isupper()])
+    return dict(
+        [(attr, value) for attr, value in vars(cls).items() if not callable(getattr(cls, attr)) and attr.isupper()]
+    )
 
 
 def library_version() -> str:
-    """Return a version of this python library
-    """
+    """Return a version of this python library"""
 
     return appium_version.version

appium/webdriver/appium_connection.py

@@ -24,7 +24,6 @@
 
 
 class AppiumConnection(RemoteConnection):
-
     @classmethod
     def get_remote_connection_headers(cls, parsed_url: 'ParseResult', keep_alive: bool = True) -> Dict[str, Any]:
         """Override get_remote_connection_headers in RemoteConnection"""

appium/webdriver/appium_service.py

@@ -72,16 +72,18 @@ def _get_node(self) -> str:
         if not hasattr(self, '_node_executable'):
             self._node_executable = find_executable('node')
         if self._node_executable is None:
-            raise AppiumServiceError('NodeJS main executable cannot be found. ' +
-                                     'Make sure it is installed and present in PATH')
+            raise AppiumServiceError(
+                'NodeJS main executable cannot be found. ' + 'Make sure it is installed and present in PATH'
+            )
         return self._node_executable
 
     def _get_npm(self) -> str:
         if not hasattr(self, '_npm_executable'):
             self._npm_executable = find_executable('npm.cmd' if sys.platform == 'win32' else 'npm')
         if self._npm_executable is None:
-            raise AppiumServiceError('Node Package Manager executable cannot be found. ' +
-                                     'Make sure it is installed and present in PATH')
+            raise AppiumServiceError(
+                'Node Package Manager executable cannot be found. ' + 'Make sure it is installed and present in PATH'
+            )
         return self._npm_executable
 
     def _get_main_script(self) -> Union[str, bytes]:
@@ -97,9 +99,8 @@ def _get_main_script(self) -> Union[str, bytes]:
             if not hasattr(self, '_main_script'):
                 try:
                     self._main_script = sp.check_output(
-                        [self._get_node(),
-                         '-e',
-                         'console.log(require.resolve("{}"))'.format(MAIN_SCRIPT_PATH)]).strip()
+                        [self._get_node(), '-e', 'console.log(require.resolve("{}"))'.format(MAIN_SCRIPT_PATH)]
+                    ).strip()
                 except sp.CalledProcessError as e:
                     raise AppiumServiceError(e.output) from e
         return self._main_script
@@ -221,13 +222,13 @@ def is_listening(self) -> bool:
 
 
 if __name__ == '__main__':
-    assert(find_executable('node') is not None)
-    assert(find_executable('npm') is not None)
+    assert find_executable('node') is not None
+    assert find_executable('npm') is not None
     service = AppiumService()
     service.start(args=['--address', '127.0.0.1', '-p', str(DEFAULT_PORT)])
     # service.start(args=['--address', '127.0.0.1', '-p', '80'], timeout_ms=2000)
     assert service.is_running
     assert service.is_listening
     service.stop()
-    assert(not service.is_running)
-    assert(not service.is_listening)
+    assert not service.is_running
+    assert not service.is_listening

appium/webdriver/common/touch_action.py

@@ -36,13 +36,17 @@
 
 
 class TouchAction:
-
     def __init__(self, driver: Optional['WebDriver'] = None):
         self._driver = driver
         self._actions: List = []
 
-    def tap(self: T, element: Optional['WebElement'] = None, x: Optional[int]
-            = None, y: Optional[int] = None, count: int = 1) -> T:
+    def tap(
+        self: T,
+        element: Optional['WebElement'] = None,
+        x: Optional[int] = None,
+        y: Optional[int] = None,
+        count: int = 1,
+    ) -> T:
         """Perform a tap action on the element
 
         Args:
@@ -59,8 +63,13 @@ def tap(self: T, element: Optional['WebElement'] = None, x: Optional[int]
 
         return self
 
-    def press(self: T, el: Optional['WebElement'] = None, x: Optional[int] = None,
-              y: Optional[int] = None, pressure: Optional[float] = None) -> T:
+    def press(
+        self: T,
+        el: Optional['WebElement'] = None,
+        x: Optional[int] = None,
+        y: Optional[int] = None,
+        pressure: Optional[float] = None,
+    ) -> T:
         """Begin a chain with a press down action at a particular element or point
 
         Args:
@@ -77,8 +86,13 @@ def press(self: T, el: Optional['WebElement'] = None, x: Optional[int] = None,
 
         return self
 
-    def long_press(self: T, el: Optional['WebElement'] = None, x: Optional[int]
-                   = None, y: Optional[int] = None, duration: int = 1000) -> T:
+    def long_press(
+        self: T,
+        el: Optional['WebElement'] = None,
+        x: Optional[int] = None,
+        y: Optional[int] = None,
+        duration: int = 1000,
+    ) -> T:
         """Begin a chain with a press down that lasts `duration` milliseconds
 
         Args:
@@ -167,8 +181,14 @@ def _add_action(self, action: str, options: Dict) -> None:
         }
         self._actions.append(gesture)
 
-    def _get_opts(self, el: Optional['WebElement'] = None, x: Optional[int] = None, y: Optional[int] = None,
-                  duration: Optional[int] = None, pressure: Optional[float] = None) -> Dict[str, Union[int, float]]:
+    def _get_opts(
+        self,
+        el: Optional['WebElement'] = None,
+        x: Optional[int] = None,
+        y: Optional[int] = None,
+        duration: Optional[int] = None,
+        pressure: Optional[float] = None,
+    ) -> Dict[str, Union[int, float]]:
         opts = {}
         if el is not None:
             opts['element'] = el.id

appium/webdriver/extensions/action_helpers.py

@@ -28,7 +28,6 @@
 
 
 class ActionHelpers(webdriver.Remote):
-
     def scroll(self: T, origin_el: WebElement, destination_el: WebElement, duration: Optional[int] = None) -> T:
         """Scrolls from one element to another
 
@@ -128,11 +127,7 @@ def swipe(self: T, start_x: int, start_y: int, end_x: int, end_y: int, duration:
         # `swipe` is something like press-wait-move_to-release, which the server
         # will translate into the correct action
         action = TouchAction(self)
-        action \
-            .press(x=start_x, y=start_y) \
-            .wait(ms=duration) \
-            .move_to(x=end_x, y=end_y) \
-            .release()
+        action.press(x=start_x, y=start_y).wait(ms=duration).move_to(x=end_x, y=end_y).release()
         action.perform()
         return self
 
@@ -152,9 +147,6 @@ def flick(self: T, start_x: int, start_y: int, end_x: int, end_y: int) -> T:
             Union['WebDriver', 'ActionHelpers']: Self instance
         """
         action = TouchAction(self)
-        action \
-            .press(x=start_x, y=start_y) \
-            .move_to(x=end_x, y=end_y) \
-            .release()
+        action.press(x=start_x, y=start_y).move_to(x=end_x, y=end_y).release()
         action.perform()
         return self