Ruff full migration Phase 2: Replace Black with Ruff formatter and enable additional rules Closes #3142 by kami922 · Pull Request #3250 · intelowlproject/IntelOwl

kami922 · 2026-01-30T16:13:21Z

Description

This PR completes Phase 2 of the Ruff migration (following PR #3145), replacing Black formatter with ruff format and enabling additional rule categories.

Summary

Commit 1: Phase 2 - Ruff formatting

Replace Black formatter with ruff format (line-length: 140 → 110)
Enable additional Ruff rule categories: UP (pyupgrade), C4 (comprehensions), DJ (Django)
Update CI/CD: replaced black --check with ruff format --check
Remove black==24.10.0 from test-requirements.txt
Format 345 Python files with Ruff formatter
Add global ignores for UP/C4 rules (defer complex refactors to follow-up PRs)
Add per-file ignores for DJ rules (model field ordering, str methods)

Commit 2: Fix formatting bugs

Fix mutable default list in email_sender.py
Fix 12 files with missing spaces in error messages
Fix typo in websocket.py: "used tried" → "user tried"
Fix variable reference in docguard_get.py
Move jest.setTimeout() into beforeAll() hook

Testing

✅ Local validation: ruff check . PASS (0 errors)
✅ Local validation: ruff format . --check PASS (727 files formatted)
✅ CI validation: act pull_request -j linters PASS

Type of change

Bug fix (non-breaking change which fixes an issue)

Checklist

I have read and understood the rules about how to Contribute
The pull request is for the branch develop
Please avoid adding new libraries as requirements (✅ Only removed black)
Linters (Ruff) gave 0 errors

- Replace Black formatter with ruff format (line-length: 140 → 110) - Enable additional Ruff rule categories: UP (pyupgrade), C4 (comprehensions), DJ (Django) - Update CI/CD: replaced 'black --check' with 'ruff format --check' - Remove black==24.10.0 from test-requirements.txt - Format 345 Python files with Ruff formatter - Add global ignores for UP/C4 rules to defer complex refactors to follow-up PRs - Add per-file ignores for DJ rules (model field ordering, __str__ methods)

- Fix mutable default list in email_sender.py (CCs: List[str] = None) - Fix missing spaces in error messages for readability: - classic_dns_resolver.py: ".Reason" → ". Reason" - circl_pssl.py: ".Template" → ". Template" - circl_pdns.py: ".Template" → ". Template" - zoomeye.py: ".Supported" → ". Supported" - docguard_get.py: ".Supported" → ". Supported" + fix variable reference - spyse.py: ".Supported" → ". Supported" - censys.py: ".Supported" → ". Supported" - triage_search.py: ".Supported" → ". Supported" - threatstream.py: Add spaces between concatenated strings (2 instances) - validin.py: "for{" → "for {" - Fix typo in websocket.py: "used tried" → "user tried" - Move jest.setTimeout() into beforeAll() hook in ScanForm.toastRedirect.test.jsx

Copilot

Pull request overview

This PR completes Phase 2 of the Ruff migration by replacing the Black formatter with Ruff's built-in formatter, reducing the line length from 140 to 110 characters, and enabling additional Ruff rule categories (UP, C4, DJ). The changes include reformatting 345 Python files, updating CI/CD workflows, removing Black as a dependency, and fixing several bugs discovered during the reformatting process.

Changes:

Replaced Black formatter with ruff format and reduced line length to 110 characters
Enabled additional Ruff rules (pyupgrade, comprehensions, Django) with selective ignores
Fixed bugs including mutable default arguments, missing spaces in error messages, and incorrect variable references

Reviewed changes

Copilot reviewed 300 out of 350 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
requirements/test-requirements.txt	Removed black==24.10.0 dependency
pyproject.toml	Updated line-length to 110, added UP/C4/DJ rules with per-file ignores
.github/workflows/pull_request_automation.yml	Replaced Black check with Ruff format check
api_app/connectors_manager/connectors/email_sender.py	Fixed mutable default list argument
api_app/websocket.py	Fixed typo: "used tried" → "user tried"
api_app/analyzers_manager/observable_analyzers/docguard_get.py	Fixed incorrect variable reference from 'hash' to 'self.observable_name'
frontend/tests/components/scan/ScanForm/ScanForm.toastRedirect.test.jsx	Moved jest.setTimeout() into beforeAll() hook
Multiple test files	Reformatted code to comply with 110-character line length

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

frontend/tests/components/scan/ScanForm/ScanForm.toastRedirect.test.jsx

kami922 · 2026-01-30T16:14:10Z

@mlodic Hello

Current Status - 2 Commits Completed

As requested in your "Option 1" feedback, I've created a fresh branch from develop with clean commit history. This PR currently contains the first 2 commits:

Commit 1: Phase 2 - Ruff formatting (348 files)

Replaced Black with ruff format (line-length: 140 → 110)
Enabled UP, C4, DJ rule categories
Updated CI/CD pipeline
Formatted 345 Python files

Commit 2: Fix formatting bugs (13 files)

Fixed mutable default list bug (email_sender.py)
Fixed 12 files with missing spaces after periods in error messages (bugs introduced by Ruff's string compression)
Fixed typo and variable reference issues

All CI checks pass

I have a question about commits 3 & 4 - see next comment.

api_app/serializers/job.py

kami922 · 2026-01-30T16:26:12Z

@mlodic In your "Option 1" approval, you mentioned including commits for:

Commit 3: Fix N818 violations (~20 exception renames)
Commit 4: Fix B904 violations (~117 exception chaining)

After analyzing the codebase, I discovered these changes are more extensive than initially estimated:

N818 Scope (Exception naming - add "Error" suffix)

22 exception classes need renaming (e.g., AnalyzerRunException → AnalyzerRunError)
127+ files use these exceptions and need updates
This is a breaking API change affecting imports and usage throughout the codebase

B904 Scope (Exception chaining - add `raise ... from err`)

~117 exception handlers need individual analysis
Each requires determining whether to use from e or from None
Cannot be automated - needs manual review for correctness

Options

Option A: Keep this PR with 2 commits (formatting + bug fixes), create separate follow-up PRs for N818 and B904

Pros: Clean, focused PR; easier to review; can be merged quickly
Cons: Deviates slightly from "Option 1" structure

Option B: Add commits 3 & 4 to this PR

Pros: Follows "Option 1" exactly as discussed
Cons: Large PR (127+ files for N818 alone); risky breaking changes

Option C: Add N818/B904 to pyproject.toml ignores, defer indefinitely

Pros: Simple, no breaking changes
Cons: Technical debt accumulates

Which approach would you prefer?

mlodic · 2026-01-30T16:42:35Z

option C is fine, thanks!

….test.jsx Co-authored-by: Copilot <[email protected]>

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

mlodic

great work now

mlodic · 2026-01-30T16:47:51Z

I committed the copilot suggestion but I think we are gtg. let's wait for the CI then I'll merge. thanks

kami922 added 2 commits January 30, 2026 20:38

Copilot AI review requested due to automatic review settings January 30, 2026 16:13

Copilot AI reviewed Jan 30, 2026

View reviewed changes

frontend/tests/components/scan/ScanForm/ScanForm.toastRedirect.test.jsx Outdated Show resolved Hide resolved

github-advanced-security bot found potential problems Jan 30, 2026

View reviewed changes

api_app/serializers/job.py Dismissed Show dismissed Hide dismissed

Update frontend/tests/components/scan/ScanForm/ScanForm.toastRedirect…

5c819d9

….test.jsx Co-authored-by: Copilot <[email protected]>

Copilot AI review requested due to automatic review settings January 30, 2026 16:46

Copilot AI reviewed Jan 30, 2026

View reviewed changes

mlodic reviewed Jan 30, 2026

View reviewed changes

mlodic merged commit e17364b into intelowlproject:develop Jan 30, 2026
8 of 9 checks passed

gqvz mentioned this pull request Feb 3, 2026

Remove black from pre-commit #3257

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Ruff full migration Phase 2: Replace Black with Ruff formatter and enable additional rules Closes #3142#3250

Ruff full migration Phase 2: Replace Black with Ruff formatter and enable additional rules Closes #3142#3250
mlodic merged 3 commits intointelowlproject:developfrom
kami922:ruff-full-migration-clean

kami922 commented Jan 30, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

kami922 commented Jan 30, 2026 •

edited

Loading

Uh oh!

Uh oh!

kami922 commented Jan 30, 2026

Uh oh!

mlodic commented Jan 30, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

mlodic left a comment

Uh oh!

mlodic commented Jan 30, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

kami922 commented Jan 30, 2026

Description

Summary

Testing

Type of change

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

kami922 commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Current Status - 2 Commits Completed

Commit 1: Phase 2 - Ruff formatting (348 files)

Commit 2: Fix formatting bugs (13 files)

Uh oh!

Uh oh!

kami922 commented Jan 30, 2026

N818 Scope (Exception naming - add "Error" suffix)

B904 Scope (Exception chaining - add raise ... from err)

Options

Uh oh!

mlodic commented Jan 30, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

mlodic left a comment

Choose a reason for hiding this comment

Uh oh!

mlodic commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kami922 commented Jan 30, 2026 •

edited

Loading

B904 Scope (Exception chaining - add `raise ... from err`)

mlodic commented Jan 30, 2026 •

edited

Loading