Adopt Ruff

Author: AA-Turner

.github/workflows/lint.yml

@@ -0,0 +1,38 @@
+name: Lint source code
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+env:
+  FORCE_COLOR: "1"
+  UV_SYSTEM_PYTHON: "1"  # make uv do global installs
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+
+    - name: Install Ruff
+      uses: astral-sh/ruff-action@v3
+      with:
+        args: --version
+        version: 0.9.2
+
+    - name: Lint with Ruff
+      run: ruff check --output-format=github
+
+    - name: Format with Ruff
+      run: ruff format --diff

.github/workflows/workflow.yml

@@ -7,25 +7,6 @@ env:
   FORCE_COLOR: "1"
 
 jobs:
-  check:
-    runs-on: ubuntu-latest
-
-    # We want to run on external PRs, but not on our own internal PRs as they'll be run
-    # by the push to the branch.
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
-
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-      with:
-        python-version: "3"
-        cache: pip
-        cache-dependency-path: .github/workflows/workflow.yml
-    - name: Black
-      run: |
-        pip install black
-        black --check --exclude /docs --diff .
-
   build-wheel:
     runs-on: ubuntu-latest
     steps:

.ruff.toml

@@ -0,0 +1,42 @@
+target-version = "py39"  # Pin Ruff to Python 3.9
+line-length = 88
+output-format = "full"
+
+[format]
+quote-style = "double"
+docstring-code-format = true
+
+[lint]
+select = [
+#    "C4",    # flake8-comprehensions
+#    "B",     # flake8-bugbear
+    "E",     # pycodestyle
+#    "F",     # pyflakes
+    "FA",    # flake8-future-annotations
+    "FLY",   # flynt
+    "FURB",  # refurb
+#    "G",     # flake8-logging-format
+    "I",     # isort
+    "LOG",   # flake8-logging
+    "PERF",  # perflint
+#    "PGH",   # pygrep-hooks
+#    "PT",    # flake8-pytest-style
+#    "TC",    # flake8-type-checking
+#    "UP",    # pyupgrade
+    "W",     # pycodestyle
+]
+ignore = [
+    "E501",  # Ignore line length errors (we use auto-formatting)
+]
+
+[lint.flake8-type-checking]
+exempt-modules = []
+strict = true
+
+[lint.isort]
+forced-separate = [
+    "tests",
+]
+required-imports = [
+    "from __future__ import annotations",
+]

README.md

@@ -6,6 +6,8 @@
 # %load_ext autoreload
 # %autoreload 2
 
+from __future__ import annotations
+
 import random
 from pathlib import Path
 from textwrap import dedent

docs/script/generate_social_card_previews.py

@@ -10,6 +10,9 @@
 # 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.
 #
+
+from __future__ import annotations
+
 import os
 import sys
 from subprocess import run

docs/source/conf.py

@@ -11,6 +11,8 @@
 ref: https://nox.thea.codes/
 """
 
+from __future__ import annotations
+
 from shlex import split
 
 import nox

noxfile.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 from pathlib import Path
 from typing import Any, Dict

sphinxext/opengraph/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import string
 from collections.abc import Set
 

sphinxext/opengraph/descriptionparser.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from html.parser import HTMLParser
 
 

sphinxext/opengraph/metaparser.py

@@ -1,5 +1,7 @@
 """Build a PNG card for each page meant for social media."""
 
+from __future__ import annotations
+
 import hashlib
 from pathlib import Path
 

sphinxext/opengraph/socialcards.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from html.parser import HTMLParser
 
 

sphinxext/opengraph/titleparser.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pathlib import Path
 
 import pytest

tests/conftest.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-arbitrary-tags/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-custom-tags/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-description-length/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-double-spacing/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-first-image-no-image/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-first-image/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-image-rel-paths/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-image/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-list/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-local-image/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-meta-name-description-manual-description/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-meta-name-description-manual-og-description/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-meta-name-description/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-nested-lists/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-overrides-complex/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-overrides-disable/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-overrides-simple/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-quotation-marks/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-rtd-default/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-rtd-invalid/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-simple/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 project = "Project name"

tests/roots/test-sitename-from-project/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-sitename/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-skip-admonitions/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-skip-code-block/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-skip-comments/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-skip-raw/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-skip-title/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-social-cards-svg/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 extensions = ["sphinxext.opengraph"]
 
 master_doc = "index"

tests/roots/test-type/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import conftest
 import pytest
 from sphinx.application import Sphinx