Skip to content

Use sys.remote_exec() to attach to pid, if available #1986

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

Open
pdepetro wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Use sys.remote_exec() to attach to pid, if available #1986

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f32efd3
Use sys.remote_exec() to attach to pid, if available
pdepetro Dec 30, 2025
955e3b5
Update usage string
pdepetro Dec 31, 2025
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
34 changes: 34 additions & 0 deletions src/debugpy/server/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
[--log-to <path>] [--log-to-stderr]
[--parent-session-pid <pid>]]
[--adapter-access-token <token>]
[--disable-sys-remote-exec]]
{1}
[<arg>]...
""".format(
Expand All @@ -56,6 +57,7 @@ class Options(object):
adapter_access_token = None
config: Dict[str, Any] = {}
parent_session_pid: Union[int, None] = None
disable_sys_remote_exec = False


options = Options()
Expand Down Expand Up @@ -186,6 +188,7 @@ def do(arg, it):
("--configure-.+", "<value>", set_config),
("--parent-session-pid", "<pid>", set_arg("parent_session_pid", lambda x: int(x) if x else None)),
("--adapter-access-token", "<token>", set_arg("adapter_access_token")),
("--disable-sys-remote-exec", None, set_const("disable_sys_remote_exec", True)),

# Targets. The "" entry corresponds to positional command line arguments,
# i.e. the ones not preceded by any switch name.
Expand Down Expand Up @@ -447,6 +450,37 @@ def attach_to_pid():
.replace("\n", "")
.format(script_dir=script_dir, setup=setup)
)

# attempt pep 768 style code injection
if (not options.disable_sys_remote_exec) and hasattr(sys, "remote_exec"):
tmp_file_path = ""
try:
import tempfile

with tempfile.NamedTemporaryFile(delete=False) as tmp_file:
tmp_file_path = tmp_file.name
log.info(
"Attempting to inject code at '{tmp_file_path}' using sys.remote_exec()",
tmp_file_path=tmp_file_path,
)
tmp_file.write(python_code.encode())
tmp_file.write(
"""import os;os.remove("{tmp_file_path}");""".format(
tmp_file_path=tmp_file_path
).encode()
)
tmp_file.flush()
tmp_file.close()
sys.remote_exec(pid, tmp_file_path)
return
except Exception as e:
if os.path.exists(tmp_file_path):
os.remove(tmp_file_path)
log.warning(
'Injecting code using sys.remote_exec() failed with error:\n"{e}"\nWill reattempt using pydevd.\n',
e=e,
)

log.info("Code to be injected: \n{0}", python_code.replace(";", ";\n"))

# pydevd restriction on characters in injected code.
Expand Down