NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.4k

Propose a less error-prone helper for module-level getattrs.#20857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

QuLogic merged 2 commits intomatplotlib:masterfromanntzer:module-getattr

Aug 20, 2021

Merged

Propose a less error-prone helper for module-level getattrs.#20857

QuLogic merged 2 commits intomatplotlib:masterfromanntzer:module-getattr

Aug 20, 2021

Conversation

Copy link

Contributor

anntzer commentedAug 18, 2021•
edited
Loading

Apparently we always forget to generate the fallback AttributeError (#20822,#20855), so
introduce a helper to do so instead. (I'm not wedded to the exact API...)

The changes indeprecation.py are (a) so that one can correctly
suppress the inferred type when deprecating properties (the new check is
coherent with theif isinstance(obj, type) and other cases) and (b) to
make single-argument__get__ work on deprecated properties
(consistently with standard properties).

Would replace#20856.

PR Summary

PR Checklist

Has pytest style unit tests (andpytest passes).
IsFlake 8 compliant (runflake8 on changed files to check).
New features are documented, with examples if plot related.
Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
Conforms to Matplotlib style conventions (installflake8-docstrings and runflake8 --docstring-convention=all).
New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).

Copy link

Contributor

lpsinger commentedAug 18, 2021

Does this method correctly distinguish between__getattr__ returningNone for an attribute that is intended to exist but be defined asNone, versus__getattr__ raising an exception for an attribute that does not exist?

anntzer force-pushed themodule-getattr branch from45d82f5 to382ea55Compare

August 18, 2021 16:25

Copy link

ContributorAuthor

anntzer commentedAug 18, 2021

Yes. (In fact, that's the reason why I switched to a class-based approach, as a function-based approach would have trouble distinguishing either between missing globals and globals set to None, or between genuine AttributeErrors and AttributeErrors arising because of a bug in the calculation of the dynamically generated value.)

anntzer force-pushed themodule-getattr branch from382ea55 to971a904Compare

August 18, 2021 19:34

QuLogic reviewed

Aug 18, 2021

View reviewed changes

lib/matplotlib/backends/backend_wx.py OutdatedShow resolvedHide resolved

anntzer force-pushed themodule-getattr branch 2 times, most recently from5d30b57 to87392d8Compare

August 18, 2021 22:00

QuLogic approved these changes

Aug 18, 2021

View reviewed changes

QuLogic added this to thev3.5.0 milestone

Aug 18, 2021

QuLogic added Maintenance Release critical

For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.

status: needs rebase labels

Aug 19, 2021

anntzerand others added2 commits

August 20, 2021 16:14

Propose a less error-prone helper for module-level getattrs.

627dbd6

Apparently we always forget to generate the fallback AttributeError, sointroduce a helper to do so instead.The changes in `deprecation.py` are (a) so that one can correctlysuppress the inferred type when deprecating properties (the new check iscoherent with the `if isinstance(obj, type)` and other cases) and (b) tomake single-argument `__get__` work on deprecated properties(consistently with standard properties).