Autoformatting

[benjamin-kirkbride]

How do people feel about implementing (and enforcing) autoformatting in Arcade? Specifically:

• Black for code (120 char line length)
• Ruff for imports

Some considerations:

• we would likely need to disable this for sphinx purposes on some files
• git blame can be preserved (inconveniently) using this: https://black.readthedocs.io/en/stable/guides/introducing_black_to_your_project.html#avoiding-ruining-git-blame

[Cleptomania]

As far as ruff goes, we already use it for linting, so using it for the import sorting is trivial.

Really just need to exclude the examples code from autoformatting as far as exclusions go, maybe the experimental directory because there are technically examples in that? Not sure autoformatting matters for any of those though.

I don't think we care about git blame preservation

[einarf]

We definitely don't care about blame preservation.

[Cleptomania]

Things that probably need to happen for this:

1. A single, giant PR for initial conversion
2. Added to the CI to check for formatting(probably not having CI actually do any formatting though)
3. Add a tool to make.py to run it(CI could just use this probably)
4. Update contributing docs for it

[benjamin-kirkbride]

Isn't step one actually some kind of broader consensus? Who needs to sign off?

[benjamin-kirkbride]

Autoformatting the imports may break a bunch of stuff at first, due to.. load bearing import order

[Cleptomania]

Those steps were just like, assuming it was happening, we probably have very little load bearing import order left. The 3.0 work cleaned up a lot of Arcade import. I would probably be in favor of excluding __init__.py files from the formatting though, the top level one is probably a minefield

[eruvanos]

gui is already formated with ruff and I use pre-commit hooks to enforce it on my side.

[pushfoo]

TL;DR: I am very wary of this idea.

The most important part of this (imo) is knowing how to turn it off. The following probably need to be excluded:

• make.py
• examples (as Clepto said above)
• arcade.experimental
• Sphinx stuff
• The top-level utils folder can be fragile (includes more Sphinx stuff)

We're refactoring the utils folder one step at a time (#2109), but it's probably best to leave it alone for now.

As to other auto-formatting options not mentioned above, there are good reasons to disable them in many cases. PEP-8 itself points out that following it dogmatically is bad. I don't think you're proposing we do so, but I'm bringing it up now so we can agree not to do so in the future.

[einarf]

All done

[benjamin-kirkbride]

Did we sort imports too as part of this? Sorry if I missed that

[Cleptomania]

2141 just covered implementing black. Intended to follow up with import sorting separately, I’ll just reopen this for that.

[einarf]

.. or just make separate issue.