Handle multiple inheritance correctly in autodoc #13136
Open
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
The previous code went through mro sequentially not treating it
as a tree, which is needed in case of multiple inheritance.
Take following example:
```python
class MyClass(Parent1, Parent2):
foo_myclass=None
class Parent1(GrandParent1):
foo_parent1=None
class GrantParent1:
foo_grandparent1=None
class Parent2:
foo_parent2
```
When `:show-inheritance: Parent1` is used, only following attributes should
be shown:
* foo_myclass
* foo_parent2
The foo_parent2 was previously not considered as the MRO matched Parent1 before
Parent2 but didn't check if it was really defined there.
The new code checks if the attribude is defined either directly in the ignored
class or in one of it's parents (that's why the issubclass in reversed order
is used).
|
I'm really not sure if this is the proper way how to approach the |
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.
Subject: Handle multiple inheritance correctly in autodoc
Feature or Bugfix
Purpose
The previous code went through mro sequentially not treating it as a tree, which is needed in case of multiple inheritance. Take following example:
When
:show-inheritance: Parent1is used, only following attributes should be shown:The foo_parent2 was previously not considered as the MRO matched Parent1 before Parent2 but didn't check if it was really defined there.
The new code checks if the attribude is defined either directly in the ignored class or in one of it's parents (that's why the issubclass in reversed order is used).
Detail
Relates