May 2, 2024 · May 2, 2024 · May 2, 2024 · May 2, 2024 · May 2, 2024 · May 2, 2024
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
  command line option or :envvar:`PYTHONSAFEPATH` environment variable).
  (Contributed by Tian Gao and Christian Walther in :gh:`111762`.)

 * :mod:`zipapp` is supported as a debugging target.
  (Contributed by Tian Gao in :gh:`118501`.)

 queue
 -----

diff --git a/Lib/pdb.py b/Lib/pdb.py
    try:
        fp = tokenize.open(filename)
    except OSError:
        return None
        lines = linecache.getlines(filename)
        if not lines:
            return None
        fp = io.StringIO(''.join(lines))
    funcdef = ""
    funcstart = None
    # consumer of this info expects the first line to be 1
        )


 class _ZipTarget(_ExecutableTarget):
    def __init__(self, target):
        import runpy

        self._target = os.path.realpath(target)
        sys.path.insert(0, self._target)
        try:
            _, self._spec, self._code = runpy._get_main_module_details()
        except ImportError as e:
            print(f"ImportError: {e}")
            sys.exit(1)
        except Exception:
            traceback.print_exc()
            sys.exit(1)

    def __repr__(self):
        return self._target

    @property
    def filename(self):
        return self._code.co_filename

    @property
    def code(self):
        return self._code

    @property
    def namespace(self):
        return dict(
            __name__='__main__',
            __file__=os.path.normcase(os.path.abspath(self.filename)),
            __package__=self._spec.parent,
            __loader__=self._spec.loader,
            __spec__=self._spec,
            __builtins__=__builtins__,
        )


 class _PdbInteractiveConsole(code.InteractiveConsole):
    def __init__(self, ns, message):
        self._message = message
            if f:
                fname = f
            item = parts[1]
        answer = find_function(item, fname)
        answer = find_function(item,self.canonic(fname))
        return answer or failed

    def checkline(self, filename, lineno):
        if not opts.args:
            parser.error("no module or script to run")
        file = opts.args.pop(0)
        target = _ScriptTarget(file)
        if file.endswith('.pyz'):
            target = _ZipTarget(file)
        else:
            target = _ScriptTarget(file)

    sys.argv[:] = [file] + opts.args  # Hide "pdb.py" and pdb options from argument list

diff --git a/Lib/test/test_pdb.py b/Lib/test/test_pdb.py
 import subprocess
 import textwrap
 import linecache
 import zipapp

 from contextlib import ExitStack, redirect_stdout
 from io import StringIO
            if filename.endswith(".py"):
                self._run_pdb([os.path.join(script_dir, filename)], 'q')

    def test_zipapp(self):
        with os_helper.temp_dir() as temp_dir:
            os.mkdir(os.path.join(temp_dir, 'source'))
            script = textwrap.dedent(
                """
                def f(x):
                    return x + 1
                f(21 + 21)
                """
            )
            with open(os.path.join(temp_dir, 'source', '__main__.py'), 'w') as f:
                f.write(script)
            zipapp.create_archive(os.path.join(temp_dir, 'source'),
                                  os.path.join(temp_dir, 'zipapp.pyz'))
            stdout, _ = self._run_pdb([os.path.join(temp_dir, 'zipapp.pyz')], '\n'.join([
                'b f',
                'c',
                'p x',
                'q'
            ]))
            self.assertIn('42', stdout)
            self.assertIn('return x + 1', stdout)


 class ChecklineTests(unittest.TestCase):
    def setUp(self):
        linecache.clearcache()  # Pdb.checkline() uses linecache.getline()
diff --git a/Lib/test/test_pyclbr.py b/Lib/test/test_pyclbr.py
        cm(
            'pdb',
            # pyclbr does not handle elegantly `typing` or properties
            ignore=('Union', '_ModuleTarget', '_ScriptTarget'),
            ignore=('Union', '_ModuleTarget', '_ScriptTarget', '_ZipTarget'),
        )
        cm('pydoc', ignore=('input', 'output',)) # properties

diff --git a/Misc/NEWS.d/next/Library/2024-05-02-04-27-12.gh-issue-118500.pBGGtQ.rst b/Misc/NEWS.d/next/Library/2024-05-02-04-27-12.gh-issue-118500.pBGGtQ.rst
 Add :mod:`pdb` support for zipapps
Original file line number	Diff line number	Diff line change
Expand Up		@@ -687,6 +687,9 @@ pdb
		command line option or :envvar:`PYTHONSAFEPATH` environment variable).
		(Contributed by Tian Gao and Christian Walther in :gh:`111762`.)

		* :mod:`zipapp` is supported as a debugging target.
