Support for ruff format

[jpmckinney]

As a fast, equivalent alternative to black: https://astral.sh/blog/the-ruff-formatter

As far as I can tell, I cann't use nbqa to run both the ruff linter ($ ruff) and the ruff formatter ($ ruff format) (I can maybe use addopts to run the formatter instead of the linter – but, in any case, I can't get both to run).

[MarcoGorelli]

hey - doesn't ruff support notebooks now?

[jpmckinney]

Ah, yes, looks like it: https://docs.astral.sh/ruff/faq/#does-ruff-support-jupyter-notebooks

[MarcoGorelli]

cool - closing then, might archive this project then, was fun whilst it lasted 😄

[jpmckinney]

FWIW, ruff format makes other changes to the ipynb file (changing indentation, reordering JSON members, etc.). It doesn't just format the Python code (I would prefer if it could be made to only change Python code, because Google Colab also reformats the ipynb file, and my users often edit notebooks in Colab). I'm sticking with nbqa-black.

I also extend nbqa with custom hooks.

So, nbqa remains independently useful!

[astrojuanlu]

Came here to report this. ruff has 2 subcommands, ruff check (the linter) and ruff format (the formatter). nbqa ruff file.ipynb runs the former and can optionally take --fix, but it's not possible to run the latter.

[MarcoGorelli]

is it not possible to do ruff format file.ipynb?

[astrojuanlu]

Yes, but not through nbqa (this issue)

[MarcoGorelli]

true, i'm just trying to understand why it's necessary that it also works through nbqa

[MarcoGorelli]

cool - closing then, might archive this project then, was fun whilst it lasted 😄

lol how is this tool still getting so many downloads 😄 maybe it's not as dead as i thought

https://pypistats.org/packages/nbqa

Downloads last day: 39,982
Downloads last week: 412,939
Downloads last month: 1,144,428

[MarcoGorelli]

though regarding

ruff format makes other changes to the ipynb file (changing indentation, reordering JSON members, etc.). It doesn't just format the Python code

has this been reported to ruff? it sounds like a bug they may want to fix

[MarcoGorelli]

anyway, reopening in case anyone wants to make a pr (sorry, i'm quite tight on time recently and have other prios, but happy to review)

[astrojuanlu]

lol how is this tool still getting so many downloads 😄 maybe it's not as dead as i thought

It's linked from the official ruff docs, that's how I made it here https://docs.astral.sh/ruff/faq/#does-ruff-support-jupyter-notebooks