chore: use black as a formatter for Python (microsoft#32)

Author: mxschmitt

.github/workflows/ci.yml

@@ -39,6 +39,8 @@ jobs:
         python -m pip install --upgrade pip
         pip install -r local-requirements.txt
         pip install .
+    - name: Lint
+      run: black --check .
     - name: Build driver
       run: python build_driver.py
       env:

build_driver.py

@@ -17,27 +17,30 @@
 import shutil
 import subprocess
 
-driver_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'driver')
-package_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'playwright')
-drivers_path = os.path.join(package_path, 'drivers')
+driver_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "driver")
+package_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "playwright")
+drivers_path = os.path.join(package_path, "drivers")
 
-if os.path.exists(os.path.join(driver_path, 'package-lock.json')):
-  os.remove(os.path.join(driver_path, 'package-lock.json'))
-if os.path.exists(os.path.join(driver_path, 'node_modules')):
-  shutil.rmtree(os.path.join(driver_path, 'node_modules'))
-if os.path.exists(os.path.join(driver_path, 'out')):
-  shutil.rmtree(os.path.join(driver_path, 'out'))
+if os.path.exists(os.path.join(driver_path, "package-lock.json")):
+    os.remove(os.path.join(driver_path, "package-lock.json"))
+if os.path.exists(os.path.join(driver_path, "node_modules")):
+    shutil.rmtree(os.path.join(driver_path, "node_modules"))
+if os.path.exists(os.path.join(driver_path, "out")):
+    shutil.rmtree(os.path.join(driver_path, "out"))
 
-subprocess.run('npm i', cwd=driver_path, shell=True)
-subprocess.run('npm run bake', cwd=driver_path, shell=True)
+subprocess.run("npm i", cwd=driver_path, shell=True)
+subprocess.run("npm run bake", cwd=driver_path, shell=True)
 
-for driver in ['driver-linux', 'driver-macos', 'driver-win.exe']:
-  if os.path.exists(os.path.join(package_path, driver)):
-    os.remove(os.path.join(package_path, driver))
+for driver in ["driver-linux", "driver-macos", "driver-win.exe"]:
+    if os.path.exists(os.path.join(package_path, driver)):
+        os.remove(os.path.join(package_path, driver))
 
-  in_path = os.path.join(driver_path, 'out', driver)
-  out_path = os.path.join(drivers_path, driver + '.gz')
-  with open(in_path, 'rb') as f_in, gzip.open(out_path, 'wb') as f_out:
-    shutil.copyfileobj(f_in, f_out)
+    in_path = os.path.join(driver_path, "out", driver)
+    out_path = os.path.join(drivers_path, driver + ".gz")
+    with open(in_path, "rb") as f_in, gzip.open(out_path, "wb") as f_out:
+        shutil.copyfileobj(f_in, f_out)
 
-shutil.copyfile(os.path.join(driver_path, 'node_modules', 'playwright', 'browsers.json'), os.path.join(drivers_path, 'browsers.json'))
+shutil.copyfile(
+    os.path.join(driver_path, "node_modules", "playwright", "browsers.json"),
+    os.path.join(drivers_path, "browsers.json"),
+)

build_package.py

@@ -17,11 +17,11 @@
 import subprocess
 
 folder = os.path.dirname(os.path.abspath(__file__))
-if os.path.exists(os.path.join(folder, 'build')):
-  shutil.rmtree(os.path.join(folder, 'build'))
-if os.path.exists(os.path.join(folder, 'dist')):
-  shutil.rmtree(os.path.join(folder, 'dist'))
-if os.path.exists(os.path.join(folder, 'playwright.egg-info')):
-  shutil.rmtree(os.path.join(folder, 'playwright.egg-info'))
+if os.path.exists(os.path.join(folder, "build")):
+    shutil.rmtree(os.path.join(folder, "build"))
+if os.path.exists(os.path.join(folder, "dist")):
+    shutil.rmtree(os.path.join(folder, "dist"))
+if os.path.exists(os.path.join(folder, "playwright.egg-info")):
+    shutil.rmtree(os.path.join(folder, "playwright.egg-info"))
 
-subprocess.run('python setup.py sdist bdist_wheel', shell=True)
+subprocess.run("python setup.py sdist bdist_wheel", shell=True)

client.py

@@ -16,57 +16,67 @@
 
 from playwright import browser_types
 
+
 async def run():
-    print('Launching browser...')
-    browser = await browser_types['webkit'].launch(headless=False)
-    print('Contexts in browser: %d' % len(browser.contexts))
-    print('Creating context...')
+    print("Launching browser...")
+    browser = await browser_types["webkit"].launch(headless=False)
+    print("Contexts in browser: %d" % len(browser.contexts))
+    print("Creating context...")
     context = await browser.newContext(viewport=None)
-    print('Contexts in browser: %d' % len(browser.contexts))
-    print('Pages in context: %d' % len(context.pages))
+    print("Contexts in browser: %d" % len(browser.contexts))
+    print("Pages in context: %d" % len(context.pages))
 
-    print('\nCreating page1...')
+    print("\nCreating page1...")
     page1 = await context.newPage()