iritkatriel marked this conversation as resolved. Show resolvedHide resolved
		(Contributed by Tian Gao in :gh:`118501`.)

		queue
		-----

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -120,7 +120,10 @@ def find_function(funcname, filename):
		try:
		fp = tokenize.open(filename)
		except OSError:
		return None
		lines = linecache.getlines(filename)
		if not lines:
		return None
		fp = io.StringIO(''.join(lines))
		funcdef = ""
		funcstart = None
		# consumer of this info expects the first line to be 1
Expand DownExpand Up		@@ -237,6 +240,44 @@ def namespace(self):
		)


		class _ZipTarget(_ExecutableTarget):
		def __init__(self, target):
		import runpy

		self._target = os.path.realpath(target)
		sys.path.insert(0, self._target)
iritkatriel marked this conversation as resolved. Show resolvedHide resolved
		try:
		_, self._spec, self._code = runpy._get_main_module_details()
		except ImportError as e:
		print(f"ImportError: {e}")
Copy link Member iritkatrielMay 2, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Why do you need to special-case ImportError here? Copy link MemberAuthor gaogaotiantianMay 2, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. That's from#108791. This is a very common case but the exception traceback would be very large because it's generated rather deeply and it distracts users. It would be a better experience to simply show that there's an import error when the user passes in an invalid module. Copy link Member iritkatrielMay 2, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Ok. there is also traceback.format_exception_only(). Copy link MemberAuthor gaogaotiantianMay 2, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Yeah I think the orignal thought here was just to suppress the common import error, and leave the others be. In that case we need a special case for`ImportError` anyway with or without`format_exception_only`.
		sys.exit(1)
		except Exception:
		traceback.print_exc()
		sys.exit(1)

		def __repr__(self):
		return self._target

		@property
		def filename(self):
		return self._code.co_filename

		@property
		def code(self):
		return self._code

		@property
		def namespace(self):
		return dict(
		__name__='__main__',
		__file__=os.path.normcase(os.path.abspath(self.filename)),
		__package__=self._spec.parent,
		__loader__=self._spec.loader,
		__spec__=self._spec,
		__builtins__=__builtins__,
		)


		class _PdbInteractiveConsole(code.InteractiveConsole):
		def __init__(self, ns, message):
		self._message = message
Expand DownExpand Up		@@ -1076,7 +1117,7 @@ def lineinfo(self, identifier):
		if f:
		fname = f
		item = parts[1]
		answer = find_function(item, fname)
		answer = find_function(item,self.canonic(fname))
		return answer or failed

		def checkline(self, filename, lineno):
Expand DownExpand Up		@@ -2276,7 +2317,10 @@ def main():
		if not opts.args:
		parser.error("no module or script to run")
		file = opts.args.pop(0)
		target = _ScriptTarget(file)
		if file.endswith('.pyz'):
		target = _ZipTarget(file)
		else:
		target = _ScriptTarget(file)

		sys.argv[:] = [file] + opts.args # Hide "pdb.py" and pdb options from argument list

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,6 +10,7 @@
		import subprocess
		import textwrap
		import linecache
		import zipapp

		from contextlib import ExitStack, redirect_stdout
		from io import StringIO
Expand DownExpand Up		@@ -3492,6 +3493,30 @@ def test_non_utf8_encoding(self):
		if filename.endswith(".py"):
		self._run_pdb([os.path.join(script_dir, filename)], 'q')

		def test_zipapp(self):
		with os_helper.temp_dir() as temp_dir:
		os.mkdir(os.path.join(temp_dir, 'source'))
		script = textwrap.dedent(
		"""
		def f(x):
		return x + 1
		f(21 + 21)
		"""
		)
		with open(os.path.join(temp_dir, 'source', '__main__.py'), 'w') as f:
		f.write(script)
		zipapp.create_archive(os.path.join(temp_dir, 'source'),
		os.path.join(temp_dir, 'zipapp.pyz'))
		stdout, _ = self._run_pdb([os.path.join(temp_dir, 'zipapp.pyz')], '\n'.join([
		'b f',
		'c',
		'p x',
		'q'
		]))
		self.assertIn('42', stdout)
		self.assertIn('return x + 1', stdout)


		class ChecklineTests(unittest.TestCase):
		def setUp(self):
		linecache.clearcache() # Pdb.checkline() uses linecache.getline()
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -226,7 +226,7 @@ def test_others(self):
		cm(
		'pdb',
		# pyclbr does not handle elegantly `typing` or properties
		ignore=('Union', '_ModuleTarget', '_ScriptTarget'),
		ignore=('Union', '_ModuleTarget', '_ScriptTarget', '_ZipTarget'),
		)
		cm('pydoc', ignore=('input', 'output',)) # properties

Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add :mod:`pdb` support for zipapps
iritkatriel marked this conversation as resolved. Show resolvedHide resolved