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

Add explicit getter / setter overloads for pyplot.{xlim,ylim}#30199

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 7 commits intomatplotlib:mainfromZPyrolink:pyplot-get-set-automatization

Jun 27, 2025

Merged

Add explicit getter / setter overloads for pyplot.{xlim,ylim}#30199

QuLogic merged 7 commits intomatplotlib:mainfromZPyrolink:pyplot-get-set-automatization

Jun 27, 2025

+36 −0

Conversation

Copy link

Contributor

ZPyrolink commentedJun 21, 2025

PR summary

This PR update thetools/boilerplate.py for autogenerate getter / setter:

Axes.xlim
Axes.ylim
Any method with the following form:T.get_meth() -> TGet ;T.set_meth(...) -> TSet

PR checklist

Closes[MNT]: pyplot type hints #30160
Changed code istested

CorenthinZ added4 commits

June 21, 2025 12:28

Add xlim / ylim autogeneration

08ea277

- Create get_signature method- Create AXES_GETTER_SETTER_TEMPLATE- Create call_param method on generate_function(cherry picked from commite57b321)

Format with ruff

f78a4a5

(cherry picked from commit64e7921)

Remove old xlim and ylim

8e41f89

(cherry picked from commit66ee071)

Format with ruff

880e262

github-actionsbot added the topic: pyplot API label

Jun 21, 2025

ZPyrolink changed the title~~Pyplot get set automatization~~Pyplot getter setter automatization

Jun 21, 2025

Revert superfluous changes

3f3743f

ZPyrolink mentioned this pull request

Jun 21, 2025

Update type hints to fix #30160#30193

Closed

2 tasks

Copy link

Member

QuLogic commentedJun 24, 2025

I don't think the docstrings are correct here. Placing them on the overloads doesn't really produce both. What you end up with is the docstring toAxes.get_xlim, which is not the same as the removed docstring forxlim. If you want to automatically produce the overloads, that might be fine, but I don't think there's a way to generate a reasonable docstring on these.

Copy link

Member

QuLogic commentedJun 24, 2025

Any method with the following form:T.get_meth() -> TGet ;T.set_meth(...) -> TSet

You've mentioned these as well, but it seems like this PR only changedxlim/ylim?

Copy link

Member

timhoffm commentedJun 24, 2025

I think the added complexity of the auto-generation is not not worth it, in particular given that we want a different docstring. As proposed in#30160 (comment) writing out the signature manually and/or adding overloads should be good enough.