bpo-41611: IDLE: Catch TclError exceptions in AutoCompleteWindow.winconfig_event() #26404

taleinat · 2021-05-27T15:29:44Z

Due to the <Configure> event sometimes being triggered after some delay, the completion list window may no longer exist when the handler is called. Therefore it is necessary to catch potential TclError exceptions in the handler's code.

This PR is a somewhat heavy-handed solution (simply wrapping most of the code in a try/except block), but seems like what's needed for such an event handler.

https://bugs.python.org/issue41611

…onfig_event() Due to the <Configure> event sometimes being triggered after some delay, the completion list window may no longer exist when the handler is called. Therefore it is necessary to catch potential TclError exceptions in the handler's code. Signed-off-by: Tal Einat <[email protected]>

terryjreedy · 2021-05-27T19:12:27Z

PIPELINES, Win32, same failure twice.
======================================================================
FAIL: test_incremental_editing (idlelib.idle_test.test_colorizer.ColorDelegatorTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "D:\a\1\s\lib\idlelib\idle_test\tkinter_testing_utils.py", line 54, in new_test_method
    raise exception
  File "D:\a\1\s\lib\idlelib\idle_test\tkinter_testing_utils.py", line 38, in after_callback
    next(test_generator)
  File "D:\a\1\s\lib\idlelib\idle_test\test_colorizer.py", line 597, in test_incremental_editing
    eq(text.tag_nextrange('KEYWORD', '1.0'), ())
AssertionError: Tuples differ: ('1.0', '1.1') != ()

First tuple contains 2 additional elements.
First extra element 0:
'1.0'

- ('1.0', '1.1')
+ ()

Why only Pipelines and not others? Why only Win32 and not Win64? I am tempted to ignore, but I will trigger a rerun by editing the new comment. (If you think too much so, you can expand.)

Edit: rerun passed.

Condense comment.

terryjreedy · 2021-05-27T19:11:44Z

Lib/idlelib/autocomplete_w.py

        self.is_configuring = True
        if not self.is_active():
            return


I believe it is a bug to leave self.is_configuring True when returning. It seems that not self.active should be added to the condition above. I also remember doing some test that indicated that this function may still be executed past here more than once. But another issue.

True, though unrelated to the bug in the bpo issue. Want us to fix this in this PR while we're here?

Tempted but no. Partly discipline -- we have coherent problem and solution we agree on, lets merge it (when you are ready). We have done really great today with good focus. Partly I want to retry the test I remember to check for any anomaly. Start with just a PR, if you want, after this is merged into you local clone. Or start with wider issue Clean up autocomplete_w code. There is a too-big function that I would like to split. And maybe other things. Oh, and maybe some tests needing review.

terryjreedy · 2021-05-27T19:32:51Z

Lib/idlelib/autocomplete_w.py

+        try:
+            # Position the completion list window
+            text = self.widget
+            text.see(self.startindex)


Heavy-handed? We could move the 'try' down a few lines. I considered whether 'see' is useful even when code below fails, but cannot see that it is. So I am OK with enclosing the entire logical block.

If we caught TclError after 261, what would we do? To return, we would have to duplicate the cleanup code after the new pass. To 'break', we would have to wrap this block with a fake loop. Both are worse.

Well I did write "somewhat heavy-handed" ;)

But yes, I too believe this is actually a good solution, besides perhaps refactoring to introduce a more consistent mechanism to avoid uncaught exceptions in event handlers.

But that seems out of scope for this fix.

miss-islington · 2021-05-28T06:07:24Z

Thanks @taleinat for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.9.
🐍🍒⛏🤖

…onfig_event() (pythonGH-26404) Since the <Configure> event may occur after the completion window is gone, catch potential TclError exceptions when accessing acw. (cherry picked from commit 4e2e5c1) Co-authored-by: Tal Einat <[email protected]>

bedevere-bot · 2021-05-28T06:07:32Z

GH-26419 is a backport of this pull request to the 3.10 branch.

…onfig_event() (pythonGH-26404) Since the <Configure> event may occur after the completion window is gone, catch potential TclError exceptions when accessing acw. (cherry picked from commit 4e2e5c1) Co-authored-by: Tal Einat <[email protected]>

bedevere-bot · 2021-05-28T06:07:37Z

GH-26420 is a backport of this pull request to the 3.9 branch.

…onfig_event() (GH-26404) Since the <Configure> event may occur after the completion window is gone, catch potential TclError exceptions when accessing acw. (cherry picked from commit 4e2e5c1)

bedevere-bot · 2021-05-28T06:44:33Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot x86 Gentoo Installed with X 3.x has failed when building commit 4e2e5c1.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/464/builds/278) and take a look at the build logs.
Check if the failure is related to this commit (4e2e5c1) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/all/#builders/464/builds/278

Failed tests:

test_idle

Failed subtests:

test_incremental_editing - idlelib.idle_test.test_colorizer.ColorDelegatorTest

Summary of the results of the build (if available):

== Tests result: FAILURE then FAILURE ==

412 tests OK.

1 test failed:
test_idle

14 tests skipped:
test_asdl_parser test_check_c_globals test_clinic test_ctypes
test_devpoll test_gdb test_ioctl test_kqueue test_msilib
test_startfile test_winconsoleio test_winreg test_winsound
test_zipfile64

1 re-run test:
test_idle

Total duration: 32 min 18 sec

Click to see traceback logs

