add autopep8 (appium#243)

KazuCocoa · web-flow · commit f8d600edd635 · 2018-08-15T17:28:19.000+09:00
* apply autopep8

* add development section as the first draft

* relax max-line-length

* add global-config
diff --git a/.config-pep8 b/.config-pep8
@@ -0,0 +1,2 @@
+[pep8]
+max-line-length = 120
diff --git a/.travis.yml b/.travis.yml
@@ -7,5 +7,4 @@ install:
   - pip install -r ci-requirements.txt
 
 script:
-  - python -m pylint --rcfile .pylintrc appium test --py3k
-  - python -m pytest test/unit/*
+  - ./ci.sh
diff --git a/README.md b/README.md
@@ -37,6 +37,14 @@ download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
     python setup.py install
     ```
 
+# Development
+
+- Style Guide: https://www.python.org/dev/peps/pep-0008/
+    - `autopep8` helps to format code automatically
+
+```
+$ python -m autopep8 -r --global-config .config-pep8 -i .
+```
 
 # Usage
 
diff --git a/appium/saucetestcase.py b/appium/saucetestcase.py
@@ -32,7 +32,7 @@ def decorator(base_class):
         module = sys.modules[base_class.__module__].__dict__
         for i, platform in enumerate(platforms):
             name = "%s_%s" % (base_class.__name__, i + 1)
-            d_caps = {'desired_capabilities' : platform}
+            d_caps = {'desired_capabilities': platform}
             module[name] = type(name, (base_class,), d_caps)
     return decorator
 
diff --git a/appium/webdriver/connectiontype.py b/appium/webdriver/connectiontype.py
@@ -24,6 +24,8 @@
     4 (Data only)      | 1    | 0    | 0
     6 (All network on) | 1    | 1    | 0
 """
+
+
 class ConnectionType(object):
     NO_CONNECTION = 0
     AIRPLANE_MODE = 1
diff --git a/appium/webdriver/imagelement.py b/appium/webdriver/imagelement.py
@@ -14,6 +14,7 @@
 
 import math
 
+
 class ImageElement(object):
 
     def __init__(self, driver, x, y, width, height):
diff --git a/appium/webdriver/mobilecommand.py b/appium/webdriver/mobilecommand.py
@@ -34,7 +34,7 @@ class MobileCommand(object):
     # Appium Commands
     GET_APP_STRINGS = 'getAppStrings'
     PRESS_KEYCODE = 'pressKeyCode'
-    KEY_EVENT = 'keyEvent' # Needed for Selendroid
+    KEY_EVENT = 'keyEvent'  # Needed for Selendroid
     LONG_PRESS_KEYCODE = 'longPressKeyCode'
     GET_CURRENT_ACTIVITY = 'getCurrentActivity'
     GET_CURRENT_PACKAGE = 'getCurrentPackage'
diff --git a/appium/webdriver/webdriver.py b/appium/webdriver/webdriver.py
@@ -21,7 +21,8 @@
 
 from selenium.webdriver.common.by import By
 from selenium.webdriver.support.ui import WebDriverWait
-from selenium.common.exceptions import (TimeoutException, WebDriverException, InvalidArgumentException, NoSuchElementException)
+from selenium.common.exceptions import (TimeoutException, WebDriverException,
+                                        InvalidArgumentException, NoSuchElementException)
 
 from selenium.webdriver.remote.command import Command as RemoteCommand
 
@@ -63,6 +64,8 @@
 
 # override
 # Add appium prefix for the non-W3C capabilities
+
+
 def _make_w3c_caps(caps):
     appium_prefix = 'appium:'
 
@@ -204,17 +207,17 @@ def find_element(self, by=By.ID, value=None):
         :rtype: WebElement
         """
         # if self.w3c:
-            # if by == By.ID:
-            #     by = By.CSS_SELECTOR
-            #     value = '[id="%s"]' % value
-            # elif by == By.TAG_NAME:
-            #     by = By.CSS_SELECTOR
-            # elif by == By.CLASS_NAME:
-            #     by = By.CSS_SELECTOR
-            #     value = ".%s" % value
-            # elif by == By.NAME:
-            #     by = By.CSS_SELECTOR
-            #     value = '[name="%s"]' % value
+        # if by == By.ID:
+        #     by = By.CSS_SELECTOR
+        #     value = '[id="%s"]' % value
+        # elif by == By.TAG_NAME:
+        #     by = By.CSS_SELECTOR
+        # elif by == By.CLASS_NAME:
+        #     by = By.CSS_SELECTOR
+        #     value = ".%s" % value
+        # elif by == By.NAME:
+        #     by = By.CSS_SELECTOR
+        #     value = '[name="%s"]' % value
         if by == By.IMAGE:
             return self.find_element_by_image(value)
 
@@ -233,17 +236,17 @@ def find_elements(self, by=By.ID, value=None):
         :rtype: list of WebElement
         """
         # if self.w3c:
-            # if by == By.ID:
-            #     by = By.CSS_SELECTOR
-            #     value = '[id="%s"]' % value
-            # elif by == By.TAG_NAME:
-            #     by = By.CSS_SELECTOR
-            # elif by == By.CLASS_NAME:
-            #     by = By.CSS_SELECTOR
-            #     value = ".%s" % value
-            # elif by == By.NAME:
-            #     by = By.CSS_SELECTOR
-            #     value = '[name="%s"]' % value
+        # if by == By.ID:
+        #     by = By.CSS_SELECTOR
+        #     value = '[id="%s"]' % value
+        # elif by == By.TAG_NAME:
+        #     by = By.CSS_SELECTOR
+        # elif by == By.CLASS_NAME:
+        #     by = By.CSS_SELECTOR
+        #     value = ".%s" % value
+        # elif by == By.NAME:
+        #     by = By.CSS_SELECTOR
+        #     value = '[name="%s"]' % value
 
         # Return empty list if driver returns null
         # See https://github.com/SeleniumHQ/selenium/issues/4555
@@ -1408,8 +1411,8 @@ def battery_info(self):
         """
         return self.execute_script('mobile: batteryInfo')
 
-
     # pylint: disable=protected-access
+
     def _addCommands(self):
         self.command_executor._commands[Command.CONTEXTS] = \
             ('GET', '/session/$sessionId/contexts')
diff --git a/appium/webdriver/webelement.py b/appium/webdriver/webelement.py
@@ -17,6 +17,7 @@
 
 from .mobilecommand import MobileCommand as Command
 
+
 class WebElement(SeleniumWebElement):
     def find_element_by_ios_uiautomation(self, uia_string):
         """Finds an element by uiautomation in iOS.
diff --git a/ci-requirements.txt b/ci-requirements.txt
@@ -2,3 +2,4 @@ selenium
 astroid
 isort
 pylint
+autopep8
diff --git a/ci.sh b/ci.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+result=$(python -m autopep8 -r --global-config .config-pep8 -d .)
+if [[ $result ]] ; then
+  echo $result
+  echo "Please run command 'python -m autopep8 -r --global-config .config-pep8 -i .' on your local and commit the result"
+  exit 1
+fi
+
+python -m pylint --rcfile .pylintrc appium test --py3k
+python -m pytest test/unit/*
diff --git a/docgen.py b/docgen.py
@@ -12,6 +12,6 @@
 
 doc = pandoc.Document()
 doc.markdown = open('README.md').read()
-f = open('README.txt','w+')
+f = open('README.txt', 'w+')
 f.write(doc.rst)
 f.close()
diff --git a/test/functional/android/appium_tests.py b/test/functional/android/appium_tests.py
@@ -56,7 +56,7 @@ def test_app_management(self):
                          ApplicationState.RUNNING_IN_FOREGROUND)
         self.driver.background_app(-1)
         self.assertTrue(self.driver.query_app_state(app_id) <
-                         ApplicationState.RUNNING_IN_FOREGROUND)
+                        ApplicationState.RUNNING_IN_FOREGROUND)
         self.driver.activate_app(app_id)
         self.assertEqual(self.driver.query_app_state(app_id),
                          ApplicationState.RUNNING_IN_FOREGROUND)
@@ -183,8 +183,8 @@ def test_open_notifications(self):
 
         self.driver.open_notifications()
         sleep(1)
-        self.assertRaises(NoSuchElementException, \
-            self.driver.find_element_by_android_uiautomator, 'new UiSelector().text(":-|")')
+        self.assertRaises(NoSuchElementException,
+                          self.driver.find_element_by_android_uiautomator, 'new UiSelector().text(":-|")')
 
         els = self.driver.find_elements_by_class_name('android.widget.TextView')
         # sometimes numbers shift
@@ -204,7 +204,8 @@ def test_open_notifications(self):
         self.driver.find_element_by_android_uiautomator('new UiSelector().text(":-|")')
 
     def test_set_text(self):
-        self.driver.find_element_by_android_uiautomator('new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(new UiSelector().text("Views").instance(0));').click()
+        self.driver.find_element_by_android_uiautomator(
+            'new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(new UiSelector().text("Views").instance(0));').click()
         self.driver.find_element_by_name('Controls').click()
         self.driver.find_element_by_name('1. Light Theme').click()
 
@@ -215,7 +216,8 @@ def test_set_text(self):
         self.assertEqual('new text', el.text)
 
     def test_send_keys(self):
-        self.driver.find_element_by_android_uiautomator('new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(new UiSelector().text("Views").instance(0));').click()
+        self.driver.find_element_by_android_uiautomator(
+            'new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(new UiSelector().text("Views").instance(0));').click()
         self.driver.find_element_by_name('Controls').click()
         self.driver.find_element_by_name('1. Light Theme').click()
 
diff --git a/test/functional/android/find_by_uiautomator_tests.py b/test/functional/android/find_by_uiautomator_tests.py
@@ -47,7 +47,8 @@ def test_element_find_multiple_elements(self):
         self.assertIsInstance(sub_els, list)
 
     def test_scroll_into_view(self):
-        el = self.driver.find_element_by_android_uiautomator('new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(new UiSelector().text("Views").instance(0));')
+        el = self.driver.find_element_by_android_uiautomator(
+            'new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(new UiSelector().text("Views").instance(0));')
         el.click()
 
 
diff --git a/test/functional/android/ime_tests.py b/test/functional/android/ime_tests.py
@@ -36,7 +36,6 @@ def setUp(self):
     def tearDown(self):
         self.driver.quit()
 
-
     def test_available_ime_engines(self):
         engines = self.driver.available_ime_engines
         self.assertIsInstance(engines, list)
diff --git a/test/functional/android/network_connection_tests.py b/test/functional/android/network_connection_tests.py
@@ -33,7 +33,6 @@ def setUp(self):
     def tearDown(self):
         self.driver.quit()
 
-
     def test_get_network_connection(self):
         nc = self.driver.network_connection
         self.assertIsInstance(nc, int)
diff --git a/test/functional/ios/appium_tests.py b/test/functional/ios/appium_tests.py
@@ -51,7 +51,7 @@ def test_app_management(self):
                          ApplicationState.RUNNING_IN_FOREGROUND)
         self.driver.background_app(-1)
         self.assertTrue(self.driver.query_app_state(desired_capabilities.BUNDLE_ID) <
-                         ApplicationState.RUNNING_IN_FOREGROUND)
+                        ApplicationState.RUNNING_IN_FOREGROUND)
         self.driver.activate_app(desired_capabilities.BUNDLE_ID)
         self.assertEqual(self.driver.query_app_state(desired_capabilities.BUNDLE_ID),
                          ApplicationState.RUNNING_IN_FOREGROUND)
diff --git a/test/functional/ios/desired_capabilities.py b/test/functional/ios/desired_capabilities.py
@@ -14,12 +14,16 @@
 import os
 
 # Returns abs path relative to this file and not cwd
-PATH = lambda p: os.path.abspath(
+
+
+def PATH(p): return os.path.abspath(
     os.path.join(os.path.dirname(__file__), p)
 )
 
+
 BUNDLE_ID = 'com.example.apple-samplecode.UICatalog'
 
+
 def get_desired_capabilities(app):
     desired_caps = {
         'deviceName': 'iPhone 6s',
diff --git a/test/functional/ios/find_by_ios_class_chain_tests.py b/test/functional/ios/find_by_ios_class_chain_tests.py
@@ -17,6 +17,7 @@
 from appium import webdriver
 import desired_capabilities
 
+
 class FindByIOClassChainTests(unittest.TestCase):
     @classmethod
     def setUpClass(self):
@@ -37,6 +38,7 @@ def test_find_multiple_elements_by_path(self):
         self.assertEqual('UICatalog', el[0].get_attribute('name'))
         self.assertEqual(None, el[1].get_attribute('name'))
 
+
 if __name__ == "__main__":
     suite = unittest.TestLoader().loadTestsFromTestCase(FindByIOClassChainTests)
     unittest.TextTestRunner(verbosity=2).run(suite)
diff --git a/test/functional/ios/safari_tests.py b/test/functional/ios/safari_tests.py
@@ -30,6 +30,7 @@ def test_get(self):
         self.driver.get("http://google.com")
         self.assertEqual('Google', self.driver.title)
 
+
 if __name__ == "__main__":
     suite = unittest.TestLoader().loadTestsFromTestCase(SafariTests)
     unittest.TextTestRunner(verbosity=2).run(suite)

-Original file line number
+Diff line change
 astroid
 isort
 pylint
 +autopep8