Migrate black, flake8, isort, pyupgrade linters and formatters to ruff

[kieran-ryan]

🤔 What's changed?

• Migrated linters flake8, isort, pydocstyle and pyupgrade to ruff
• Migrated formatter black to ruff
• Froze pre-commit dependency versions to commit hashes
• Applied and enforced from __future__ import annotations on all Python modules
• Updated docstring type hints to match __future__.annotations syntax e.g. List to list, Optional to ... | None
• Applied codespell spelling corrections

⚡️ What's your motivation?

• Migrating to ruff provides the following enhancements:
  • ⚡️Extremely fast - 42x faster than flake8 in ruff's benchmark - and even faster with built-in caching
    • See pytest-bdd pre-commit run before (4.6s) and after (2.6s)
  • 📏 Hundreds of additional linting rules
  • 🐁 Reduces linting and formatting dependencies (black, flake8, flake8-bugbear, flake8-pyproject, mccabe, pycodestyle, pyflakes, isort, pyupgrade, tokenize-rt) down to ruff - including "Drop-in parity with flake8, isort, and black"
  • 🔧 Fix support, for automatic error correction
  • ⌨️ First-party editor integrations for VS Code and more
  • 🛠️ Native pyproject.toml support - without requiring dependencies such as flake8-pyproject - and can be read by IDE extensions and is monorepo-friendly, with hierarchical and cascading configuration. Centralises configuration rather than splitting across pre-commit, pyproject.toml, IDE settings, etc.
  • 🤝 Simplifies contributing experience and running linting and formatting locally or through developer tools
• pytest has adopted ruff
• Appears to be at least some level of ruff adoption amongst pytest-bdd contributors
• Freezing pre-commit hashes is better for security (matches Update pre-commit hooks to the latest versions. cucumber/gherkin#326)

🏷️ What kind of change is this?

• 🏦 Refactoring/debt/DX (improvement to code design, tooling, etc. without changing behaviour)

♻️ Anything particular you want feedback on?

• Whether suitable to include a recommended VSCode workspace extension or should omit

References

• flake8 error codes
• pycodestyle error codes (installed with flake8)
• ruff rules

[Pierre-Sassoulas]

Looks great !

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.10%. Comparing base (9ff6980) to head (b96b83e).
Report is 12 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #758      +/-   ##
==========================================
+ Coverage   96.05%   96.10%   +0.05%     
==========================================
  Files          55       55              
  Lines        2359     2390      +31     
  Branches      136      136              
==========================================
+ Hits         2266     2297      +31     
  Misses         56       56              
  Partials       37       37              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jsa34]

@youtux we talked about ruff before but I seem to remember you were keen to stick to psf-supported solutions, such as black.

I'll defer to @youtux

[youtux]

I'm willing to give it a shot to use ruff, given also pytest started using it.

There's just one thing I'd like to see addressed: I'd want to do as few import as possible inside the if TYPE_CHECKING: block, ideally none at all. The imports we do within that block are pretty much modules that should be already loaded in the interpreter, so the overhead of importing them is negligible.

[kieran-ryan]

I'm willing to give it a shot to use ruff, given also pytest started using it.

Awesome @youtux!

There's just one thing I'd like to see addressed: I'd want to do as few import as possible inside the if TYPE_CHECKING: block, ideally none at all. The imports we do within that block are pretty much modules that should be already loaded in the interpreter, so the overhead of importing them is negligible.

Makes sense, happy to change. Clarifying my assumptions on scope: revert imports migrated into type checking blocks and revert adding the flake8-type-checking-tc (TC) linting rules (or a subset)?

[youtux]

Yes, both, thank you

[kieran-ryan]

Yes, both, thank you

Dropped associated commit and updated pull request description - some of these imports may be dropped with #759 through associated gherkin parser enhancements in any case, so good shout 👍