Add more typing to debugpy and switch to 'standard' type checking mode by rchiodo · Pull Request #1637 · microsoft/debugpy

Rich Chiodo (rchiodo) · 2024-07-24T21:34:39Z

This is entirely necessary but I was using this to test Pylance. Seems like a good thing to be more strictly typed though.

…bugpy into rchiodo/type_standard

…odo/type_standard # Conflicts: # CONTRIBUTING.md # src/debugpy/adapter/clients.py # src/debugpy/adapter/launchers.py # src/debugpy/adapter/servers.py # src/debugpy/common/sockets.py # src/debugpy/server/api.py # src/debugpy/server/cli.py # tests/requirements.txt

Heejae Chang (heejaechang) · 2026-07-16T19:01:35Z

🔒 Automated review in progress — Heejae Chang (@heejaechang) is auto-reviewing this PR.

Heejae Chang (heejaechang) · 2026-07-16T20:19:12Z

Overall this is a solid, well-tested typing pass. A few non-blocking notes below about failing-fast vs. substituting degraded fallback values on the newly-added None paths, plus one latent -O-mode crash path in servers.py. Nothing here blocks merge.

Heejae Chang (heejaechang)

Approved via Review Center.

Address review feedback on the typing pass: replace silently-degraded None fallbacks with fail-fast asserts, and make ThreadSafeSingleton.assert_locked side-effect-free. - singleton.py: assert_locked now checks lock._is_owned() instead of acquire()/release(), avoiding RLock recursion-count mutation and an unbalanced release() under python -O. - servers.py: assert pydevdSystemInfo result is non-exception (pid/ppid always assigned before use); assert listener in inject() rather than connecting to an empty address. - clients.py: assert servers.listener in attach_request and the client listener in notify_of_subprocess instead of substituting ("", 0)/None. - debuggee.py: assert process in wait_for_exit rather than reporting a bogus clean exit (code 0). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Heejae Chang (heejaechang) · 2026-07-16T21:29:41Z

Overall the added typing and the _settrace success-latching fix look good. Two things to resolve before merge: (1) tighten the new/changed test assertions to exact-match per the repo's partial-assert rule, and (2) confirm the intended contract for the new configure() "already running" guard, since _settrace.called is a process-global latch that is never cleared.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Heejae Chang (heejaechang)

Approved via Review Center.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…numeration - components.py: cast to the TypeVar T instead of the runtime ype parameter (reportInvalidTypeForm). - log.py: extend the protocol/guard to require both name and version so pkg.version is valid. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Heejae Chang (heejaechang) · 2026-07-20T23:00:41Z

GitHub cannot anchor PR review comments to unchanged lines in the diff. Falling back to a general PR comment for src/debugpy/common/messaging.py:L726.

📍 src/debugpy/common/messaging.py:726
Response._parse can pass its default body=None for a successful response without a body, but Response.__init__ now accepts only MessageDict | Exception. Model empty successful responses in this contract (or normalize them) so standard type checking passes and matches the runtime behavior.

…l__ and Response - Message.__call__ now raises exception payloads explicitly instead of relying on an assert, so behavior is consistent when assertions are stripped under python -O. - Request.respond normalizes a None body for successful empty responses to an empty payload, so Response.body is always a MessageDict or Exception (fixes standard type checking and matches how incoming empty responses are parsed). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Rich Chiodo (rchiodo) · 2026-07-20T23:24:11Z

Fixed in d9532bb (re: src/debugpy/common/messaging.py:726, empty successful responses). Request.respond now normalizes a None body for a successful no-body response into an empty payload (_payload(None)) before constructing the Response, so Response.body is always a MessageDict or an Exception. This makes standard type checking pass (Response.init keeps its MessageDict | Exception contract) and matches how incoming empty responses are already parsed (Response._parse fills a missing body with an empty dict), so the outgoing and incoming paths are now consistent. The emitted JSON is unchanged — an empty/None body is still omitted from the wire message.

Heejae Chang (heejaechang)

Approved via Review Center.

The configurationDone_request guard was changed from a silently ineffective request.cant_handle(...) into a fail-fast raise. Add targeted coverage for receiving configurationDone before a start request and after startup has already begun, verifying a failure response is sent and startup side effects do not run. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Heejae Chang (heejaechang)

Approved via Review Center.

…ards The _start_message_handler handle() only ever receives launch/attach requests (enforced by the assert on entry). Typing it as messaging.Message forced isinstance(request, messaging.Request) fallbacks that, with assertions disabled (python -O), could let a non-request message skip initialization/response and leave the client waiting. Type the parameter as messaging.Request and remove the now-redundant guards. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Heejae Chang (heejaechang)

Approved via Review Center.

sock_io.read() returns b'' at EOF, not None, so the previous is None guard never fired and an empty adapter handshake fell through to json.loads producing a JSONDecodeError. Use a non-shadowing name and check ot data. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Heejae Chang (heejaechang)

Approved via Review Center.

pytest-retry re-runs flaky tests' setup/call phases directly without firing pytest_runtest_makereport, so pytest 9's tmp_path finalizer never repopulates its tmppath_result_key stash entry after the first attempt's teardown deletes it, raising KeyError at teardown (seen on py314 when test_attach_pid_client was retried). Re-seed the stash key in a pytest_runtest_setup hook, which pytest-retry runs on each retry. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Rich Chiodo (rchiodo) added 8 commits July 5, 2024 18:15

