Repository navigation
gh-122622: Add PyREPL simple_interact.statement_submitted_hook #157241
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.
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
Open
edvilme
wants to merge
27
commits into
python:main
Choose a base branch
from
edvilme:pyrepl-hook
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+193
−3
Open
Changes from all commits
Commits
Show all changes
27 commits
Select commit
Hold shift + click to select a range
4c18d3b
gh-122622: Add PyREPL pre-execution hook
edvilme b988e6f
Add empty pre_execution_hook for feature detection
edvilme 7d9ddbf
Update tests to verify no interference
edvilme ad17396
📜🤖 Added by blurb_it.
blurb-it[bot] 0ef602c
Update NEWS
edvilme 8ede9b2
Address feedback
edvilme 6d7dfe0
Address feedback
edvilme d45c1d3
Merge branch 'main' into pyrepl-hook
edvilme e1186d5
Show tracebakcs
edvilme f615af2
Add tests to make sure hook runs before exception
edvilme f766b48
Update comment
edvilme a81c71a
Fix incorrect comment
edvilme a98d37a
Merge branch 'main' into pyrepl-hook
edvilme d948c28
Merge branch 'main' into pyrepl-hook
brettcannon ce55702
Strip final indent from submitted hook
edvilme 8665769
Show traceback as a hook failure without modifying sys.last_*
edvilme b7e9986
Simplify comment to remove example
edvilme 753ed83
Add tests for KeyboardInterrupt and SystemExit
edvilme d2a7a45
Add test for strip indentation
edvilme ac8d177
Remove weak return value test
edvilme e28071a
Add PTY test
edvilme d6cd848
Update tests
edvilme 7be412f
Update News entry
edvilme 0ea14cd
Do not call _strip_final_indent twice
edvilme 8ea46f3
Rename to input_submitted_hook
edvilme c385c46
Added Exception clarification to comment
edvilme 9d4fe71
Merge branch 'main' into pyrepl-hook
edvilme File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
3 changes: 3 additions & 0 deletions
3
Misc/NEWS.d/next/Library/2026-09-09-23-15-03.gh-issue-122622.YfSSrl.rst
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Add an optional ``_pyrepl.simple_interact.input_submitted_hook`` callback | ||
| that runs after input is submitted and before it is executed, | ||
| allowing external tools to implement features such as shell integration. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't rely on mocks of internal attributes.
I'd test this with a PTY instead, maybe in
test_pyrepl.TestMain?That ensures the things that need to be displayed to the user are actually displayed to the user.
Example:
cpython/Lib/test/test_pyrepl/test_pyrepl.py
Lines 2482 to 2492 in d948c28
(This applies to all tests in this PR, I'd try to fit all of them into a few tests in
test_pyrepl.TestMain)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A PTY test makes sense here. The unit tests still exercise real statement execution, so I see no need to replace all of them.
One detail: the example needs
flush=True, or the execution marker can stay in the buffer until the statement finishes. Our PTY helper uses-u, so it will miss that case.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added e28071a0a0a: Add PTY test.
The new TestMain test installs the hook through actual REPL input and checks that labelled hook errors reach the terminal while subsequent statements still execute. I retained the focused unit tests, following Pablo's suggestion. The inline escape-sequence example has also been removed in b7e9986fc46: Simplify comment to remove example; this PTY test does not claim to validate buffering behavior.
Validation:
.\PCbuild\amd64\python.exe -m test -v test_pyrepl.test_interact test_pyrepl.test_pyrepl -m '*TestStatementSubmittedHook*' -m '*statement_submitted_hook*'passed on Windows: 9 hook unit tests passed, and 2 PTY test variants were skipped. Unix execution of the new PTY test is still pending.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This test is still relying on mocking internal attributes, is it possible to not do it that way?