[Feature Request]: deprecate old linters/formatter, switch to ruff

[as3ii]

Problem Description

I'm opening this issue after PR #1018 to discuss how to implement the switch, in particular:

• which rules to enable (https://docs.astral.sh/ruff/rules/)
• which rules to disable
• python target version (https://docs.astral.sh/ruff/settings/#target-version)
• max line length (https://docs.astral.sh/ruff/settings/#line-length)
• CI integration (https://docs.astral.sh/ruff/integrations/#github-actions)

Proposed Solution

• Enabled rules:
  The default enabled rules are: E4 E7 E9 F
  I usually enable the following rules: E W I N D UP ASYNC S BLE B A COM C4 DTZ EM FA ISC ICN LOG G PIE PYI Q RSE RET SLF SIM TID TCH INT ARG TD FIX ERA PL TRY PERF FURB DOC RUF
• Disabled rules:
  I usually disable only specific rules when strictly necessary
• Python target version: the oldest one you want to support (3.10?)
• max line length: 120?
• I usually don't touch other linter/formatter settings
• the above-linked documentation contains a good basic workflow, I suggest to enable it filtering when it runs, with something like

on:
  push:
    branches:
      - 'main'
      - 'develop'
    paths:
      - '**.py'
      - 'pyproject.toml'
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]
  merge_group:
  workflow_dispatch:

Alternatives Considered

There aren't many ruff alternatives, just stick with the old linters/formatter (maybe with better configurations), and run them one by one manually

Additional Information

ruff can be configured with its dedicated config file, or via pyproject.toml

[DJ2LS]

Problem Description

* which rules to enable (https://docs.astral.sh/ruff/rules/)

* which rules to disable

* python target version (https://docs.astral.sh/ruff/settings/#target-version)

* max line length (https://docs.astral.sh/ruff/settings/#line-length)

* CI integration (https://docs.astral.sh/ruff/integrations/#github-actions)

Proposed Solution

* Enabled rules:
  The default enabled rules are: `E4 E7 E9 F`
  I _usually_ enable the following rules: `E W I N D UP ASYNC S BLE B A COM C4 DTZ EM FA ISC ICN LOG G PIE PYI Q RSE RET SLF SIM TID TCH INT ARG TD FIX ERA PL TRY PERF FURB DOC RUF`

* Disabled rules:
  I _usually_ disable only specific rules when strictly necessary

I think we shouldnt disable rules, but as a start we should start with the default ones and then slowly increase the linting rules. In past I had some issues with linting, so doing this step by step might be the "save way". And I guess its also easier to review then.

* Python target version: the oldest one you want to support (3.10?)

I think we should support all Python Versions except EOL. So yes, for now its 3.10

* max line length: 120?

I'm not sure about line length tbh, but personally I feel more might be sometimes better. Too short line length make it sometimes hard to read the code. Whats your personal preference?

* I usually don't touch other linter/formatter settings

* the above-linked documentation contains a good basic workflow, I suggest to enable it filtering when it runs, with something like

on:
push:
branches:
- 'main'
- 'develop'
paths:
- '**.py'
- 'pyproject.toml'
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
merge_group:
workflow_dispatch:

looks god to me.

Alternatives Considered

There aren't many ruff alternatives, just stick with the old linters/formatter (maybe with better configurations), and run them one by one manually

ruff looks good to me.

Additional Information

ruff can be configured with its dedicated config file, or via pyproject.toml

using the pyproject.toml might be a good way.

[as3ii]

I think we shouldnt disable rules, but as a start we should start with the default ones and then slowly increase the linting rules. In past I had some issues with linting, so doing this step by step might be the "save way". And I guess its also easier to review then

Makes sense 👍🏻

I'm not sure about line length tbh, but personally I feel more might be sometimes better. Too short line length make it sometimes hard to read the code. Whats your personal preference?

ruff by default uses 88 characters as max line length, personally I like to set it between 100 and 120 characters

In the next few days I'll submit a draft PR with the basic settings of ruff, after your review I'll start fixing the reported problems and adding them to the PR, if you agree with this plan

[DJ2LS]

Merges your PR. Some more changes and adjustments might be needed as I merged my other work as well because of my time issues.

[as3ii]

Merges your PR. Some more changes and adjustments might be needed as I merged my other work as well because of my time issues.

do you need help to fix your newly added code? Or will you take care of it?

[DJ2LS]

I appreciate every help.
We can increase the formatter to line length of 120. I think that's fine.

[DJ2LS]

The actual goal is fixing all issues with tests and check-in we can merge and create a new release.

[DJ2LS]

@as3ii in PR 0.18.0 is also an issue caused by the path change. We should definitely fix this before merging. I suggest continuing discussion there for having all in one place