Skip to content

gh-143511: Document sys.remote_exec permissions requirements #143575

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
Yashp002 wants to merge 18 commits into
base: main
Choose a base branch
from
Open

gh-143511: Document sys.remote_exec permissions requirements #143575

Changes from 13 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
91c984c
execdocs first commit
Yashp002 Jan 8, 2026
d1256a4
remotexec fix 1
Yashp002 Jan 9, 2026
c96d1aa
remotexec fix 2
Yashp002 Jan 10, 2026
9f6d131
remotexec fix 3
Yashp002 Jan 12, 2026
fe77ba9
remotexec fix 3
Yashp002 Jan 14, 2026
6687123
remotexec fix 4
Yashp002 Jan 19, 2026
9d3be80
Retriggering checks
Yashp002 Jan 19, 2026
9290444
Merge branch 'main' into gh-143511-remote-exec-docs
StanFromIreland Jan 20, 2026
17d72e6
Merge branch 'main' into gh-143511-remote-exec-docs
Yashp002 Jan 27, 2026
a92496d
Update Doc/library/sys.rst
Yashp002 Jan 28, 2026
eacadb1
Update Doc/library/sys.rst
Yashp002 Jan 28, 2026
92fc961
Update Doc/library/sys.rst
Yashp002 Jan 28, 2026
809133b
Update Doc/library/sys.rst
Yashp002 Jan 28, 2026
fd20f01
Update Doc/library/sys.rst
Yashp002 Jan 29, 2026
269d9ff
remotexec fix 5
Yashp002 Jan 29, 2026
21f8da8
Merge branch 'main' into gh-143511-remote-exec-docs
Yashp002 Jan 30, 2026
f47c3d6
remotexec fix 6
Yashp002 Jan 31, 2026
5e9f8d8
Merge branch 'gh-143511-remote-exec-docs' of https://github.com/Yashp…
Yashp002 Jan 31, 2026
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
22 changes: 21 additions & 1 deletion Doc/library/sys.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1995,7 +1995,27 @@
The remote process must be running a CPython interpreter of the same major
and minor version as the local process. If either the local or remote
interpreter is pre-release (alpha, beta, or release candidate) then the
local and remote interpreters must be the same exact version.
local and remote interpreters must be the same exact version.

Check warning on line 1998 in Doc/library/sys.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

Explicit markup ends without a blank line; unexpected unindent. [docutils]

Note that the remote process must be able to read the temporary script file in terms
of permissions. If the caller is running under different user than the process,
the caller should grant permissions (typically ``os.fchmod(filename, 0o644)``).

Callers should adjust permissions before calling, for example::

import os
import sys
import tempfile

with tempfile.NamedTemporaryFile(
mode='w',
suffix='.py',
delete_on_close=False,
Copy link
Member

@picnixz picnixz Jan 29, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Ah I am sorry about this suggestion. I thought it would have been enough but I think we need to do revert to your original suggestion with os.unlink(). However, we may need a try-finally + catch OSError for the unlink failure:

file = tempfile.NamedTemporaryFile(mode="w", suffix=".py", delete=False)
try:
    with file:
        ...
finally:
    try:
        os.unlink(file.name)
    except OSError:
        pass

Copy link
Member

@picnixz picnixz Jan 29, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

I remember that sometimes on Windows we have issues with automatic deletion. But altenratively, we could just have a context manager and keep the defaults:

with tempfile.NamedTemporaryFile(mode="w", suffix=".py") as f:
    ...

Copy link
Contributor Author

@Yashp002 Yashp002 Jan 31, 2026

Choose a reason for hiding this comment

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

I've made the change @picnixz, but the CI is detecting an error because of the unchanged label im assuming? Could you review my changes

) as f:
f.write("print('Hello from remote!')")
f.flush()
os.chmod(f.name, 0o644) # Readable by group/other
sys.remote_exec(pid, f.name)

See :ref:`remote-debugging` for more information about the remote debugging
mechanism.
Expand Down
Loading