Don't expose private styles in style.available #30235
Conversation
lib/matplotlib/style/__init__.py
Outdated
| available[:] = sorted(library.keys()) | ||
| library.update(_update_user_library(_base_library.copy())) | ||
| available[:] = sorted(name for name in library | ||
| if not name.startswith('_') or name not in _base_library) |
There was a problem hiding this comment.
Ok, so the idea is that we only exclude "_name" styles that are in the base library. Any other styles in the base library are shown, and any user styles are shown. I got that right?
There was a problem hiding this comment.
I would l go for: Exclude all styles with leading _. Not sure why users would register such styles, but let’s just document this way. It’s more in line with general underscore semantics , e.g. dir() and simpler to implement.
There was a problem hiding this comment.
Agreed. What if other libraries need to register their own "private" styles?
There was a problem hiding this comment.
My take: Private styles are those with a leading underscore. Everybody can register and get/use them. They are only not listed under the available styles. This is the same logic as with private attributes/methods.
There was a problem hiding this comment.
Yes, the only reason I wrote it this way is because the test adds a _test_ style and looks for it in available. But as I've now fixed reload_library to correctly clean up user styles, I think we can use any name in the test.
They remain in `style.library`, because that's how we look them up, but this prevents them being exposed as something someone might use. Also, fix `reload_library`, which was accidentally modifying the original base library information each time. Fixes itprojects/MasVisGtk#13
PR summary
They remain in
style.library, because that's how we look them up, but this prevents them being exposed as something someone might use.Also, fix
reload_library, which was accidentally modifying the original base library information each time.Fixes itprojects/MasVisGtk#13
PR checklist