Replacement of flake8 with Ruff

borgbase / vorta

Desktop Backup Client for Borg Backup

https://vorta.borgbase.com

GNU General Public License v3.0

1.99k stars 132 forks source link

Replacement of flake8 with Ruff #1980

Open SAMAD101 opened 6 months ago

SAMAD101 commented 6 months ago

Description

This PR removes flake8 from .pre-commit-config.yaml , setup.cfg and adds ruff for linting

Related Issue

Resolves #1969

Motivation and Context

ruff is faster so yeah...

How Has This Been Tested?

Manually tested, pre-commit, make lint works fine.

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] I have read the CONTRIBUTING guide.
[x] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.

I provide my contribution under the terms of the license of this repository and I affirm the Developer Certificate of Origin.

shivansh02 commented 6 months ago

Screenshot from 2024-04-05 01-21-00

I tried checking E201 and E241 of flake8 but ruff couldn't catch them and were fixed by black.

Hofer-Julian commented 5 months ago

I tried checking E201 and E241 of flake8 but ruff couldn't catch them and were fixed by black.

Both rules are marked as preview, so I assume they will only be enabled in the next ruff release: https://docs.astral.sh/ruff/rules/#error-e

shivansh02 commented 5 months ago

I tried checking E201 and E241 of flake8 but ruff couldn't catch them and were fixed by black.

Both rules are marked as preview, so I assume they will only be enabled in the next ruff release: https://docs.astral.sh/ruff/rules/#error-e

That makes sense. But I tried some stable ones (E501 and E703), failed to catch them also. @SAMAD101 can you check if this is working for you?

shivansh02 commented 5 months ago

Also since more than half of the pycodestyle rules are still in preview, should we enable ruff's preview mode or wait for them to get stable before trying to replace flake8?

SAMAD101 commented 5 months ago

I tried checking E201 and E241 of flake8 but ruff couldn't catch them and were fixed by black.

Might be because it had to configured in ruff.toml Works fine now. Checked

SAMAD101 commented 5 months ago

I tried checking E201 and E241 of flake8 but ruff couldn't catch them and were fixed by black.

Both rules are marked as preview, so I assume they will only be enabled in the next ruff release: https://docs.astral.sh/ruff/rules/#error-e

That makes sense. But I tried some stable ones (E501 and E703), failed to catch them also. @SAMAD101 can you check if this is working for you?

Those seem to be working fine as well. You can check them using: ruff check src/ --preview --select <rule_code>

SAMAD101 commented 5 months ago

You should reset your fork's master brach to upstream since it is diverged for a long time already.

will do

m3nu commented 5 months ago

Just to be clear slow linting isn't a problem we have. So this change should also simplify the config in some way or make it easier to run.

SAMAD101 commented 5 months ago

Just to be clear slow linting isn't a problem we have. So this change should also simplify the config in some way or make it easier to run.

yeah, it does somewhat simplify the cofigs. And linting is just as easy to run as it was, we can use pre-commit or 'ruff check'