Pre-commit: add Ruff

[edoardob90]

Fixes #255

• Replaces flake8 and all its enabled plugins with Ruff
• Use Ruff formatter as a drop-in replacement of Black
• Simplifies the configuration using a single pyproject.toml instead of multiple files (pytest.ini, flake8).

[edoardob90]

There are a few errors to fix in the code (or to add to the ignore, while it's not the ideal way):

• TRY003: Avoid specifying long messages outside the exception class
• E741: Ambiguous variable name

[Snowwpanda]

Thanks for starting this, since a change on flake8 pre-commit is not passing, so why not add ruff in one go. I fixed the places where pre-commit was not passing, don't understand enough about the rest though, so someone else should approve or I will read later.

[edoardob90]

I think this is good to go.

Just a comment on why we ignore B904 from the object-oriented tests: we do want to raise an assertion error if the check on the solution function attributes fails, but Python by default will raise a TypeError via vars(solution_result) if the result is not a class and therefore doesn't have a __dict__ attribute.

[despadam]

I think this is good to go.

Just a comment on why we ignore B904 from the object-oriented tests: we do want to raise an assertion error if the check on the solution function attributes fails, but Python by default will raise a TypeError via vars(solution_result) if the result is not a class and therefore doesn't have a __dict__ attribute.

Thanks for the explanation! Can we document this in a comment?

[despadam]

I tried testing it and this is what happens in my case:

[edoardob90]

I tried testing it and this is what happens in my case:

Seems okay to me. It's the "annoying" yaml formatter that keeps replacing 2 spaces with 4. Many editors are okay with 2. It happens to me as well. We could actually fix this...

[edoardob90]

I think the problem with yaml formatting is fixed now.

[edoardob90]

I think this is good to go.
Just a comment on why we ignore B904 from the object-oriented tests: we do want to raise an assertion error if the check on the solution function attributes fails, but Python by default will raise a TypeError via vars(solution_result) if the result is not a class and therefore doesn't have a __dict__ attribute.

Thanks for the explanation! Can we document this in a comment?

Good idea: I added it in 9bdfe5d

[despadam]

I think the problem with yaml formatting is fixed now.

I keep having problems with YAML (check) and YAML (format). Check always complains about wrong new line character: expected \n, even after I fix it. Format always fails. Maybe I am doing something wrong? We can have a look together during tomorrow's meeting.

[Snowwpanda]

I tried testing it and this is what happens in my case:

Ah and here i thought this was just me, after seeing you have the same issue, this seems to be a known problem:
jumanjihouse/pre-commit-hook-yamlfmt#32
where windows path is messed up, i ran on codespaces (linux env) where it worked fine. but since some of us are using windows this isn't so nice.

[Snowwpanda]

I could fix the YAML formating using the pull request fix they have. Instead of
rev 0.2.3
i used
rev: 71af8556bfcf12745fdfdb3ed57b6698b444f58c
See here for the PR:
jumanjihouse/pre-commit-hook-yamlfmt#42
And the discussion:
jumanjihouse/pre-commit-hook-yamlfmt#25 (comment)
Not sure if this is a nice fix though, but i think its that or leave the hook out entirely

[edoardob90]

I could fix the YAML formating using the pull request fix they have. Instead of rev 0.2.3 i used rev: 71af8556bfcf12745fdfdb3ed57b6698b444f58c See here for the PR: jumanjihouse/pre-commit-hook-yamlfmt#42 And the discussion: jumanjihouse/pre-commit-hook-yamlfmt#25 (comment) Not sure if this is a nice fix though, but i think its that or leave the hook out entirely

My memory didn't help me here: I already raised this problem last year. There were indeed a few users running the tutorial locally, and that means 99% of the times on Windows.

[edoardob90]

Okay, I found an alternative formatter that should work on Windows as well. Please, Windows people, double check. I know it's marginally relevant since most people will use Codespaces/Binder/whatever.

[despadam]

Yaml format works for me now, but Yaml lint still fails.

[edoardob90]

@despadam @Snowwpanda As discussed, I removed yamllint. Everything works, including the formatting. Also, we have already a basic check-yaml hook built-in in pre-commit. I think it's enough for our purposes.

[despadam]

Works as expected now, thanks!