Improve RemoteProgress parse return typing#2187
Merged
Byron merged 1 commit intoJul 26, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adjusts the typing contract of RemoteProgress._parse_progress_line() to support subclass overrides that return a value (without violating Liskov substitutability), while keeping the base implementation conceptually “void” and ensuring internal callers ignore the return value.
Changes:
- Broaden
RemoteProgress._parse_progress_line()return annotation fromNonetoOptional[object], and make the base implementation returnNoneexplicitly on all paths. - Update
RemoteProgress.new_message_handler()to ignore_parse_progress_line()’s return value (avoids returning a non-Nonetype from a-> Nonehandler). - Add a regression test demonstrating a subclass override that returns a non-
Nonevalue.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
git/util.py |
Broadens _parse_progress_line() return typing and ensures call sites (message handler) don’t propagate that return value. |
test/deprecation/test_remote_progress.py |
Adds a regression test proving overrides may return non-None under the new base typing. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
RemoteProgress._parse_progress_line()fromNonetoOptional[object]so subclass overrides may return a value without violating the base type.Noneexplicitly and keepnew_message_handler()ignoring that return value.Nonevalue.Closes #1834
Checks
.venv/bin/python -m pytest test/deprecation/test_remote_progress.py.venv/bin/python -m mypy git/util.py test/deprecation/test_remote_progress.py.venv/bin/python -m ruff check git/util.py test/deprecation/test_remote_progress.py.venv/bin/python -m ruff format --check git/util.py test/deprecation/test_remote_progress.pyAI agent disclosure
OpenAI Codex prepared this scoped code/test change and PR text. I reviewed the diff and ran the checks above.