Traceback (most recent call last):
  File "/buildbot/buildarea/cpython/3.x.ware-gentoo-x86.installed/build/target/lib/python3.11/idlelib/idle_test/tkinter_testing_utils.py", line 54, in new_test_method
    raise exception
  File "/buildbot/buildarea/cpython/3.x.ware-gentoo-x86.installed/build/target/lib/python3.11/idlelib/idle_test/tkinter_testing_utils.py", line 38, in after_callback
    next(test_generator)
  File "/buildbot/buildarea/cpython/3.x.ware-gentoo-x86.installed/build/target/lib/python3.11/idlelib/idle_test/test_colorizer.py", line 573, in test_incremental_editing
    eq(text.tag_nextrange('BUILTIN', '1.0'), ('1.0', '1.3'))
AssertionError: Tuples differ: () != ('1.0', '1.3')


Traceback (most recent call last):
  File "/buildbot/buildarea/cpython/3.x.ware-gentoo-x86.installed/build/target/lib/python3.11/idlelib/idle_test/tkinter_testing_utils.py", line 54, in new_test_method
    raise exception
  File "/buildbot/buildarea/cpython/3.x.ware-gentoo-x86.installed/build/target/lib/python3.11/idlelib/idle_test/tkinter_testing_utils.py", line 38, in after_callback
    next(test_generator)
  File "/buildbot/buildarea/cpython/3.x.ware-gentoo-x86.installed/build/target/lib/python3.11/idlelib/idle_test/test_colorizer.py", line 569, in test_incremental_editing
    eq(text.tag_nextrange('KEYWORD', '1.0'), ('1.0', '1.2'))
AssertionError: Tuples differ: () != ('1.0', '1.2')

terryjreedy · 2021-06-01T20:41:34Z

I opened bpo-44282 to follow up on this.

…dow.winconfig_event() (GH-26404)" This reverts commit 4e2e5c1.

taleinat added type-bug An unexpected behavior, bug, or error needs backport to 3.9 needs backport to 3.10 only security fixes labels May 27, 2021

taleinat requested a review from terryjreedy as a code owner May 27, 2021 15:29

the-knights-who-say-ni added the CLA signed label May 27, 2021

bedevere-bot added the awaiting core review label May 27, 2021

Update autocomplete_w.py

d4ffbb8

Condense comment.

terryjreedy approved these changes May 27, 2021

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels May 27, 2021

taleinat merged commit 4e2e5c1 into python:main May 28, 2021

bedevere-bot removed the awaiting merge label May 28, 2021

bedevere-bot removed the needs backport to 3.10 only security fixes label May 28, 2021

bedevere-bot removed the needs backport to 3.9 label May 28, 2021

taleinat deleted the bpo-41611/IDLE-autocomplete-winconfig-catch-tcl-exceptions branch May 28, 2021 06:07

vstinner mentioned this pull request Jun 2, 2021

Revert "bpo-41611: IDLE: Catch TclError exceptions in AutoCompleteWindow.winconfig_event()" #26487

Closed

vstinner added a commit that referenced this pull request Jun 2, 2021

Revert "bpo-41611: IDLE: Catch TclError exceptions in AutoCompleteWin…

e5af3ec

…dow.winconfig_event() (GH-26404)" This reverts commit 4e2e5c1.

pablogsal mentioned this pull request Jul 18, 2021

[3.10] Correct the order of regen-abidump #27228

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

bpo-41611: IDLE: Catch TclError exceptions in AutoCompleteWindow.winconfig_event() #26404

bpo-41611: IDLE: Catch TclError exceptions in AutoCompleteWindow.winconfig_event() #26404

Uh oh!

taleinat commented May 27, 2021 •

edited

Loading

Uh oh!

terryjreedy commented May 27, 2021 •

edited

Loading

Uh oh!

terryjreedy May 27, 2021

Uh oh!

taleinat May 27, 2021 •

edited

Loading

Uh oh!

terryjreedy May 27, 2021

Uh oh!

terryjreedy May 27, 2021

Uh oh!

taleinat May 27, 2021 •

edited

Loading

Uh oh!

miss-islington commented May 28, 2021

Uh oh!

bedevere-bot commented May 28, 2021

Uh oh!

bedevere-bot commented May 28, 2021

Uh oh!

bedevere-bot commented May 28, 2021

Uh oh!

terryjreedy commented Jun 1, 2021 •

edited by bedevere-bot

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

bpo-41611: IDLE: Catch TclError exceptions in AutoCompleteWindow.winconfig_event() #26404

bpo-41611: IDLE: Catch TclError exceptions in AutoCompleteWindow.winconfig_event() #26404

Uh oh!

Conversation

taleinat commented May 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

terryjreedy commented May 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

terryjreedy May 27, 2021

Choose a reason for hiding this comment

Uh oh!

taleinat May 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

terryjreedy May 27, 2021

Choose a reason for hiding this comment

Uh oh!

terryjreedy May 27, 2021

Choose a reason for hiding this comment

Uh oh!

taleinat May 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

miss-islington commented May 28, 2021

Uh oh!

bedevere-bot commented May 28, 2021

Uh oh!

bedevere-bot commented May 28, 2021

Uh oh!

bedevere-bot commented May 28, 2021

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Uh oh!

terryjreedy commented Jun 1, 2021 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

taleinat commented May 27, 2021 •

edited

Loading

terryjreedy commented May 27, 2021 •

edited

Loading

taleinat May 27, 2021 •

edited

Loading

taleinat May 27, 2021 •

edited

Loading

terryjreedy commented Jun 1, 2021 •

edited by bedevere-bot

Loading