Skip to content

gh-96867: Set zipapp execute bits from readable bits #151970

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
yuanx749 wants to merge 5 commits into
base: main
Choose a base branch
from
+48 −3
Open

gh-96867: Set zipapp execute bits from readable bits #151970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8460f8d
Add test
yuanx749 May 23, 2026
a5e3cb7
Set executable bits from readable bits
yuanx749 May 23, 2026
3159382
Add news entry
yuanx749 Jun 23, 2026
127ca4b
Add PathLike zipapp test
yuanx749 Jun 23, 2026
2de44db
Handle PathLike zipapp targets
yuanx749 Jun 23, 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
33 changes: 33 additions & 0 deletions Lib/test/test_zipapp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""Test harness for the zipapp module."""

import io
import os
import pathlib
import stat
import sys
Expand Down Expand Up @@ -366,6 +367,38 @@ def test_shebang_is_executable(self):
zipapp.create_archive(str(source), str(target), interpreter='python')
self.assertTrue(target.stat().st_mode & stat.S_IEXEC)

@unittest.skipIf(sys.platform == 'win32',
'Windows does not support an executable bit')
@unittest.skipUnless(hasattr(os, 'umask'), 'test needs os.umask()')
@os_helper.skip_unless_working_chmod
def test_shebang_executable_bits_match_readable_bits(self):
source = self.tmpdir / 'source'
source.mkdir()
(source / '__main__.py').touch()
for umask, expected_mode in ((0o022, 0o755), (0o077, 0o700)):
with self.subTest(umask=umask):
target = self.tmpdir / f'source-{umask:o}.pyz'
with os_helper.temp_umask(umask):
zipapp.create_archive(source, target, interpreter='python')
self.assertEqual(stat.S_IMODE(target.stat().st_mode), expected_mode)

@unittest.skipIf(sys.platform == 'win32',
'Windows does not support an executable bit')
@unittest.skipUnless(hasattr(os, 'umask'), 'test needs os.umask()')
@os_helper.skip_unless_working_chmod
def test_copied_shebang_executable_bits_match_readable_bits(self):
source = self.tmpdir / 'source'
source.mkdir()
(source / '__main__.py').touch()
archive = self.tmpdir / 'source.pyz'
zipapp.create_archive(source, archive)
for umask, expected_mode in ((0o022, 0o755), (0o077, 0o700)):
with self.subTest(umask=umask):
target = self.tmpdir / f'target-{umask:o}.pyz'
with os_helper.temp_umask(umask):
zipapp.create_archive(archive, target, interpreter='python')
self.assertEqual(stat.S_IMODE(target.stat().st_mode), expected_mode)

@unittest.skipIf(sys.platform == 'win32',
'Windows does not support an executable bit')
def test_no_shebang_is_not_executable(self):
Expand Down
16 changes: 13 additions & 3 deletions Lib/zipapp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ def _write_file_prefix(f, interpreter):
f.write(shebang)


def _make_executable(path):
mode = os.stat(path).st_mode
executable = (
(mode & stat.S_IRUSR) >> 2
| (mode & stat.S_IRGRP) >> 2
| (mode & stat.S_IROTH) >> 2
)
os.chmod(path, mode | executable)


def _copy_archive(archive, new_archive, interpreter=None):
"""Copy an application archive, modifying the shebang line."""
with _maybe_open(archive, 'rb') as src:
Expand All @@ -69,8 +79,8 @@ def _copy_archive(archive, new_archive, interpreter=None):
dst.write(first_2)
shutil.copyfileobj(src, dst)

if interpreter and isinstance(new_archive, str):
os.chmod(new_archive, os.stat(new_archive).st_mode | stat.S_IEXEC)
if interpreter and isinstance(new_archive, (str, os.PathLike)):
_make_executable(new_archive)


def create_archive(source, target=None, interpreter=None, main=None,
Expand Down Expand Up @@ -169,7 +179,7 @@ def create_archive(source, target=None, interpreter=None, main=None,
z.writestr('__main__.py', main_py.encode('utf-8'))

if interpreter and not hasattr(target, 'write'):
target.chmod(target.stat().st_mode | stat.S_IEXEC)
_make_executable(target)


def get_interpreter(archive):
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2026-06-23-10-14-15.gh-issue-96867._sZyQg.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix :mod:`zipapp` to set executable bits on archives with shebangs based on
their readable permission bits. Contributed by Xiao Yuan.
Loading