Check for shadowed tests with Pylint #1934
Merged
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.
Tests are often developed by a copy-paste-modify method - but we forget to change the function (or method) name, the earlier test is silently redefined and can never be run. This is obviously bad.
Since it turns out that the redefinition problem does actually happen, this PR adds Pylint to our CI just to run the
function-redefined
check. It also fixes the several test suite bugs that this detects, and restructures the false-positives to make this check as useful as possible.I'm not running it over the source in CI, but did check each location by hand - there are multiple places where we really do want to redefine the function, and the remainder are due to pylint-dev/pylint#2239 (
@typing.overload
needs but does not yet have special handling).