FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-145378: Generate consistent colors for pdb commands by gaogaotiantian · Pull Request #149305 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-145378: Generate consistent colors for pdb commands #149305

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
gaogaotiantian merged 4 commits into from
May 5, 2026
+45 −0
Conversation 5 Commits 4 Checks 53 Files changed 3
Merged

gh-145378: Generate consistent colors for pdb commands #149305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3ade678
Generator consistent colors for pdb commands
gaogaotiantian May 3, 2026
544f497
Move buffer change inside if
gaogaotiantian May 3, 2026
7d89870
📜🤖 Added by blurb_it.
blurb-it[bot] May 3, 2026
9b5aa70
Fix test
gaogaotiantian May 3, 2026
File filter

Filter by extension

Filter by extension .py  (2) .rst  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
21 changes: 21 additions & 0 deletions Lib/pdb.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@ def __init__(self, pdb_instance, stdin, stdout, prompt):
completer_delims=frozenset(' \t\n`@#%^&*()=+[{]}\\|;:\'",<>?')
)
)
self.readline_wrapper.get_reader().gen_colors = self.gen_colors

def readline(self):

Expand Down Expand Up @@ -463,6 +464,26 @@ def complete(self, text, state):
except IndexError:
return None

def gen_colors(self, buffer):
from _pyrepl.utils import ColorSpan, Span

corona10 May 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Just nit comment, now we can use lazy import right?

StanFromIreland May 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Also, the import has to be conditional per #145035. Similarly to what Hugo had to do here.

gaogaotiantian May 3, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This instance itself is protected by a check for the existence of _pyrepl (_pyrepl_available). If this instance is created, then _pyrepl must exist. Having these _pyrepl related imports inside the method saves us the trouble to deal with the cases where _pyrepl does not exist. If the same class is used multiple times, lazy import might be a better options. I hope that makes sense?

if not buffer.strip():
return

leading_spaces = len(buffer) - len(buffer.lstrip())
leading_text = buffer.split()[0]
if hasattr(self.pdb_instance, 'do_' + leading_text):
yield ColorSpan(
Span(leading_spaces, leading_spaces + len(leading_text) - 1),
"soft_keyword"
)
# Redact the command text with spaces so there will be no duplicated
# color span generated for it later.
redact_length = leading_spaces + len(leading_text)
buffer = ' ' * redact_length + buffer[redact_length:]

yield from _pyrepl.utils.gen_colors(buffer)


class Pdb(bdb.Bdb, cmd.Cmd):
_previous_sigint_handler = None
Expand Down
23 changes: 23 additions & 0 deletions Lib/test/test_pdb.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -4981,6 +4981,29 @@ def test_stack_entry(self):
p.set_trace(commands=['w', 'c'])
self.assertIn("\x1b", output.getvalue())

@unittest.skipIf(not pdb._pyrepl_available(), "pyrepl is not available")
def test_gen_colors(self):
p = pdb.Pdb()
gen_colors = p.pyrepl_input.gen_colors

test_cases = [
("longlist", [((0, 7), "soft_keyword")]),
("!longlist", [((0, 0), "op")]),
("list", [((0, 3), "soft_keyword")]),
("list(", [((0, 3), "builtin"), ((4, 4), "op")]),
("a = 1", [
((0, 0), "soft_keyword"),
((2, 2), "op"),
((4, 4), "number"),
])
]

for buffer, expected in test_cases:
for color_span, ((start, end), tag) in zip(gen_colors(buffer), expected, strict=True):
self.assertEqual(color_span.span.start, start)
self.assertEqual(color_span.span.end, end)
self.assertEqual(color_span.tag, tag)


@support.force_not_colorized_test_class
@support.requires_subprocess()
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2026-05-03-01-49-57.gh-issue-145378.rtyAWM.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Generate consistent colors for :mod:`pdb` commands in :mod:`pdb` REPL.
Loading
Back | FazBrowse Home | New Git URL