Add ignored-parents option to design checker #4758
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows users to specify classes to ignore while counting parent classes. Partially closes pylint-dev#3057
9999years
force-pushed
the
feature/ignore-parents
branch
from
3a12ebe
to
d1f9a75
Compare
Pierre-Sassoulas
requested changes
Jul 27, 2021
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
for more information, see https://pre-commit.ci
|
Added a functional test -- should I keep the |
Pierre-Sassoulas
approved these changes
Jul 27, 2021
|
I'll leave it -- it won't hurt and it'll make it easier for the next person who wants to unit test the design checker. |
Pierre-Sassoulas
added
False Positive 🦟
|
There will be a slight delay before merging as we want to release 2.9.6 first and this is going in 2.10 🙂 |
|
Thank you again for your work on this, this will be available in 2.10.0 ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Type of Changes
Description
Allow users to specify classes to ignore while counting parent classes.
When one of the ignored classes is detected in the ancestor tree, it and its parents are ignored. Suppose we have the following inheritance diagram:
If we add
Etoignored-parents, then the classes counted for thetoo-many-ancestorscheck will beB,D, andC.If we have another class
G(F), thenFwill be counted -- ancestors of ignored parents are pruned from the tree for counting, but we don't go the other way and exclude all parents of ignored parents.Partially closes #3057 by offering a configuration mechanism to ignore non-user classes from counting.
Rationale
typing.Protocolis ignored from counting, but I'm usingtyping_extensions, sotyping_extensions.Protocolis increasing the count and triggering thetoo-many-ancestorsmessage.