Tooling updates (#388)

* Upgrade ruff and use it for formatting as well
* Lint
* Move coverage config to .coveragerc
* Add a Ruff GH action for inline annotations

Author: zerolab

.coveragerc

@@ -0,0 +1,38 @@
+[run]
+branch = True
+concurrency = multiprocessing, thread
+parallel = True
+source_pkgs = grapple
+omit = **/migrations/*,docs/*,tests/*
+
+[paths]
+source = grapple,.tox/py*/**/site-packages
+
+[report]
+show_missing = True
+ignore_errors = True
+skip_covered = True
+skip_empty = true
+
+# Regexes for lines to exclude from consideration
+exclude_also =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self.debug
+    if settings.DEBUG
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
+
+    # Nor complain about type checking
+    "if TYPE_CHECKING:",
+    class .*\bProtocol\):
+    @(abc\.)?abstractmethod

.github/workflows/ruff.yml

@@ -0,0 +1,21 @@
+name: Ruff
+
+on:
+  push:
+    branches:
+      - main
+      - 'stable/**'
+  pull_request:
+    branches: [main]
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - run: python -Im pip install --user ruff
+
+    - name: Run ruff
+      run: ruff --output-format=github grapple

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ ci:
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: check-yaml
       - id: check-toml
@@ -17,20 +17,12 @@ repos:
       - id: detect-private-key
       - id: end-of-file-fixer
       - id: check-added-large-files
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.9.1
-    hooks:
-      - id: black
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.0.287'
+    rev: 'v0.3.7'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
-  - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.16.0
-    hooks:
-      - id: blacken-docs
-        additional_dependencies: [black==23.9.1]
+      - id: ruff-format
   - repo: https://github.com/rtts/djhtml
     rev: 3.0.6
     hooks:

README.md

@@ -7,8 +7,8 @@
 # Wagtail Grapple
 
 [![Build status](https://github.com/torchbox/wagtail-grapple/actions/workflows/ci.yml/badge.svg)](https://github.com/torchbox/wagtail-grapple/actions)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![PyPi](https://img.shields.io/pypi/v/wagtail-grapple.svg)](https://pypi.org/project/wagtail-grapple/)
-[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/torchbox/wagtail-grapple/main.svg)](https://results.pre-commit.ci/latest/github/torchbox/wagtail-grapple/main)
 
 A library to build GraphQL endpoints easily so you can grapple your Wagtail data from anywhere!

grapple/exceptions.py

@@ -4,5 +4,3 @@ class IllegalDeprecation(Exception):
 
     This is invalid - a deprecated entity must be nullable.
     """
-
-    pass

grapple/helpers.py

@@ -64,6 +64,7 @@ def register_field_middleware(field_name: str, middleware_list: list):
 def register_query_field(
     field_name,
     plural_field_name=None,
+    *,
     query_params=None,
     required=False,
     plural_required=False,
@@ -184,6 +185,7 @@ def resolve_plural(self, _, info, **kwargs):
 def register_paginated_query_field(
     field_name,
     plural_field_name=None,
+    *,
     query_params=None,
     required=False,
     plural_required=False,
@@ -300,7 +302,7 @@ def resolve_plural(self, _, info, **kwargs):
 
 
 def register_singular_query_field(
-    field_name, query_params=None, required=False, middleware=None
+    field_name, *, query_params=None, required=False, middleware=None
 ):
     def inner(cls):
         field_type = lambda: registry.models[cls]  # noqa: E731

grapple/models.py

@@ -17,7 +17,12 @@ class GraphQLField:
     deprecation_reason: Optional[str]
 
     def __init__(
-        self, field_name: str, field_type: type = None, required: bool = None, **kwargs
+        self,
+        field_name: str,
+        field_type: type = None,
+        *,
+        required: bool = None,
+        **kwargs,
     ):
         # Initiate and get specific field info.
         self.field_name = field_name
@@ -81,17 +86,14 @@ def Mixin():
         (app_label, model) = snippet_model.lower().split(".")
         mdl = apps.get_model(app_label, model)
 
-        if mdl:
-            field_type = lambda: registry.snippets[mdl]  # noqa: E731
-        else:
-            field_type = graphene.String
+        field_type = (lambda: registry.snippets[mdl]) if mdl else graphene.String
 
         return GraphQLField(field_name, field_type, **kwargs)
 
     return Mixin
 
 
-def GraphQLForeignKey(field_name, content_type, is_list=False, **kwargs):
+def GraphQLForeignKey(field_name, content_type, **kwargs):
     def Mixin():
         field_type = None
         if isinstance(content_type, str):

grapple/settings.py

@@ -9,6 +9,7 @@
 Wagtail Grapple settings, checking for user settings first, then falling
 back to the defaults.
 """
+
 import logging
 
 from django.conf import settings as django_settings

grapple/types/images.py

@@ -197,6 +197,7 @@ def resolve_src_set(
         info: GraphQLResolveInfo,
         sizes: list[int],
         format: str | None = None,
+        *,
         preserve_svg: bool = True,
         **kwargs,
     ) -> str:

grapple/types/streamfield.py

@@ -172,11 +172,11 @@ def resolve_blocks(self, info, **kwargs):
 
         for field, value in stream_data.items():
             block = dict(child_blocks)[field]
-            if issubclass(type(block), blocks.ChooserBlock) or not issubclass(
-                type(block), blocks.StructBlock
+            if isinstance(value, int) and (
+                issubclass(type(block), blocks.ChooserBlock)
+                or not issubclass(type(block), blocks.StructBlock)
             ):
-                if isinstance(value, int):
-                    value = block.to_python(value)
+                value = block.to_python(value)
 
             stream_blocks.append(StructBlockItem(field, block, value))