Skip to content

gh-131178: Add tests for zipapp command-line interface #150203

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
timurmamedov1 wants to merge 1 commit into
base: main
Choose a base branch
from
+126 −1
Open

gh-131178: Add tests for zipapp command-line interface #150203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
126 changes: 125 additions & 1 deletion Lib/test/test_zipapp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
import io
import pathlib
import stat
import subprocess
import sys
import tempfile
import unittest
import zipapp
import zipfile
from test.support import requires_zlib
from test.support import requires_zlib, requires_subprocess
from test.support import os_helper

from unittest.mock import patch
Expand Down Expand Up @@ -455,5 +456,128 @@ def test_info_error(self):
self.assertTrue(cm.exception.code)


@requires_subprocess()
class CommandLineTest(unittest.TestCase):
"""Test the ``python -m zipapp`` command-line interface via subprocess."""

def setUp(self):
tmpdir = tempfile.TemporaryDirectory()
self.addCleanup(tmpdir.cleanup)
self.tmpdir = pathlib.Path(tmpdir.name)

def _run(self, *args):
return subprocess.run(
[sys.executable, '-m', 'zipapp', *args],
capture_output=True,
)
Comment on lines +468 to +472

def _make_source(self, *, main_content=b''):
source = self.tmpdir / 'source'
source.mkdir()
(source / '__main__.py').write_bytes(main_content)
return source

def _make_archive(self, *, interpreter=None):
source = self._make_source()
target = self.tmpdir / 'source.pyz'
zipapp.create_archive(source, target, interpreter=interpreter)
return target

def test_help(self):
result = self._run('--help')
self.assertEqual(result.returncode, 0)
self.assertIn(b'usage:', result.stdout)

def test_create_archive(self):
source = self._make_source()
result = self._run(str(source))
self.assertEqual(result.returncode, 0, result.stderr)
target = source.with_suffix('.pyz')
self.assertTrue(target.is_file())

def test_create_archive_with_output(self):
source = self._make_source()
target = self.tmpdir / 'out.pyz'
result = self._run(str(source), '-o', str(target))
self.assertEqual(result.returncode, 0, result.stderr)
self.assertTrue(target.is_file())

def test_create_archive_with_interpreter(self):
source = self._make_source()
target = self.tmpdir / 'out.pyz'
result = self._run(str(source), '-o', str(target), '-p', '/usr/bin/env python3')
self.assertEqual(result.returncode, 0, result.stderr)
self.assertTrue(target.is_file())
self.assertEqual(zipapp.get_interpreter(target), '/usr/bin/env python3')

def test_create_archive_with_main(self):
source = self.tmpdir / 'pkg'
source.mkdir()
(source / 'mod.py').write_text('def fn(): pass\n', encoding='utf-8')
target = self.tmpdir / 'out.pyz'
result = self._run(str(source), '-o', str(target), '-m', 'mod:fn')
self.assertEqual(result.returncode, 0, result.stderr)
self.assertTrue(target.is_file())
with zipfile.ZipFile(target, 'r') as z:
self.assertIn('__main__.py', z.namelist())

@requires_zlib()
def test_create_archive_with_compress(self):
source = self._make_source(main_content=b'print("hello")\n')
target = self.tmpdir / 'out.pyz'
result = self._run(str(source), '-o', str(target), '-c')
self.assertEqual(result.returncode, 0, result.stderr)
with zipfile.ZipFile(target, 'r') as z:
self.assertEqual(z.getinfo('__main__.py').compress_type,
zipfile.ZIP_DEFLATED)

def test_info_command(self):
target = self._make_archive(interpreter='python3')
result = self._run(str(target), '--info')
self.assertEqual(result.returncode, 0, result.stderr)
self.assertIn(b'Interpreter: python3', result.stdout)

def test_info_no_interpreter(self):
target = self._make_archive()
result = self._run(str(target), '--info')
self.assertEqual(result.returncode, 0, result.stderr)
self.assertIn(b'Interpreter: <none>', result.stdout)

def test_info_nonexistent_file(self):
target = self.tmpdir / 'nonexistent.pyz'
result = self._run(str(target), '--info')
self.assertNotEqual(result.returncode, 0)
Comment on lines +546 to +549

def test_copy_archive(self):
original = self._make_archive()
target = self.tmpdir / 'copy.pyz'
result = self._run(str(original), '-o', str(target))
self.assertEqual(result.returncode, 0, result.stderr)
self.assertTrue(target.is_file())

def test_copy_archive_inplace_fails(self):
original = self._make_archive()
result = self._run(str(original), '-o', str(original))
self.assertNotEqual(result.returncode, 0)

def test_copy_archive_change_main_fails(self):
original = self._make_archive()
target = self.tmpdir / 'copy.pyz'
result = self._run(str(original), '-o', str(target), '-m', 'foo:bar')
self.assertNotEqual(result.returncode, 0)

def test_no_source_argument(self):
result = self._run()
self.assertNotEqual(result.returncode, 0)
self.assertIn(b'usage:', result.stderr)

def test_no_main_in_source(self):
source = self.tmpdir / 'empty'
source.mkdir()
(source / 'foo.py').touch()
result = self._run(str(source))
self.assertNotEqual(result.returncode, 0)


if __name__ == "__main__":
unittest.main()
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Tests/2026-05-21-22-06-07.gh-issue-131178.zipapp_cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add subprocess-based tests for the :mod:`zipapp` command-line interface.
Loading