Lint codebase with ruff (and substitute black)

[roberto-arista]

Hey!

Here's a PR with my implementation proposal for ruff in the drawBot codebase. In a nutshell:

• it adds a lint.yml file with instructions to format the code and auto-commit it back to the codebase
• therefore test.yml needs to start once the auto-commit is completed (workflow_run section)
• it adds a ruff.toml configuration file
• it adds the ruff-api package that allows calling ruff from the python codebase to substitute black (application menu > python > format code)

I've had mixed results with triggering one action from another when writing back some changes in the repo, we might explore different options eventually. Also, the ruff-api would like to have a filename to format the code (I guess for imports?), have a look at the FIXME here: drawBot/ui/drawBotController.py

That's it, let me know what you think!

👋

[justvanrossum]

Thanks!

Not a big fan of autocommit, and I would prefer a pre-commit based approach that does apply fixes. What I do in other projects:

• Use pre-commit (locally), that runs black and flake8, which will fix issues, but aborts the commit if it had to do anything
• Use pre-commit also as a GHA step, that will fail if it has any complaints

Ideally I would like to see two separate PRs:

1. Reformat + lint the entire code base
2. Set up GHA / pre-commit to make sure the code base stays nicely formatted and lint-clean

[roberto-arista]

on my way : )

[roberto-arista]

I would convert this one to PR1 and open another one for GHA

[justvanrossum]

I left a few minor comments. LGTM, apart from the test failure.

[roberto-arista]

I'll wait for this one to be merged before working on the github actions logic.

[justvanrossum]

LGTM

[justvanrossum]

@typemytype, shall we merge soon? I fear it will cause merge conflicts if we don't. Case in point: #582.

[typemytype]

Sure, this is awesome! Is there a PR merge order?

[justvanrossum]

Is there a PR merge order?

No... In this case, If we merge PR A first, PR B will (likely) have a conflict. Maybe merge this one first.

[roberto-arista]

im ooo, but I agree with Just, let's merge the linted code first, I'll work on the hook and workflow next week : )

[justvanrossum]

(Oooh we got lucky: there was no merge conflict!)

[typemytype]

thanks @roberto-arista !!

[roberto-arista]

ty!