Repository navigation
Examples that use private APIs #13199
Description
The following examples rely on at least one private API. They should be changed to not use the private API, or, if that's not possible, we should discuss how to make that API public.
Fixed in #13202:
https://github.com/matplotlib/matplotlib/blob/master/examples/axes_grid1/demo_axes_grid2.pyhttps://github.com/matplotlib/matplotlib/blob/master/examples/axisartist/demo_curvelinear_grid2.pyhttps://github.com/matplotlib/matplotlib/blob/master/examples/axisartist/demo_floating_axes.pyhttps://github.com/matplotlib/matplotlib/blob/master/examples/axisartist/demo_parasite_axes.py
Still need fixing:
https://github.com/matplotlib/matplotlib/blob/master/examples/userdemo/custom_boxstyle02.py
is now the second example of https://matplotlib.org/devdocs/gallery/userdemo/custom_boxstyle01.html
Activity
jklymak commentedon Jan 16, 2019
For axes_grid I think we should consider how to make that a core functionality.
Avoid private API in some examples.
QuLogic commentedon Jan 17, 2019
The last example seems to exist solely to derive from that private API, so I don't know what to do about it.
anntzer commentedon Jan 17, 2019
Perhaps that base class should be made public, if we want to support this kind of addition of BoxStyles.
timhoffm commentedon Aug 26, 2019
As written elsewhere, I have doubts that private base classes are a reasonable approach. Their code leaks into the child classes, which is intended, but OTOH confusing because you're not seeing the base class. This also messes up sphinx because the inherited methods are not documented and cannot be linked.
Generally, I cannot remember to have seen private base classes anywhere else. I feel it's better to make the base class public, but some of it's members private or abstract.
QuLogic commentedon Jun 20, 2020
Note, as part of #16615, the last example was merged into https://github.com/matplotlib/matplotlib/blob/master/examples/userdemo/custom_boxstyle01.py though the private API is still used.
anntzer commentedon Jun 20, 2020
I have an idea of how to get rid of that private base class (essentially, move the mutation aspect handling out of
__call__and into the (only) call site, but as usual this will require ginormous amounts of deprecation machinery. I'll work on it at some point...