Skip to content

gh-118911: Trailing whitespace in a block shouldn't prevent the user from terminating the code block #119355

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
ambv merged 8 commits into from
May 22, 2024
Merged

gh-118911: Trailing whitespace in a block shouldn't prevent the user from terminating the code block #119355

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
77ca92a
gh-118911: Trailing whitespace in a block shouldnt prevent the user f…
aelsayed95 May 21, 2024
edbf327
📜🤖 Added by blurb_it.
blurb-it[bot] May 21, 2024
4996c5e
for clarity
aelsayed95 May 21, 2024
6ee25da
Merge branch 'fix_issue_118911' of github.com:aelsayed95/cpython into…
aelsayed95 May 21, 2024
6c0682b
lint
aelsayed95 May 21, 2024
4e62b96
reword NEWS.d
aelsayed95 May 21, 2024
71d1bcb
Merge branch 'main' into gh-119355
ambv May 22, 2024
27ad76c
Fix ReST syntax in blurb, reword a bit
ambv May 22, 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
Prev Previous commit
Next Next commit
Merge branch 'main' into gh-119355
  • Loading branch information
@ambv
ambv committed May 22, 2024
commit 71d1bcb3f22e513b5db7b836c90e600525be6ed2
25 changes: 17 additions & 8 deletions Lib/_pyrepl/readline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ def do(self) -> None:
r: ReadlineAlikeReader
r = self.reader # type: ignore[assignment]
r.dirty = True # this is needed to hide the completion menu, if visible
#

# if there are already several lines and the cursor
# is not on the last one, always insert a new \n.
text = r.get_unicode()
Expand All @@ -257,20 +257,29 @@ def _newline_before_pos():
while before_idx > 0 and text[before_idx].isspace():
before_idx -= 1
return text[before_idx : r.pos].count("\n") > 0
#

# if there's already a new line before the cursor then
# even if the cursor is followed by whitespace, we assume
# the user is trying to terminate the block
if _newline_before_pos() and text[r.pos:].isspace():
self.finish = True
else:
#
# auto-indent the next line like the previous line
prevlinestart, indent = _get_previous_line_indent(r.buffer, r.pos)
r.insert("\n")
if not self.reader.paste_mode and indent:
return

# auto-indent the next line like the previous line
prevlinestart, indent = _get_previous_line_indent(r.buffer, r.pos)
r.insert("\n")
if not self.reader.paste_mode:
if indent:
for i in range(prevlinestart, prevlinestart + indent):
r.insert(r.buffer[i])
r.update_last_used_indentation()
if _is_last_char_colon(r.buffer):
if r.last_used_indentation is not None:
indentation = r.last_used_indentation
else:
# default
indentation = " " * 4
r.insert(indentation)
elif not self.reader.paste_mode:
self.finish = True
else:
Expand Down
12 changes: 10 additions & 2 deletions Lib/test/test_pyrepl/test_pyrepl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,9 +408,17 @@ def test_multiline_edit(self):
Event(evt="key", data="left", raw=bytearray(b"\x1bOD")),
Event(evt="key", data="left", raw=bytearray(b"\x1bOD")),
Event(evt="key", data="left", raw=bytearray(b"\x1bOD")),
Event(evt="key", data="backspace", raw=bytearray(b"\x7f")),
Event(evt="key", data="backspace", raw=bytearray(b"\x08")),
Event(evt="key", data="g", raw=bytearray(b"g")),
Event(evt="key", data="down", raw=bytearray(b"\x1bOB")),
Event(evt="key", data="backspace", raw=bytearray(b"\x08")),
Event(evt="key", data="delete", raw=bytearray(b"\x7F")),
Event(evt="key", data="right", raw=bytearray(b"g")),
Event(evt="key", data="backspace", raw=bytearray(b"\x08")),
Event(evt="key", data="p", raw=bytearray(b"p")),
Event(evt="key", data="a", raw=bytearray(b"a")),
Event(evt="key", data="s", raw=bytearray(b"s")),
Event(evt="key", data="s", raw=bytearray(b"s")),
Event(evt="key", data="\n", raw=bytearray(b"\n")),
Event(evt="key", data="\n", raw=bytearray(b"\n")),
],
Expand All @@ -420,7 +428,7 @@ def test_multiline_edit(self):
output = multiline_input(reader)
self.assertEqual(output, "def f():\n ...\n ")
output = multiline_input(reader)
self.assertEqual(output, "def g():\n ...\n ")
self.assertEqual(output, "def g():\n pass\n ")

def test_history_navigation_with_up_arrow(self):
events = itertools.chain(
Expand Down
8 changes: 4 additions & 4 deletions Lib/test/test_pyrepl/test_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ def test_newline_within_block_trailing_whitespace(self):
# fmt: off
code = (
"def foo():\n"
" a = 1\n"
"a = 1\n"
)
# fmt: on

Expand Down Expand Up @@ -170,9 +170,9 @@ def test_newline_within_block_trailing_whitespace(self):
"def foo():\n"
"\n"
"\n"
" a = 1\n"
" \n"
" " # HistoricalReader will trim trailing whitespace
" a = 1\n"
" \n"
" " # HistoricalReader will trim trailing whitespace
)
self.assert_screen_equals(reader, expected)
self.assertTrue(reader.finished)
You are viewing a condensed version of this merge commit. You can view the full changes here.