Expand ruff linter rules

Nobody has claimed this yet.

Start with ruff.toml and the open-rule checklist, then run ruff check on sdk/basyx as described. Apply safe fixes where possible, run mypy and the tests after each rule or module, and expand to other modules only when the code remains passing; done means the selected rules are enabled or explicitly evaluated and the checks pass.

Written by the indexing model from the issue text.

Current ruff linter configuration applies a certain set of rules. However more rules were already selected to be introduced at some point. These currently live in the ignore section and should be moved up to the select section.

The first introduction of these rules comes with some manual work to first get the codebase to the rules' standards.

A good way to add a rule is to introduce it step by step, e.g.:

Run ruff check only against sdk/basyx
If possible, apply fixes with ruff check --fix (or even unsafe-fixes)
Run tests (mypy tends to surface errors) to see if fixes are breaking
Only then expand to tests, repeat for other modules

Checklist (also see ruff.toml) of open rules:

PYI currently requires an additional dependency; after the introduction of a newer python version this can easily be introduced (see #594)

"PYI", # typing best practices

Might need more work to add:

"F403", # star imports - high existing usage
"F405", # may-be-undefined from star imports
"N818", # Exception name should be named with Error suffix
"N", # pep8-naming
"B", # flake8-bugbear
"T20", # prevent native print() statements
"A", # prevent shadowing of python builtins
"FIX", # prevent the creation of T0DO / F1XME comments

Should be evaluated if we even want to add them:

"S", # security related precautions
"BLE", # prevent unspecified excepts

Assessment

Research direction

Description

Contributor guide

First steps

More from eclipse-basyx/basyx-python-sdk

Similar issues