-    print('Pages in context: %d' % len(context.pages))
-    page1.on('framenavigated', lambda frame: print('Frame navigated to %s' % frame.url))
-    page1.on('request', lambda request: print('Request %s' % request.url))
-    page1.on('requestFinished', lambda request: print('Request finished %s' % request.url))
-    page1.on('response', lambda response: print('Response %s, request %s in frame %s' % (response.url, response.request.url, response.frame.url)))
-    print('Navigating page1 to https://example.com...')
-    await page1.goto('https://example.com')
-    print('Page1 main frame url: %s' % page1.mainFrame.url)
-    print('Page1 tile: %s' % await page1.title())
-    print('Frames in page1: %d' % len(page1.frames))
-    await page1.screenshot(path='example.png')
+    print("Pages in context: %d" % len(context.pages))
+    page1.on("framenavigated", lambda frame: print("Frame navigated to %s" % frame.url))
+    page1.on("request", lambda request: print("Request %s" % request.url))
+    page1.on(
+        "requestFinished", lambda request: print("Request finished %s" % request.url)
+    )
+    page1.on(
+        "response",
+        lambda response: print(
+            "Response %s, request %s in frame %s"
+            % (response.url, response.request.url, response.frame.url)
+        ),
+    )
+    print("Navigating page1 to https://example.com...")
+    await page1.goto("https://example.com")
+    print("Page1 main frame url: %s" % page1.mainFrame.url)
+    print("Page1 tile: %s" % await page1.title())
+    print("Frames in page1: %d" % len(page1.frames))
+    await page1.screenshot(path="example.png")
 
-    print('\nCreating page2...')
+    print("\nCreating page2...")
     page2 = await context.newPage()
-    page2.on('framenavigated', lambda frame: print('Frame navigated to %s' % frame.url))
+    page2.on("framenavigated", lambda frame: print("Frame navigated to %s" % frame.url))
 
-    print('Navigating page2 to https://webkit.org...')
-    await page2.goto('https://webkit.org')
-    print('Page2 tile: %s' % await page2.title())
-    print('Pages in context: %d' % len(context.pages))
+    print("Navigating page2 to https://webkit.org...")
+    await page2.goto("https://webkit.org")
+    print("Page2 tile: %s" % await page2.title())
+    print("Pages in context: %d" % len(context.pages))
 
-    print('\nQuerying body...')
-    body1 = await page1.querySelector('body')
-    print('Body text %s' % await body1.textContent())
+    print("\nQuerying body...")
+    body1 = await page1.querySelector("body")
+    print("Body text %s" % await body1.textContent())
 
-    print('Closing page1...')
+    print("Closing page1...")
     await page1.close()
-    print('Pages in context: %d' % len(context.pages))
+    print("Pages in context: %d" % len(context.pages))
 
-    print('Navigating page2 to https://cnn.com...')
-    await page2.goto('https://cnn.com')
-    print('Page2 main frame url: %s' % page2.mainFrame.url)
-    print('Page2 tile: %s' % await page2.title())
-    print('Frames in page2: %d' % len(page2.frames))
-    print('Pages in context: %d' % len(context.pages))
+    print("Navigating page2 to https://cnn.com...")
+    await page2.goto("https://cnn.com")
+    print("Page2 main frame url: %s" % page2.mainFrame.url)
+    print("Page2 tile: %s" % await page2.title())
+    print("Frames in page2: %d" % len(page2.frames))
+    print("Pages in context: %d" % len(context.pages))
 
-    print('Closing context...')
+    print("Closing context...")
     await context.close()
-    print('Contexts in browser: %d' % len(browser.contexts))
-    print('Closing browser')
+    print("Contexts in browser: %d" % len(browser.contexts))
+    print("Closing browser")
     await browser.close()
 
+
 asyncio.get_event_loop().run_until_complete(run())

docs/development.md

@@ -1,29 +1,40 @@
 # Development
 
-Build driver:
+## Build driver:
+
 ```sh
 python ./build_driver.py
 ```
 
-Run tests:
+## Run tests:
+
 ```sh
 pytest
 ```
 
-Run tests with coverage:
+## Run tests with coverage:
+
 ```sh
 pytest --cov=playwright --cov-report html
 open htmlcov/index.html
 ```
 
-Deploy:
+## Deploy:
+
 ```sh
 python ./build_package.py
 ... check
 python ./upload_package.py
 ```
 
-Checking for typing errors
+## Checking for typing errors
+
 ```sh
 mypy playwright
 ```
+
+## Format the code
+
+```sh
+black .
+```

local-requirements.txt

@@ -7,3 +7,4 @@ mypy==0.782
 setuptools==49.1.0
 twisted==20.3.0
 wheel==0.34.2
+black==19.10b0

playwright/__init__.py

@@ -22,11 +22,4 @@
 browser_types = playwright_object.browser_types
 TimeoutError = helper.TimeoutError
 
-__all__ = [
-  'browser_types',
-  'chromium',
-  'firefox',
-  'webkit',
-  'devices',
-  'TimeoutError'
-]
+__all__ = ["browser_types", "chromium", "firefox", "webkit", "devices", "TimeoutError"]

playwright/accessibility.py

@@ -17,14 +17,15 @@
 from playwright.element_handle import ElementHandle
 from typing import Dict
 
-class Accessibility:
 
-  def __init__(self, channel: Channel) -> None:
-    self._channel = channel
+class Accessibility:
+    def __init__(self, channel: Channel) -> None:
+        self._channel = channel
 
-  async def snapshot(self,
-      interestingOnly: bool = None,
-      root: ElementHandle = None
+    async def snapshot(
+        self, interestingOnly: bool = None, root: ElementHandle = None
     ) -> Dict:
-    root = root._channel if root else None
-    return await self._channel.send('snapshot', dict(root=root, interestingOnly=interestingOnly))
+        root = root._channel if root else None
+        return await self._channel.send(
+            "snapshot", dict(root=root, interestingOnly=interestingOnly)
+        )