python / python/cpython

Remove distracted red bar from IDLE for some SyntaxErrors

Open
#93,966 3 comments 0 reactions 1 assignee View on GitHub

@terryjreedy is already working on this.

Since Jun 17, 2022.

topic-IDLE type-bug
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

Bug report

This may be more an distracting cosmetic issue than a true bug, but it is something that can be fixed easily.

As Raymond Hettinger mentioned a while ago on Twitter (https://twitter.com/raymondh/status/1501700903870468099), when a SyntaxError is raised and the location corresponds to the "\n" at the end of a line, a huge red highlighted region is shown at the end of the invalid line.

For example, type

from math

followed by enter. This red highlighted line will remain on the screen until another SyntaxError occurs.
Unlike cases where a SyntaxError highlights just a few characters pointing at a specific problem, this adds really no informative value, once the user starts entering some new code.

Your environment

I have reproduced this will IDLE on Windows 10 on all Python versions I have installed, from 3.6 to 3.11 inclusively.

Proposed fix

I have been able to fix this on a custom version of IDLE (friendly_idle) by doing the following:

In pyshell.ModifiedInterpreter.transfer_path which sets up some values at the beginning of a new process,
define the following:

self.error_at_end_of_line = False

In pyshell.ModifiedInterpreter.showsyntaxerror, add the last line shown below:

        if lineno == 1:
            pos = "iomark + %d chars" % (offset - 1)
        else:
            pos = "iomark linestart + %d lines + %d chars" % (lineno - 1, offset - 1)
        self.error_at_end_of_line = text.get(pos) == "\n"  # <-- add this

At the beginning of pyshell.ModifiedInterpreter.runsource, add the following:

        if self.error_at_end_of_line:
            self.error_at_end_of_line = False
            self.tkconsole.text.tag_remove("ERROR", "1.0", "end")

If desired, I could do a pull request that would include these changes.

Linked PRs
  • gh-157595

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.