Document areas of code complexity #2370
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed at #2360 (review), let's set upper limits on or at least document code complexity.
Ruff provides one McCabe metric and four Pylint refactor metrics (even more in
--previewmode).This pull request shows three ways to document where code complexity exists.
noqaplus a few lines in the docstring. (Semi-automated generation with a script.)noqa.tool.ruff.lint.per-file-ignoresinpyproject.tomlOn the
mainbranch...%
ruff check --select=C90,PLR09 --statistics%
ruff check --select=C90,PLR09 --statistics --preview