Class hierarchy diagram is not correct, if inherited from Python built-in class ABC

[bertramrichter]

Describe the bug
In a Python project, the class hierarchy overview shows a wrong inheritance graph, if the Python built-in class abc.ABC (abstract base classes) is used as the root. Some seemingly random class is shown as the root of the inheritance tree and a circular inheritance dependency is shown, the inheritance from ABC is not shown. This only happens in Classes -> Class Hierarchy, the inheritance graphs for the individual classes in their documentation pages are always correct.

Expected behavior
Expected is that all classes inherit from ABC in the class hierarchy overview graph.

Screenshots
Correct without ABC:

Wrong with ABC:

Correct, with mixed (with and without ABC):

To Reproduce
Attached is a MWE of the problem: doxygen_problem_with_ABC.zip, which includes the source code, and the generated documentation, which leads to the examples shown above.

Version
I am currently using version 1.9.3 on Linux Mint 20.1 and 19.3, built from the instructions on the downloads page. But this this behavior is present in previous doxygen versions too.

Big thank you for the exciting framework.

Kindly Yours
Bertram Richter

[albert-github]

• doxygen version 1.9.3 is the current master version, which version are you exactly using (so full doxygen -v), the version 1.9.3 is currently a moving target.
• I'm not completely getting the issue, is it that in the second image there are in fact 2 lines that should not be present? i.e.
  • With_ABC_Faulty.BaseClass1 to With_ABC_Faulty.SubClass1
  • With_ABC_Faulty.BaseClass2 to With_ABC_Faulty.SubClass1
• this might have to to with the same issue as reported in Python call graph is not completely correct #8851 although that issue is for call graphs.
   

[bertramrichter]

Thanks you for your responce.
At the moment, I use 1.9.3 (8ee309708beb0a410e56fb4133849ed8197d3bcf), but as I recall, the issue was present in previous versions too (not sure, how far back).

In the second image, I expect to have two inheritance lines, that have a common ancestor (ABC) like:

     /-> BaseClass1 -> SubClass1
ABC <
     \-> BaseClass2 -> SubClass2

If it is reduced to only two classes, this still persists in similar order.

class Class1(ABC):
    pass
class Class2(Class1):
    pass

The expected class hierarchy is:

ABC -> Class1 -> Class2

The generated class hierarchy is:

Class1 <-> Class2

The MWE shows the inconsistency:

1. no class is decendent of ABC → works
2. all classes are decendents of ABC → fails
3. some classes are decendents of ABC → works in this MWE, fails in my actual documentation in a mixture of 1. and 2.

I want to be kept in mind, that this only affects the overview, which shows all classes, not the inheritance diagram for a single class.

With kind regards
Bertram Richter

[albert-github]

• Can you please make from the small example in Class hierarchy diagram is not correct, if inherited from Python built-in class ABC #8854 (comment) a self contained example (source+configuration file in a tar or zip) that allows us to reproduce the problem? Please don't add external links as they might not be persistent.
  This makes sure we are always talking about the same.

[albert-github]

Regarding the problem of #8851 I've just pushed a proposed patch, pull request #8860, unfortunately this doesn't solve the current issue.

The current issue appeared between doxygen versions 1.8.11 and 1.8.12 as a self reference, and between 1.8.13 and 1.8.14 as the real current problem, this all has to be bisected a bit and see what the original cause has been .

[bertramrichter]

In addition to the three more complex examples, here is the most simple MWE, with two classes where this problem happens: With_ABC_Faulty_simple.zip

Because out of curiosity, I tried with str and object instead of ABC. And found, that this seems to happen not only for ABC, but generally for all Python types. Thus, I proposed to update the issue title to "Class hierarchy diagram for Python is not correct, if classes explicit inherit from Python built-in classes".

[albert-github]

I've just pushed a proposed patch, pull request #8861

[bertramrichter]

I can confirm, that this solves the issue.
Big thank you. 💐

Kindly Yours
Bertram Richter

[albert-github]

The issue was solved by shear luck as the code review revealed. A new implementation has been proposed.

[albert-github]

The alternative implementation (#8861 (comment)) has still some problems (as would have had the original proposed patch).