feat: migrate to ruff for linting and formatting #2530

banteg · 2025-02-26T05:11:44Z

Summary

Replace black, isort, flake8, and various flake8 plugins with ruff
Configure ruff to maintain the same coding style and linting rules
Update pre-commit hooks to use ruff for formatting and linting

Test plan

The project should build and pass all tests
Code formatting should be consistent with previous style
No functional changes were made, only tooling updates

🤖 Generated with Claude Code

banteg · 2025-02-26T05:20:03Z

lint fails are expected because the linters are removed and replaced with a different pipeline, both in pyproject and ci

antazoey

It looks like ruff found a lot of helpful stuff the other tools missed which is pretty cool. I don't like the if / elif change though.

antazoey · 2025-02-26T05:36:56Z

.pre-commit-config.yaml

@@ -43,4 +33,4 @@ repos:
        additional_dependencies: [mdformat-gfm, mdformat-frontmatter, mdformat-pyproject]

 default_language_version:
-    python: python3
+    python: python3


Suggested change

python: python3

python: python3

antazoey · 2025-02-26T05:37:19Z

pyproject.toml


 [tool.mdformat]
-number = true
+number = true


Suggested change

number = true

number = true

antazoey · 2025-02-26T05:38:48Z

src/ape/__init__.py

@@ -26,35 +26,34 @@ def __getattr__(name: str):
    if name not in __all__:
        raise AttributeError(name)

-    elif name == "reverts":
+    if name == "reverts":


I've always preferred elif in these cases in case you need to switch from returning here to building up a return (have had a rookie mistakes back in the day from that).

Can we disable this rule?

- Replace black, flake8, isort with unified ruff tooling - Disable RET (flake8-return) and SIM (flake8-simplify) rules per maintainer feedback - Remove some opinionated code style rewrites that would change if/elif patterns - Maintain existing code style preferences for conditionals

banteg · 2025-02-26T11:59:15Z

i disabled the rules you don't want, but there is a bunch more to go through. im handing off this pr at this point, it's up to your prefernce which of the remaining rules you like and which you find annoying. you can tune the active rules in pyproject.toml.

you can find all the rules here https://docs.astral.sh/ruff/rules/

ruff check src --statistics
88	BLE001 	[ ] blind-except
85	PGH003 	[ ] blanket-type-ignore
66	RUF012 	[ ] mutable-class-default
18	C416   	[*] unnecessary-comprehension
17	B904   	[ ] raise-without-from-inside-except
16	C408   	[*] unnecessary-collection-call
 7	B007   	[*] unused-loop-control-variable
 6	ERA001 	[*] commented-out-code
 6	C417   	[*] unnecessary-map
 4	B028   	[*] no-explicit-stacklevel
 4	PIE810 	[*] multiple-starts-ends-with
 3	C414   	[*] unnecessary-double-cast-or-process
 2	B012   	[ ] jump-statement-in-finally
 2	TC003  	[*] typing-only-standard-library-import
 2	PTH123 	[ ] builtin-open
 2	UP028  	[*] yield-in-for-loop
 1	C401   	[*] unnecessary-generator-set
 1	C409   	[*] unnecessary-literal-within-tuple-call
 1	C419   	[*] unnecessary-comprehension-in-call
 1	PT003  	[*] pytest-extraneous-scope-function
 1	TC001  	[*] typing-only-first-party-import
 1	PTH101 	[ ] os-chmod
 1	PTH118 	[ ] os-path-join
 1	PLW0127	[ ] self-assigning-variable
 1	PLW1509	[ ] subprocess-popen-preexec-fn
 1	RUF005 	[ ] collection-literal-concatenation
 1	RUF015 	[*] unnecessary-iterable-allocation-for-first-element

- Replace black, isort, and flake8 with ruff check and ruff format - Maintain same CI validation functionality with new tooling 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>

- Replace black, isort, and flake8 with ruff check and ruff format in GitHub Actions - Remove unnecessary Black configuration from pyproject.toml - Complete migration from multiple linting tools to unified Ruff toolchain 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>

fubuloubu · 2025-02-26T13:54:56Z