Make typing even more restrictive and start fixing some more errors
3d7808e

More typing
e528e2d

Finish typing debupy python code
622e3c6

Rest of the API typed
50e8d1d

Put back wait_for_client variable
063bb6a

Update test requirements
5dd7fe9

Fix converter
3ee1940

Merge remote-tracking branch 'upstream/main' into rchiodo/type_standard
891d5df

Rich Chiodo (rchiodo) requested a review from a team as a code owner July 24, 2024 21:34

Fix linter
931d83c

Erik De Bonte (debonte) reviewed Jul 24, 2024
View reviewed changes

Comment threadsrc/debugpy/adapter/clients.py Outdated
Comment threadsrc/debugpy/adapter/clients.py Outdated
Comment threadsrc/debugpy/common/messaging.py Outdated
Comment threadsrc/debugpy/common/messaging.py Outdated

Rich Chiodo (rchiodo) added 3 commits July 24, 2024 22:01

Fix messaging error
7a1350a

Review feedback and fixup more types
8ce6670

fix request_options
4d609d2

Erik De Bonte (debonte) previously approved these changes Jul 24, 2024
View reviewed changes

Rich Chiodo (rchiodo) added 11 commits July 24, 2024 17:34

Fix debug output and put wait back the way it was
fddf0de

Skip importing sessions unless type checking
c02affd

Hide types to prevent runtime issue
bfd9b88

Fix linter
046fe6f

Remove inappropriate static method
0196522

Merge branch 'rchiodo/type_standard' ofhttps://github.com/rchiodo/de…
fac2692
…bugpy into rchiodo/type_standard

Fix linux failures
6e3bde7

Fix type errors
8b8467a

Cannot reference socket even in types
2ce0c69

Merge branch 'rchiodo/type_standard' ofhttps://github.com/rchiodo/de…
e5f1889
…bugpy into rchiodo/type_standard

Fix linter again
9c7c06b

Rich Chiodo (rchiodo) dismissed Erik De Bonte (debonte)’s stale review via 9c7c06bMarch 31, 2025 23:27

Rich Chiodo (rchiodo) requested a review from a team as a code owner July 16, 2026 19:00

Heejae Chang (heejaechang) approved these changes Jul 16, 2026
View reviewed changes

Heejae Chang (heejaechang) reviewed Jul 16, 2026
View reviewed changes

Comment threadtests/debugpy/common/test_messaging.py Outdated

Heejae Chang (heejaechang) reviewed Jul 16, 2026
View reviewed changes

Comment threadtests/debugpy/server/test_api.py Outdated

Heejae Chang (heejaechang) reviewed Jul 16, 2026
View reviewed changes

Comment threadtests/debugpy/server/test_api.py Outdated

Heejae Chang (heejaechang) reviewed Jul 16, 2026
View reviewed changes

Comment threadsrc/debugpy/server/api.py Outdated

Fix messaging response test race
fbb7bd4
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Heejae Chang (heejaechang) reviewed Jul 17, 2026
View reviewed changes

Comment threadsrc/debugpy/launcher/output.py Outdated

Heejae Chang (heejaechang) approved these changes Jul 17, 2026
View reviewed changes

Address latest review feedback
61402bb
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Heejae Chang (heejaechang) reviewed Jul 17, 2026
View reviewed changes

Comment threadsrc/debugpy/adapter/components.py Outdated

Heejae Chang (heejaechang) reviewed Jul 17, 2026
View reviewed changes

Comment threadsrc/debugpy/common/log.py

Heejae Chang (heejaechang) reviewed Jul 20, 2026
View reviewed changes

Comment threadsrc/debugpy/common/messaging.py Outdated

Heejae Chang (heejaechang) reviewed Jul 20, 2026
View reviewed changes

Comment threadsrc/debugpy/adapter/clients.py

Heejae Chang (heejaechang) approved these changes Jul 20, 2026
View reviewed changes

Heejae Chang (heejaechang) reviewed Jul 21, 2026
View reviewed changes

Comment threadsrc/debugpy/adapter/clients.py

Heejae Chang (heejaechang) approved these changes Jul 21, 2026
View reviewed changes

Heejae Chang (heejaechang) reviewed Jul 21, 2026
View reviewed changes

Comment threadsrc/debugpy/server/api.py Outdated

Heejae Chang (heejaechang) approved these changes Jul 21, 2026
View reviewed changes

Uh oh!

Conversation

Rich Chiodo (rchiodo) commented Jul 24, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Heejae Chang (heejaechang) commented Jul 16, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Heejae Chang (heejaechang) commented Jul 16, 2026

Uh oh!

Heejae Chang (heejaechang) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Heejae Chang (heejaechang) commented Jul 16, 2026

Uh oh!

Uh oh!

Heejae Chang (heejaechang) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Heejae Chang (heejaechang) commented Jul 20, 2026

Uh oh!

Rich Chiodo (rchiodo) commented Jul 20, 2026

Uh oh!

Uh oh!

Heejae Chang (heejaechang) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Heejae Chang (heejaechang) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Heejae Chang (heejaechang) left a comment

Choose a reason for hiding this comment

Uh oh!

Heejae Chang (heejaechang) left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Heejae Chang (heejaechang) commented Jul 16, 2026•
edited
Loading