Replace formatting tools and pylint with ruff (#786)

* Also, remove superfluous rules from `.yamllint`

Author: grahamalama

.pre-commit-config.yaml

@@ -16,9 +16,9 @@ repos:
       - id: trailing-whitespace
   - repo: local
     hooks:
-      - id: pylint
-        name: pylint
-        entry: bin/lint.sh pylint
+      - id: lint
+        name: lint
+        entry: bin/lint.sh lint
         language: script
         types: [python]
   - repo: local
@@ -43,16 +43,9 @@ repos:
         language: script
   - repo: local
     hooks:
-      - id: isort
-        name: isort
-        entry: bin/lint.sh isort
-        language: script
-        types: [python]
-  - repo: local
-    hooks:
-      - id: black
-        name: black
-        entry: bin/lint.sh black
+      - id: format
+        name: format
+        entry: bin/lint.sh format
         language: script
         types: [python]
   - repo: local

.yamllint

@@ -1,20 +1,6 @@
 ---
-
 extends: default
 
-ignore: |
-  jbi/
-  tests/
-  bin/
-  .github/
-  docker-compose.yaml
-  .pre-commit-config.yaml
-
-
 rules:
   key-duplicates: enable
 
-
-yaml-files:
-  - 'config/*.yaml'
-  - '.yamllint'

Makefile

@@ -16,8 +16,8 @@ help:
 	@echo ""
 	@echo "Local"
 	@echo "  clean         - clean local cache folders"
-	@echo "  format        - run formatters (black, isort), fix in place"
-	@echo "  lint          - run linters"
+	@echo "  format        - run linting checks, fix in place"
+	@echo "  lint          - run linting checks"
 	@echo "  start         - run the API service locally"
 	@echo "  test          - run test suite"
 	@echo ""
@@ -31,7 +31,7 @@ help:
 .PHONY: clean
 clean:
 	find . -name "__pycache__" | xargs rm -rf
-	rm -rf .mypy_cache .pytest_cache .coverage .venv
+	rm -rf .mypy_cache .ruff_cache .coverage .venv
 
 $(VENV)/bin/python:
 	python3 -m venv $(VENV)
@@ -49,8 +49,8 @@ build:
 
 .PHONY: format
 format: $(INSTALL_STAMP)
-	bin/lint.sh black --fix
-	bin/lint.sh isort --fix
+	bin/lint.sh lint --fix
+	bin/lint.sh format --fix
 
 .PHONY: lint
 lint: $(INSTALL_STAMP)

asgi.py

@@ -1,7 +1,6 @@
 import uvicorn
 
 from jbi.environment import get_settings
-from jbi.log import CONFIG as LOGGING_CONFIG
 
 settings = get_settings()
 

bin/lint.sh

@@ -4,83 +4,83 @@ set -e
 
 POETRY_RUN="poetry run"
 
-bandit () {
-  $POETRY_RUN bandit -lll --recursive jbi
-}
-black () {
-  $POETRY_RUN black ${check:+--check} jbi tests
-}
-detect_secrets () {
-  # Scan only files fixed into the repo, omit poetry.lock
-  FILES_TO_SCAN=`git ls-tree --full-tree -r --name-only HEAD | grep -v poetry.lock`
-  $POETRY_RUN detect-secrets-hook $FILES_TO_SCAN --baseline .secrets.baseline
-}
-isort () {
-  $POETRY_RUN isort ${check:+--check-only} .
-}
-pylint () {
-  $POETRY_RUN pylint jbi tests
-}
-mypy () {
-  $POETRY_RUN mypy jbi
-}
-yamllint () {
-  $POETRY_RUN yamllint -c .yamllint config/*.yaml
-}
+BANDIT_CMD="$POETRY_RUN bandit -lll --recursive jbi"
+
+FORMAT_CMD="$POETRY_RUN ruff format ."
+
+# Scan only files fixed into the repo, omit poetry.lock
+DETECT_SECRETS_FILES="$(git ls-tree --full-tree -r --name-only HEAD | grep -v poetry.lock)"
+DETECT_SECRETS_CMD="$POETRY_RUN detect-secrets-hook $DETECT_SECRETS_FILES --baseline .secrets.baseline"
+  
+LINT_CMD="$POETRY_RUN ruff ."
+
+MYPY_CMD="$POETRY_RUN mypy jbi"
+
+YAMLLINT_CMD="$POETRY_RUN yamllint -c .yamllint config/*.yaml"
+
 all () {
-  echo "running black"
-  black
-  echo "running isort"
-  isort
+  echo "running bandit"
+  $BANDIT_CMD
+  echo "running format"
+  $FORMAT_CMD
+  echo "running detect-secrets"
+  $DETECT_SECRETS_CMD
+  echo "running lint"
+  $LINT_CMD
   echo "running mypy"
-  mypy
-  echo "running pylint"
-  pylint
+  $MYPY_CMD
   echo "running yamllint"
-  yamllint
-  echo "running bandit"
-  bandit
-  echo "running detect_secrets"
-  detect_secrets
+  $YAMLLINT_CMD
 }
 
 usage () {
-  echo "Usage: bin/lint.sh [OPTION]"
-  echo " run linting checks"
-  echo "Options":
+  echo "Usage: bin/lint.sh [subcommand] [--fix]"
+  echo " run linting checks, and optionally fix in place (if available)"
+  echo "Subcommand":
   echo "  bandit"
-  echo "  black [--fix]"
   echo "  detect-secrets"
-  echo "  isort [--fix]"
+  echo "  format"
+  echo "  lint"
   echo "  mypy"
-  echo "  pylint"
   echo "  yamllint"
 }
 
-subcommand='';
-check="true"
-if [ -z $1 ]; then
+if [ -z "$1" ]; then
   all
 else
   subcommand=$1; shift
   case $subcommand in
-    "black" | "isort")
-      case $1 in
-        "--fix")
-          check=""
-        ;;
-      esac
-      case $subcommand in
-        "isort") isort;;
-        "black") black;;
-      esac
-    ;;
-
-    "pylint") pylint;;
-    "yamllint") yamllint;;
-    "mypy") mypy;;
-    "bandit") bandit;;
-    "detect-secrets") detect_secrets;;
-    *) usage;;
+    "format") 
+      if [ -n "$1" ] && [ "$1" != "--fix" ]; then
+        usage
+      else
+        check_flag="--check"
+        [ "$1" = "--fix" ] && check_flag=""
+        $FORMAT_CMD ${check_flag:-}
+      fi
+      ;;
+    "lint")
+      if [ -n "$1" ] && [ "$1" != "--fix" ]; then
+        usage
+      else
+        $LINT_CMD ${1:-}
+      fi
+      ;;
+    "yamllint")
+      $YAMLLINT_CMD
+      ;;
+    "mypy")
+      $MYPY_CMD
+      ;;
+    "bandit")
+      $BANDIT_CMD
+      ;;
+    "detect-secrets")
+      $DETECT_SECRETS_CMD
+      ;;
+    *) 
+      usage
+      ;;
   esac
 fi
+

jbi/models.py

@@ -110,11 +110,11 @@ class Actions(RootModel):
     @functools.cached_property
     def by_tag(self) -> Mapping[str, Action]:
         """Build mapping of actions by lookup tag."""
-        # pylint: disable-next=not-an-iterable
+
         return {action.whiteboard_tag: action for action in self.root}
 
     def __iter__(self):
-        return iter(self.root)  # pylint: disable=not-an-iterable
+        return iter(self.root)
 
     def __len__(self):
         return len(self.root)
@@ -129,7 +129,7 @@ def get(self, tag: Optional[str]) -> Optional[Action]:
     @functools.cached_property
     def configured_jira_projects_keys(self) -> set[str]:
         """Return the list of Jira project keys from all configured actions"""
-        # pylint: disable-next=not-an-iterable
+
         return {action.jira_project_key for action in self.root}
 
     @field_validator("root")
@@ -192,7 +192,7 @@ class BugzillaWebhookEvent(BaseModel):
 
     def changed_fields(self) -> list[str]:
         """Returns the names of changed fields in a bug"""
-        # pylint: disable-next=not-an-iterable
+
         return [c.field for c in self.changes] if self.changes else []
 
 
@@ -246,7 +246,7 @@ def extract_from_see_also(self, project_key):
             return None
 
         candidates = []
-        for url in self.see_also:  # pylint: disable=not-an-iterable
+        for url in self.see_also:
             try:
                 parsed_url: ParseResult = urlparse(url=url)
                 host_parts = parsed_url.hostname.split(".")

jbi/services/__init__.py

@@ -1,3 +1,5 @@
 """Exports the bugzilla and jira services modules for convenience"""
 
 from . import bugzilla, jira
+
+__all__ = ["bugzilla", "jira"]