rebase, tweak ruff settings for our needs

Author: x0rw

.github/auto-pr-tests/test_runner.py

@@ -1,7 +1,7 @@
-import subprocess
+import difflib
 import re
+import subprocess
 from pathlib import Path
-import difflib
 
 
 def normalize_ids(text: str) -> str:

builder/build_cli.py

@@ -7,12 +7,13 @@
 # dependencies globally). Each book should have a `make.py` script that updates
 # the submodules, import this shared module, and calls the main function here.
 
-from pathlib import Path
 import argparse
-import subprocess
-import requests
 import json
+import subprocess
 import time
+from pathlib import Path
+
+import requests
 
 # Automatically watch the following extra directories when --serve is used.
 EXTRA_WATCH_DIRS = ["exts", "themes"]

exts/coding_guidelines/fls_checks.py

@@ -21,6 +21,7 @@ class FLSValidationError(SphinxError):
 def check_fls(app, env):
     """Main checking function for FLS validation"""
     # First make sure all guidelines have correctly formatted FLS IDs
+    #
     check_fls_exists_and_valid_format(app, env)
     offline_mode = env.config.offline
 

exts/coding_guidelines/std_role.py

@@ -1,9 +1,10 @@
 # SPDX-License-Identifier: MIT OR Apache-2.0
 # SPDX-FileCopyrightText: The Coding Guidelines Subcommittee Contributors
 
+from urllib.parse import quote
+
 from docutils import nodes
 from sphinx.roles import SphinxRole
-from urllib.parse import quote
 
 
 class StdRefRole(SphinxRole):

exts/coding_guidelines/write_guidelines_ids.py

@@ -6,8 +6,10 @@
 import json
 import os
 from collections import defaultdict
+
 import sphinx
 from sphinx_needs.data import SphinxNeedsData
+
 from .common import logger
 
 

generate-guideline-templates.py

@@ -3,8 +3,8 @@
 # SPDX-FileCopyrightText: The Coding Guidelines Subcommittee Contributors
 
 import argparse
-import string
 import random
+import string
 from textwrap import dedent, indent
 
 # Configuration
@@ -118,11 +118,6 @@ def generate_id(prefix):
 
 def generate_guideline_template():
     """Generate a complete guideline template with all required sections."""
-    # Generate IDs for all sections
-    guideline_id = generate_id("gui")
-    rationale_id = generate_id("rat")
-    non_compliant_example_id = generate_id("non_compl_ex")
-    compliant_example_id = generate_id("compl_ex")
 
     template = guideline_rst_template(
         guideline_title="Title Here",

generate_guideline_templates.py

@@ -3,6 +3,7 @@
 # SPDX-FileCopyrightText: The Coding Guidelines Subcommittee Contributors
 
 import os
+
 from builder import build_cli
 
 build_cli.main(os.path.abspath(os.path.dirname(__file__)))

make.py

@@ -22,17 +22,22 @@ builder = { workspace = true }
 
 [tool.ruff]
 # line-length = 88
+
 lint.select = [
-  # "E", 
-  # "F",  
-  # "W",
-  # "C",
-  # "I",
-  # "Q", 
-  # "B",  
+  "F",        # Pyflakes rules
+  "W",        # PyCodeStyle warnings
+  "E",        # PyCodeStyle errors
+  "I",        # Sort Imports
+  "TID",      # Some good import practices
+  "C4",       # Catch incorrect use of comprehensions, dict, list, etc
 ]
 # Remove or reduce ignores to catch more issues
-# ignore = []
+lint.ignore = [
+    "E501",  # Ignore long lines, bc we use them frequently while composing .rst templates
+    "W293",  # Ignore white spaces in blank lines
+    "W291",  # Ignore Trailing white lines
+    "E402",  # Ignore "Imports must be at the top of the file" enforcement bc `auto-pr-helper.py` needs it
+]
 # extend-ignore = []
 
 [tool.ruff.lint.flake8-comprehensions]

pyproject.toml

@@ -1,9 +1,10 @@
+import argparse
 import json
+import os
 import re
-import argparse
 import sys
-import os
 from textwrap import indent
+
 from m2r import convert
 
 scriptpath = "../"
@@ -26,7 +27,7 @@ def extract_form_fields(issue_body: str) -> dict:
     This function parses issues json into a dict of important fields
     """
 
-    fields = {v: "" for v in issue_header_map.values()}
+    fields = dict.fromkeys(issue_header_map.values(), "")
 
     lines = issue_body.splitlines()
     current_key = None