[IMPROVEMENT] Update `ruff` rules

[furqan463]

Describe the problem

This issue is inspired by issue PowerGridModel/power-grid-model-io#352.
The PGM-DS is currently behind PGM in terms of ruff lint rules/ checks.

Improvement proposal

Update the list of rules/check in pyproject.toml used by ruff in this repo to be aligned with the ones used in PGM. This will lead to many code changes that are to be fixed as well.

Suggested Steps

1. Add a new rule not present in this repo but present in PGM to the pyproject.toml.
2. Run uv run ruff check.
3. Fix the reported errors/warning by ruff.
4. Repeat until all the rules have been added.

[vincentkoppen]

Hi,

Thanks for the issue and the suggested steps seems like a good way to implement.
For us it would work best to split this into multiple PR's that are easy to review. So a PR would either:

• Contain multiple rules, that need almost no code changes
• One new rule together with all the code changes required for it.

Rules to implements

I compared the rules between this project and power-grid-model and it seems that we can add the following rules.
Below is the list to track our progress.
(I trier to order them a bit in order of "importance" on a first glance)

• S — bandit security rules

  • Allow assert in tests
    https://docs.astral.sh/ruff/rules/#flake8-bandit-s

• SIM — flake8-simplify
  https://docs.astral.sh/ruff/rules/#flake8-simplify-sim

• PT — pytest rules
  https://docs.astral.sh/ruff/rules/#pytest-pt

• PL — pylint rules
  https://docs.astral.sh/ruff/rules/#pylint-pl

  • Deprecate the use of pylint within our poe after this is implemented

• G — flake8-logging-format (no f-strings in logging for performance etc)
  https://docs.astral.sh/ruff/rules/#flake8-logging-format-g

• LOG — logging best practices (good logger setup)
  https://docs.astral.sh/ruff/rules/#flake8-logging-log

• Q — flake8-quotes (correct use of quotes)
  https://docs.astral.sh/ruff/rules/#flake8-quotes-q

• ICN — flake8-import-conventions (use common import convention)
  https://docs.astral.sh/ruff/rules/#flake8-import-conventions-icn

• ISC — flake8-implicit-str-concat (correct string concatenation)
  https://docs.astral.sh/ruff/rules/#flake8-implicit-str-concat-isc

• FURB — refurb refactors (general best-practice refactors)
  https://docs.astral.sh/ruff/rules/#refurb-furb

• FLY — flynt (convert to f-strings)
  https://docs.astral.sh/ruff/rules/#flynt-fly

• W — Warnings (general whitespace, line-length rules adherence)
  https://docs.astral.sh/ruff/rules/#warning-w

• PTH — flake8-pathlib (use pathlib)
  https://docs.astral.sh/ruff/rules/#flake8-pathlib-pth

• ARG — flake8-unused-arguments (errors on unused arguments, functions, methods etc)
  https://docs.astral.sh/ruff/rules/#flake8-unused-arguments-arg

• TID — flake8-tidy-imports (import style)
  https://docs.astral.sh/ruff/rules/#flake8-tidy-imports-tid

• RET — flake8-return (unnecesary else when you return, don't return None if no other option etc)
  https://docs.astral.sh/ruff/rules/#return-ret

• PIE — flake8-pie (some small best practices)
  https://docs.astral.sh/ruff/rules/#flake8-pie-pie

• SLF — private member access
  - Should be allowed in tests
  - Also sometimes allowed within _core, if we use it currently it might be fine to just ignore.
  https://docs.astral.sh/ruff/rules/#ruff-specific-slf

• UP — pyupgrade rules (upgrade to newer python syntax where possible)
  https://docs.astral.sh/ruff/rules/#pyupgrade-up

• RSE — flake8-raise (Checks for unnecessary parentheses on raised exceptions.)
  https://docs.astral.sh/ruff/rules/#flake8-raise-rse

• RUF — ruff-specific rules (ruff specific, all kinds of best practices)
  https://docs.astral.sh/ruff/rules/#ruff-specific-ruf

• FBT003 — boolean positional argument (use keywords for booleans in our calls)
  https://docs.astral.sh/ruff/rules/fbt003

• TRY002 — overly broad exception (also for except statements)
  https://docs.astral.sh/ruff/rules/try002

• PERF — performance rules (small best-practices around performance)
  https://docs.astral.sh/ruff/rules/#perflint-perf

• EXE — executable permissions (correct shebangs for scripts)
  https://docs.astral.sh/ruff/rules/#flake8-executable-exe

• BLE — flake8-blind-except (Do not catch blind exception)
  https://docs.astral.sh/ruff/rules/#flake8-blind-except-ble

• YTT — flake8-2020 (correct way to determine python version etc)
  https://docs.astral.sh/ruff/rules/#flake8-2020-ytt

• SLOT — flake8-slots (don't use pass with str/tuple)
  https://docs.astral.sh/ruff/rules/#flake8-slots-slot

Rules I'm not sure we want/need

• FA — future annotations (only relevant to 3.9 and below, but we alreayd have 3.12 as minimal version)
  https://docs.astral.sh/ruff/rules/#flake8-future-annotations-fa

[vincentkoppen]

We are happy for anyone to pick this up and might also pick a rule every once in a while ourselves.
If a rule clashes with our code and there is no clear solution, we can always discuss the solution within this issue.

[vincentkoppen]

Awesome work so far @furqan463 with all the PRs, thanks a lot.
I have updated the checklist with your current progress 😄