8000 Change return type of `ion` and `ioff` to fix unbound variable errors with Pyright by FeldrinH · Pull Request #27667 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Change return type of ion and ioff to fix unbound variable errors with Pyright #27667

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
QuLogic merged 4 commits into from
Feb 23, 2024
Merged

Change return type of ion and ioff to fix unbound variable errors with Pyright #27667

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bafbe9c
Change return type of ion and ioff to fix unbound variable errors wit…
FeldrinH Jan 18, 2024
7a1461c
Add comment explaining rationale
FeldrinH Jan 18, 2024
2f56a2a
Fix flake8 lint error
FeldrinH Jan 18, 2024
f49c0e3
Actually fix flake8 lint
FeldrinH Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions lib/matplotlib/pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,11 @@ def isinteractive() -> bool:
return matplotlib.is_interactive()


def ioff() -> ExitStack:
# Note: The return type of ioff being AbstractContextManager
# instead of ExitStack is deliberate.
# See https://github.com/matplotlib/matplotlib/issues/27659
# and https://github.com/matplotlib/matplotlib/pull/27667 for more info.
def ioff() -> AbstractContextManager:
"""
Disable interactive mode.

Expand Down Expand Up @@ -586,7 +590,7 @@ def ioff() -> ExitStack:
# ...

To enable optional usage as a context manager, this function returns a
`~contextlib.ExitStack` object, which is not intended to be stored or
context manager object, which is not intended to be stored or
accessed by the user.
"""
stack = ExitStack()
Expand All @@ -596,7 +600,11 @@ def ioff() -> ExitStack:
return stack


def ion() -> ExitStack:
# Note: The return type of ion being AbstractContextManager
# instead of ExitStack is deliberate.
# See https://github.com/matplotlib/matplotlib/issues/27659
# and https://github.com/matplotlib/matplotlib/pull/27667 for more info.
def ion() -> AbstractContextManager:
"""
Enable interactive mode.

Expand Down Expand Up @@ -626,7 +634,7 @@ def ion() -> ExitStack:
# ...

To enable optional usage as a context manager, this function returns a
`~contextlib.ExitStack` object, which is not intended to be stored or
context manager object, which is not intended to be stored or
accessed by the user.
"""
stack = ExitStack()
Expand Down
0