refactor: add ruff linting

Author: solarissmoke

.github/workflows/publish.yml

@@ -18,9 +18,9 @@ jobs:
         python-version: ["3.10"]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

.github/workflows/test.yml

@@ -13,6 +13,17 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  lint-python:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          ref: ${{ github.ref }}
+      - uses: astral-sh/ruff-action@v3
+        with:
+          version: "0.14.x"
+      - run: ruff check --fix
+      - run: ruff format --check --diff
   test-sqlite:
     name: SQlite, Python ${{ matrix.python-version }}, Django ${{ matrix.django-version }}
     runs-on: ubuntu-latest
@@ -25,7 +36,7 @@ jobs:
           - django-version: 42
             python-version: 3.13
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v5
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
@@ -57,7 +68,7 @@ jobs:
           POSTGRES_PASSWORD: treebeard
           POSTGRES_DB: treebeard
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v5
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
@@ -92,7 +103,7 @@ jobs:
         ports:
           - 3306/tcp
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v5
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
@@ -127,7 +138,7 @@ jobs:
         ports:
           - 1433/tcp
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v5
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.14.0
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format

docs/source/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # django-treebeard documentation build configuration file, created by
 # sphinx-quickstart on Tue Nov 22 00:05:34 2016.
@@ -14,16 +13,17 @@
 
 import os
 import sys
+
 import django
 from django.conf import settings
 
 # 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.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '_ext')))
+sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
 
 settings.configure(
-    INSTALLED_APPS=['treebeard'],
+    INSTALLED_APPS=["treebeard"],
 )
 django.setup()
 
@@ -36,42 +36,42 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'djangodocs',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.coverage',
-    'sphinx.ext.graphviz',
-    'sphinx.ext.inheritance_diagram',
-    'sphinx.ext.todo',
-    'sphinx.ext.intersphinx',
+    "djangodocs",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.inheritance_diagram",
+    "sphinx.ext.todo",
+    "sphinx.ext.intersphinx",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'django-treebeard'
-copyright = u'2016, Gustavo Picón'
-author = u'Gustavo Picón'
+project = "django-treebeard"
+copyright = "2016, Gustavo Picón"
+author = "Gustavo Picón"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '4'
+version = "4"
 # The full version, including alpha/beta/rc tags.
-release = '4.7'
+release = "4.7"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -106,7 +106,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -122,7 +122,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = "default"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -151,7 +151,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -214,30 +214,26 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'django-treebearddoc'
+htmlhelp_basename = "django-treebearddoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-# 'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-# 'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-# 'preamble': '',
-
-# Latex figure (float) alignment
-# 'figure_align': 'htbp',
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  (master_doc, 'django-treebeard.tex', u'django-treebeard Documentation',
-   u'Gustavo Picón', 'manual'),
+    (master_doc, "django-treebeard.tex", "django-treebeard Documentation", "Gustavo Picón", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -265,10 +261,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'django-treebeard', u'django-treebeard Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "django-treebeard", "django-treebeard Documentation", [author], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -280,9 +273,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  (master_doc, 'django-treebeard', u'django-treebeard Documentation',
-   author, 'django-treebeard', 'One line description of project.',
-   'Miscellaneous'),
+    (
+        master_doc,
+        "django-treebeard",
+        "django-treebeard Documentation",
+        author,
+        "django-treebeard",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -298,6 +297,6 @@
 # texinfo_no_detailmenu = False
 
 intersphinx_mapping = {
-    'django': ('https://docs.djangoproject.com/en/stable/', 'https://docs.djangoproject.com/en/stable/_objects/'),
-    'python': ('https://docs.python.org/3.13', None),
+    "django": ("https://docs.djangoproject.com/en/stable/", "https://docs.djangoproject.com/en/stable/_objects/"),
+    "python": ("https://docs.python.org/3.13", None),
 }

pyproject.toml

@@ -40,4 +40,17 @@ dependencies = [
 test = [
     "pytest-django>=4.0,<5.0",
     "pytest-pythonpath>=0.7,<1.0",
+]
+
+[tool.ruff]
+line-length = 120
+lint.ignore = [
+    "UP031"     # Allow percent formatters    
+]
+lint.select = [
+    "PLE",   # pylint errors
+    "UP",   # pyupgrade
+    "I",    # isort
+    "F",    # pyflakes
+    "E",    # pycodestyle errors
 ]

tests/admin.py

@@ -1,11 +1,11 @@
 import itertools
 
 from django.contrib import admin
+
+from tests.models import BASE_MODELS, DEP_MODELS, UNICODE_MODELS
 from treebeard.admin import admin_factory
 from treebeard.forms import movenodeform_factory
 
-from tests.models import BASE_MODELS, UNICODE_MODELS, DEP_MODELS
-
 
 def register(admin_site, model):
     form_class = movenodeform_factory(model)

tests/conftest.py

@@ -1,5 +1,5 @@
-"""Pytest configuration file
-"""
+"""Pytest configuration file"""
+
 import os
 
 os.environ["DJANGO_SETTINGS_MODULE"] = "tests.settings"