I saw it raises for print but does it raise for breakpoint?

banteg · 2025-02-26T14:04:04Z

I saw it raises for print but does it raise for breakpoint?

i think it's the T100 rule

see https://docs.python-guide.org/writing/gotchas/#late-binding-closures

banteg · 2025-02-28T04:32:39Z

i went through all ruff rules with claude and updated the config to better fit the existing code style. this is what it had to say:

Our refined Ruff configuration successfully addresses all the linting issues across both the src and tests directories.

Here's a summary of the key aspects of our final configuration:

Selected Rule Categories:
- Core Python errors and style rules (E, F, W)
- Import sorting (I)
- Code quality with Bugbear (B)
- Code simplification (SIM, C4)
- Modern Python (UP)
- Return statement improvements (RET)
- Security (S)
- Type checking (TCH)
Key Ignored Rules:
- Code style preferences that would require major refactoring
- Rules that didn't match the project style (like naming conventions)
- Security rules that had legitimate uses in this specific codebase
- Common patterns in the codebase that might be flagged as issues
Per-file Overrides:
- Test files have relaxed rules for docstrings, line length, and assertions
- Fixture files allow unused imports and variables
- Integration test project files allow unused variables where needed

This configuration provides a good balance of code quality enforcement while respecting the existing patterns in the codebase. It can be applied incrementally, focusing first on the most critical issues before gradually addressing more stylistic concerns.

fubuloubu · 2025-02-28T05:38:41Z

pyproject.toml

+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"


antazoey reviewed Feb 26, 2025

View reviewed changes

banteg added 3 commits February 26, 2025 15:37

style: apply ruff formatting to codebase

c4602c3

fix: disable FBT rules per maintainer feedback

d42812b

banteg force-pushed the feat/ruff branch from 1a6daba to d42812b Compare February 26, 2025 11:54

banteg added 2 commits February 26, 2025 16:34

ci: update GitHub Actions workflow to use ruff

3ff35f1

- Replace black, isort, and flake8 with ruff check and ruff format - Maintain same CI validation functionality with new tooling 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>

banteg force-pushed the feat/ruff branch from 5b388c7 to 0999f38 Compare February 26, 2025 12:57

banteg mentioned this pull request Feb 26, 2025

docs: add codebase analysis documentation #2529

Open

banteg added 4 commits February 28, 2025 08:16

fix: yoda statements

0df4117

fix: late binding closures

bfbc3e5

see https://docs.python-guide.org/writing/gotchas/#late-binding-closures

fix: noqa for ruff

c9f3a3d

lint: update ruff config

dcf4363

lint: detect breakpoint and todo comments

47afd33

fubuloubu approved these changes Feb 28, 2025

View reviewed changes

pyproject.toml

]

[tool.ruff.lint.pydocstyle]

convention = "google"

Copy link

Member

fubuloubu Feb 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh sick

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: migrate to ruff for linting and formatting #2530

feat: migrate to ruff for linting and formatting #2530

banteg commented Feb 26, 2025

banteg commented Feb 26, 2025

antazoey left a comment

antazoey Feb 26, 2025

antazoey Feb 26, 2025

antazoey Feb 26, 2025

banteg commented Feb 26, 2025

fubuloubu commented Feb 26, 2025

banteg commented Feb 26, 2025

banteg commented Feb 28, 2025

fubuloubu Feb 28, 2025

feat: migrate to ruff for linting and formatting #2530

Are you sure you want to change the base?

feat: migrate to ruff for linting and formatting #2530

Conversation

banteg commented Feb 26, 2025

Summary

Test plan

banteg commented Feb 26, 2025

antazoey left a comment

Choose a reason for hiding this comment

antazoey Feb 26, 2025

Choose a reason for hiding this comment

antazoey Feb 26, 2025

Choose a reason for hiding this comment

antazoey Feb 26, 2025

Choose a reason for hiding this comment

banteg commented Feb 26, 2025

fubuloubu commented Feb 26, 2025

banteg commented Feb 26, 2025

banteg commented Feb 28, 2025

fubuloubu Feb 28, 2025

Choose a reason for hiding this comment