Adopt pre-commit for linting and formatting (#1188)

* Add pre-commit-config

For formatting and linting.

* Run `pre-commit run -a`

* Update the CI config to use pre-commit instead of tox

* Fix test for django client

* Fix handling of bytes / str in some places

* Open file in text mode instead of binary + decode

.github/workflows/main.yml

@@ -41,10 +41,6 @@ jobs:
       - name: Install test dependencies
         run: pip install tox
 
-      # Lint before running unit tests
-      - name: Run lint
-        run: tox -e lint
-
       - name: Run tests
         run: |
           tox -e tests -- -n 4 tests/test_browser.py tests/test_element_list.py tests/test_request_handler.py tests/test_xpath_concat.py
@@ -59,8 +55,6 @@ jobs:
     strategy:
       matrix:
         include:
-          - PY_VER: py37
-            python-version: 3.7
           - PY_VER: py38
             python-version: 3.8
           - PY_VER: py39
@@ -101,8 +95,6 @@ jobs:
     strategy:
       matrix:
         include:
-          - PY_VER: py37
-            python-version: 3.7
           - PY_VER: py38
             python-version: 3.8
           - PY_VER: py39
@@ -125,3 +117,24 @@ jobs:
       - name: Run Selenium tests
         run: |
           tox -e tests_selenium -- -n 4 tests/test_element_is_visible.py tests/test_screenshot.py tests/test_shadow_root.py tests/test_mouse_interaction.py tests/test_async_finder.py tests/test_html_snapshot.py tests/test_iframes.py tests/test_popups.py tests/test_webdriver.py tests/test_webdriver_firefox.py tests/test_webdriver_chrome.py;
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: install pre-commit
+        run: pip install pre-commit
+
+      - name: pre-commit cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pre-commit
+          key: "pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}"
+          restore-keys: "pre-commit-"
+
+      - run: pre-commit run --all-files --show-diff-on-failure

.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.10.0
+    hooks:
+      - id: reorder-python-imports
+        args:
+          - "--py38-plus"
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.10.1
+    hooks:
+      - id: pyupgrade
+        args:
+          - "--py38-plus"
+
+  - repo: https://github.com/asottile/add-trailing-comma
+    rev: v3.0.1
+    hooks:
+      - id: add-trailing-comma
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.282
+    hooks:
+      - id: ruff

Makefile

@@ -22,9 +22,6 @@ test: dependencies clean
 	@echo "Running all tests..."
 	tox -- $(which)
 
-format: clean dependencies
-	@flake8 --max-line-length 110 ./splinter ./tests
-
 coverage: dependencies clean
 	@echo "Running all tests with coverage..."
 	@coverage run run_tests.py -w $(which) && coverage report

docs/_templates/genindex.html

@@ -1,4 +1,4 @@
 {% extends "!genindex.html" %}
 
 {% block bodyclass %}{% endblock %}
-{% block sidebarwrapper %}{% endblock %}
+{% block sidebarwrapper %}{% endblock %}

docs/_templates/modindex.html

@@ -1,3 +1,3 @@
 {% extends "!modindex.html" %}
 {% block bodyclass %}{% endblock %}
-{% block sidebarwrapper %}{% endblock %}
+{% block sidebarwrapper %}{% endblock %}

docs/_templates/search.html

@@ -1,3 +1,3 @@
 {% extends "!search.html" %}
 {% block bodyclass %}{% endblock %}
-{% block sidebarwrapper %}{% endblock %}
+{% block sidebarwrapper %}{% endblock %}

docs/api/index.rst

@@ -20,4 +20,3 @@ Welcome to the Splinter API documentation! Check what's inside:
    element-list
    request-handling
    exceptions
-

docs/api/request-handling.rst

@@ -11,4 +11,3 @@ Request handling
 
 .. autoclass:: splinter.request_handler.status_code.StatusCode
    :members:
-

docs/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # splinter documentation build configuration file, created by
 # sphinx-quickstart on Sat Jan  8 23:31:41 2011.
@@ -10,12 +9,10 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
-
 import os
 import sys
 from datetime import datetime
@@ -47,8 +44,8 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"Splinter"
-copyright = u"{}, cobrateam".format(datetime.now().year)
+project = "Splinter"
+copyright = f"{datetime.now().year}, cobrateam"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -109,7 +106,7 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    'collapse_navigation': False,
+    "collapse_navigation": False,
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -192,7 +189,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ("index", "splinter.tex", u"splinter Documentation", u"andrews medina", "manual")
+    ("index", "splinter.tex", "splinter Documentation", "andrews medina", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -223,4 +220,4 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [("index", "splinter", u"splinter Documentation", [u"andrews medina"], 1)]
+man_pages = [("index", "splinter", "splinter Documentation", ["andrews medina"], 1)]

docs/selenium-keys.rst

@@ -24,4 +24,4 @@ With Splinter's type() method, you can use Selenium's Keys implementation.
     browser.type(Keys.RETURN)
 
 The full list of all supported keys can be found at the official Selenium documentation:
-`selenium.webdriver.common.keys <https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html>`_
+`selenium.webdriver.common.keys <https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html>`_

ruff.toml

@@ -0,0 +1,2 @@
+exclude = ["docs"]
+line-length = 120

samples/test_facebook_events.py

@@ -1,18 +1,15 @@
-# -*- coding: utf-8 -*-
-
 # Copyright 2012 splinter authors. All rights reserved.
 # Use of this source code is governed by a BSD-style
 # license that can be found in the LICENSE file.
-
 """
 This snippet show how to "test" a Facebook feature: the creation of an event.
 
 It creates an event by going to http://www.facebook.com, login and navigate to "Create an event" page.
 """
-
 import os
-import unittest
 import time
+import unittest
+
 from splinter import Browser
 
 
@@ -30,7 +27,7 @@ def do_login_if_need(self, username, password):
             self.browser.fill("email", username)
             self.browser.fill("pass", password)
             self.browser.find_by_css(
-                'div.menu_login_container input[type="submit"]'
+                'div.menu_login_container input[type="submit"]',
             ).first.click()
             assert self.browser.is_element_present_by_css("li#navAccount")
 
@@ -49,12 +46,15 @@ def test_create_event(self):
 
         # Uploading the picture
         picture_path = os.path.join(
-            os.path.abspath(os.path.dirname(__file__)), "img", "turtles.jpg"
+            os.path.abspath(os.path.dirname(__file__)),
+            "img",
+            "turtles.jpg",
         )
         self.browser.find_by_css("div.eventEditUpload a.uiButton").first.click()
 
         if not self.browser.is_element_present_by_css(
-            "iframe#upload_pic_frame", wait_time=10
+            "iframe#upload_pic_frame",
+            wait_time=10,
         ):
             self.fail("The upload pic iframe didn't appear :(")
 
@@ -68,7 +68,8 @@ def test_create_event(self):
         self.browser.fill("name", "Splinter sprint")
         self.browser.fill("location", "Rio de Janeiro, Brazil")
         self.browser.fill(
-            "desc", "For more info, check out the #cobratem channel on freenode!"
+            "desc",
+            "For more info, check out the #cobratem channel on freenode!",
         )
 
         self.browser.find_by_css('label.uiButton input[type="submit"]').first.click()

samples/test_google_search.py

@@ -1,10 +1,9 @@
 #!/usr/bin/env python
-
 # Copyright 2012 splinter authors. All rights reserved.
 # Use of this source code is governed by a BSD-style
 # license that can be found in the LICENSE file.
-
 import unittest
+
 from splinter import Browser
 
 

setup.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright 2012 splinter authors. All rights reserved.
 # Use of this source code is governed by a BSD-style
 # license that can be found in the LICENSE file.
@@ -10,7 +9,7 @@
 
 def read(filename: str) -> str:
     path = os.path.join(os.path.dirname(__file__), filename)
-    with open(path, "r") as f:
+    with open(path) as f:
         return f.read()
 
 

splinter/__init__.py

@@ -1,13 +1,13 @@
 # Copyright 2016 splinter authors. All rights reserved.
 # Use of this source code is governed by a BSD-style
 # license that can be found in the LICENSE file.
-
 from splinter.browser import Browser
 from splinter.config import Config
-from splinter.version import __version_info__, __version__  # NOQA
+from splinter.version import __version__  # noqa: F401
+from splinter.version import __version_info__  # noqa: F401
 
 
 __all__ = [
-    'Browser',
-    'Config',
+    "Browser",
+    "Config",
 ]