Fix tabs, add ruff and black

Author: pamelafox

.github/workflows/python.yaml

@@ -0,0 +1,34 @@
+name: Python checks
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Test with Python ${{ matrix.python_version }}
+    runs-on: ubuntu-latest
+    strategy:
+        fail-fast: false
+        matrix:
+          python_version: ["3.9", "3.10", "3.11"]
+    steps:
+        - uses: actions/checkout@v3
+        - name: Set up Python 3
+          uses: actions/setup-python@v3
+          with:
+            python-version: ${{ matrix.python_version }}
+        - name: Install dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install poetry
+            poetry install
+        - name: Lint with ruff
+          run: ruff .
+        - name: Check formatting with black
+          run: black . --check --verbose
+        - name: Run unit tests
+          run: |
+            poetry run pytest

CONTRIBUTING.md

@@ -6,13 +6,13 @@ Install [poetry](https://python-poetry.org/).
 
 Install the project dependencies:
 
-```
+```sh
 poetry install
 ```
 
 Run the tests:
 
-```
+```sh
 poetry run pytest
 ```
 
@@ -21,32 +21,32 @@ poetry run pytest
 
 Set credentials for PyPi:
 
-```
+```sh
 poetry config pypi-token.pypi <token>
 ```
 
 Build the wheels:
 
-```
+```sh
 poetry build
 ```
 
 Publish to PyPi:
 
-```
+```sh
 poetry publish
 ```
 
 ## Documentation
 
 Build locally:
 
-```
+```sh
 mkdocs serve
 ```
 
 Deploy to GitHub Pages:
 
-```
+```sh
 mkdocs gh-deploy
 ```

README.md

@@ -42,4 +42,8 @@ For more examples see [documentation](https://pamelafox.github.io/axe-playwright
 
 ## Contributing
 
-See [guide on contributing](CONTRIBUTING.md).
+See [guide on contributing](CONTRIBUTING.md).
+
+## Acknowledgments
+
+This project is based on [axe-core-python](https://github.com/ruslan-rv-ua/axe-core-python) by @ruslan-rv-ua and also takes inspiration from [axe-selenium-python](https://pypi.org/project/axe-selenium-python/) for output formats.

axe_playwright_python/__init__.py

@@ -1 +1 @@
-__version__ = '0.1.0'
+__version__ = "0.1.0"

axe_playwright_python/base.py

@@ -1,10 +1,9 @@
+import json
+import os
 from abc import ABC, abstractmethod
 from pathlib import Path
-import os
-import json
 from string import Template
 
-
 AXE_FILE_NAME = "axe.min.js"
 AXE_FILE_PATH = Path(__file__).parent / AXE_FILE_NAME
 
@@ -56,8 +55,7 @@ def from_file(cls, axe_min_js_path: str | Path) -> "AxeBase":
         return cls(axe_script=axe_script)
 
 
-class AxeResults():
-
+class AxeResults:
     def __init__(self, response: dict):
         self.response = response
 
@@ -66,7 +64,7 @@ def violations_count(self) -> int:
         """
         Number of violations found.
         """
-        return len(self.response['violations'])
+        return len(self.response["violations"])
 
     def generate_snapshot(self):
         """
@@ -75,22 +73,22 @@ def generate_snapshot(self):
         <violation-id> (impact) : <number-of-nodes>
         """
         snapshot_lines = []
-        for v in self.response['violations']:
+        for v in self.response["violations"]:
             snapshot_lines.append(f"{v['id']} ({v['impact']}) : {len(v['nodes'])}")
-        return '\n'.join(snapshot_lines)
+        return "\n".join(snapshot_lines)
 
     def __violation_report(self, violation: dict, template: Template) -> str:
         nodes_str = ""
         for num, node in enumerate(violation["nodes"], start=1):
-            targets = ', '.join(node["target"])
+            targets = ", ".join(node["target"])
             nodes_str += f"\n\n\t{num})\tTarget: {targets}"
-            snippet = node.get('html').replace('\n', '')
+            snippet = node.get("html").replace("\n", "")
             nodes_str += f"\n\t\tSnippet: {snippet}"
             nodes_str += "\n\t\tMessages:"
             for item in node.get("all", []) + node.get("any", []) + node.get("none", []):
                 nodes_str += "\n\t\t* " + item["message"]
         return template.substitute(violation, elements=nodes_str)
-    
+
     def generate_report(self, violation_id: str | None = None) -> str:
         """
         Return readable report of accessibility violations found.
@@ -109,9 +107,10 @@ def generate_report(self, violation_id: str | None = None) -> str:
                 continue
             report_str += self.__violation_report(violation, template)
         return report_str
-    
-    def save_to_file(self, file_path: str | Path | None = None,
-                     violations_only: bool = False) -> None:
+
+    def save_to_file(
+        self, file_path: str | Path | None = None, violations_only: bool = False
+    ) -> None:
         """Save results to file.
         @param results: Results from Axe analysis
         @param file_path: File path for saving results file
@@ -126,5 +125,3 @@ def save_to_file(self, file_path: str | Path | None = None,
             cwd = Path.cwd()
             file_path = cwd / "results.json"
         Path(file_path).write_text(json.dumps(response, indent=4))
-
-

axe_playwright_python/sync_playwright.py

@@ -19,7 +19,7 @@ def run(
             options (dict | None, optional): options.
                 Defaults to {"resultTypes": ["violations"]}.
 
-        For more information on `context` and `options`, 
+        For more information on `context` and `options`,
             view the [axe-core documentation]().
 
         Returns:

axe_playwright_python/violations.txt

@@ -1,7 +1,7 @@
 Rule Violated:
 $id - $description
-    URL: $helpUrl
-    Impact Level: $impact
-    Tags: $tags
-    Elements Affected:
-    $elements
+	URL: $helpUrl
+	Impact Level: $impact
+	Tags: $tags
+	Elements Affected:
+	$elements

examples/usage.py

@@ -1,5 +1,5 @@
-from playwright.sync_api import sync_playwright
 from axe_core_python.sync_playwright import Axe
+from playwright.sync_api import sync_playwright
 
 axe = Axe()
 
@@ -8,4 +8,4 @@
     page = browser.new_page()
     page.goto("https://www.google.com")
     results = axe.run(page)
-    browser.close()
+    browser.close()

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "axe-playwright-python"
-version = "0.1.1"
+version = "0.1.2"
 description = "Automated web accessibility testing using axe-core engine and Playwright."
 authors = ["Pamela Fox <[email protected]>"]
 readme = "README.md"
@@ -12,15 +12,17 @@ classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
     "Topic :: Adaptive Technologies",
     "Topic :: Software Development",
     "Topic :: Software Development :: Quality Assurance",
     "Topic :: Software Development :: Testing",
 ]
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = "^3.9"
 playwright = "^1.36.0"
 
 [tool.poetry.dev-dependencies]
@@ -35,3 +37,14 @@ flake8 = "^6.0.0"
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+select = ["E", "F", "I", "UP"]
+ignore = ["D203"]
+show-source = true
+
+[tool.black]
+line-length = 100
+target-version = ["py39"]

tests/test_axe_async_playwright.py

@@ -2,9 +2,10 @@
 
 import pytest
 import pytest_asyncio
-from axe_playwright_python.async_playwright import Axe
 from playwright.async_api import async_playwright
 
+from axe_playwright_python.async_playwright import Axe
+
 TEST_FILE = "test_page.html"
 TEST_FILE_PATH = Path(__file__).parent.absolute() / TEST_FILE