Skip to content

Deprecate 'x' argument for widgets.TextBox.begin_typing #24806

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
merged 2 commits into from
Dec 22, 2022
Merged

Deprecate 'x' argument for widgets.TextBox.begin_typing #24806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
354f1a8
Deprecate 'x' argument for widgets.TextBox.begin_typing
ksunden Dec 22, 2022
32cac5c
release note for unused variable
ksunden Dec 22, 2022
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
4 changes: 4 additions & 0 deletions doc/api/next_api_changes/deprecations/24806-KS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Deprecate unused parameter *x* to ``TextBox.begin_typing``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This parameter was unused in the method, but was a required argument.
2 changes: 1 addition & 1 deletion lib/matplotlib/tests/test_widgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -982,7 +982,7 @@ def test_TextBox(ax, toolbar):
assert tool.text == 'x**2'
assert text_change_event.call_count == 1

tool.begin_typing(tool.text)
tool.begin_typing()
tool.stop_typing()

assert submit_event.call_count == 2
Expand Down
5 changes: 3 additions & 2 deletions lib/matplotlib/widgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1279,7 +1279,8 @@ def set_val(self, val):
self._observers.process('change', self.text)
self._observers.process('submit', self.text)

def begin_typing(self, x):
@_api.delete_parameter("3.7", "x")
def begin_typing(self, x=None):
self.capturekeystrokes = True
# Disable keypress shortcuts, which may otherwise cause the figure to
# be saved, closed, etc., until the user stops typing. The way to
Expand Down Expand Up @@ -1326,7 +1327,7 @@ def _click(self, event):
if event.canvas.mouse_grabber != self.ax:
event.canvas.grab_mouse(self.ax)
if not self.capturekeystrokes:
self.begin_typing(event.x)
self.begin_typing()
self.cursor_index = self.text_disp._char_index_at(event.x)
self._rendercursor()

Expand Down