Skip to content

pdb CLI doesn't handle incorrect arguments properly #108791

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

Jump to bottom
Closed
2 tasks done
chgnrdv opened this issue Sep 1, 2023 · 0 comments · Fixed by #108816
Closed
2 tasks done

pdb CLI doesn't handle incorrect arguments properly #108791

chgnrdv opened this issue Sep 1, 2023 · 0 comments · Fixed by #108816
Labels
type-bug An unexpected behavior, bug, or error

Comments

@chgnrdv
Copy link
Contributor

chgnrdv commented Sep 1, 2023 •
edited by bedevere-app bot
Loading

Bug report

Checklist

  • I am confident this is a bug in CPython, not a bug in a third-party project
  • I have searched the CPython issue tracker,
    and am confident this bug has not been reported before

CPython versions tested on:

3.11, 3.12, CPython main branch

Operating systems tested on:

Linux

Output from running 'python -VV' on the command line:

Python 3.13.0a0 (heads/main:578ebc5d5f, Sep 1 2023, 20:48:35) [GCC 10.2.1 20210110]

A clear and concise description of the bug:

pdb module produces large traceback instead of short error message if invoked with invalid command line option. This happens because it doesn't handle exceptions that can occur in getopt.getopt, as it typically done.

$ ./python -m pdb -c
Traceback (most recent call last):
  File "/home/radislav/projects/cpython/Lib/runpy.py", line 198, in _run_module_as_main
    return _run_code(code, main_globals, None,
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/radislav/projects/cpython/Lib/runpy.py", line 88, in _run_code
    exec(code, run_globals)
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 2114, in <module>
    pdb.main()
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 2060, in main
    opts, args = getopt.getopt(sys.argv[1:], 'mhc:', ['help', 'command='])
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/radislav/projects/cpython/Lib/getopt.py", line 95, in getopt
    opts, args = do_shorts(opts, args[0][1:], shortopts, args[1:])
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/radislav/projects/cpython/Lib/getopt.py", line 198, in do_shorts
    raise GetoptError(_('option -%s requires argument') % opt,
getopt.GetoptError: option -c requires argument

A similar situation is with nonexistant modules and directory names. In the first case an exception that occurs in _ModuleTarget.check is printed to stderr with its traceback. In the second case directory name is 'successfully' checked by _ScriptTarget.check call, and debugger is ran on invalid target.

$ ./python -m pdb -m spam
Traceback (most recent call last):
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 166, in check
    self._details
  File "/home/radislav/projects/cpython/Lib/functools.py", line 1014, in __get__
    val = self.func(instance)
          ^^^^^^^^^^^^^^^^^^^
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 174, in _details
    return runpy._get_module_details(self)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/radislav/projects/cpython/Lib/runpy.py", line 142, in _get_module_details
    raise error("No module named %s" % mod_name)
ImportError: No module named spam

$ ./python -m pdb /
Traceback (most recent call last):
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 2088, in main
    pdb._run(target)
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 1868, in _run
    self.run(target.code)
             ^^^^^^^^^^^
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 159, in code
    with io.open_code(self) as fp:
         ^^^^^^^^^^^^^^^^^^
IsADirectoryError: [Errno 21] Is a directory: '/'
Uncaught exception. Entering post mortem debugging
Running 'cont' or 'step' will restart the program
> /home/radislav/projects/cpython/Lib/pdb.py(159)code()
-> with io.open_code(self) as fp:
(Pdb) c
Traceback (most recent call last):
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 2088, in main
    pdb._run(target)
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 1868, in _run
    self.run(target.code)
             ^^^^^^^^^^^
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 159, in code
    with io.open_code(self) as fp:
         ^^^^^^^^^^^^^^^^^^
IsADirectoryError: [Errno 21] Is a directory: '/'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/radislav/projects/cpython/Lib/runpy.py", line 198, in _run_module_as_main
    return _run_code(code, main_globals, None,
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/radislav/projects/cpython/Lib/runpy.py", line 88, in _run_code
    exec(code, run_globals)
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 2114, in <module>
    pdb.main()
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 2106, in main
    pdb.interaction(None, e)
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 501, in interaction
    self._cmdloop()
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 405, in _cmdloop
    self.cmdloop()
  File "/home/radislav/projects/cpython/Lib/cmd.py", line 138, in cmdloop
    stop = self.onecmd(line)
           ^^^^^^^^^^^^^^^^^
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 592, in onecmd
    return cmd.Cmd.onecmd(self, line)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/radislav/projects/cpython/Lib/cmd.py", line 217, in onecmd
    return func(arg)
           ^^^^^^^^^
  File "/home/radislav/projects/cpython/Lib/pdb.py", line 1329, in do_continue
    self.set_continue()
  File "/home/radislav/projects/cpython/Lib/bdb.py", line 344, in set_continue
    self._set_stopinfo(self.botframe, None, -1)
                       ^^^^^^^^^^^^^
AttributeError: 'Pdb' object has no attribute 'botframe'. Did you mean: 'curframe'?

I'm working on a fix.

Linked PRs
@chgnrdv chgnrdv added the type-bug An unexpected behavior, bug, or error label Sep 1, 2023
@chgnrdv chgnrdv mentioned this issue Sep 2, 2023
Merged
@gaogaotiantian gaogaotiantian mentioned this issue Sep 8, 2023
Closed
iritkatriel pushed a commit that referenced this issue Oct 16, 2023
@chgnrdv
gh-108791: Fix pdb CLI invalid argument handling (#108816)
162213f
@bedevere-app bedevere-app bot mentioned this issue Oct 16, 2023
Closed
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 16, 2023
@chgnrdv @miss-islington
pythongh-108791: Fix pdb CLI invalid argument handling (pythonGH-10…
7e69c98 
…8816)

(cherry picked from commit 162213f)

Co-authored-by: Radislav Chugunov <52372310+chgnrdv@users.noreply.github.com>
@bedevere-app bedevere-app bot mentioned this issue Oct 16, 2023
Closed
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 16, 2023
@chgnrdv @miss-islington
pythongh-108791: Fix pdb CLI invalid argument handling (pythonGH-10…
4ac4b07 
…8816)

(cherry picked from commit 162213f)

Co-authored-by: Radislav Chugunov <52372310+chgnrdv@users.noreply.github.com>
This was referenced Oct 19, 2023
Merged
Merged
iritkatriel pushed a commit that referenced this issue Oct 19, 2023
@chgnrdv
[3.12] gh-108791: Fix pdb CLI invalid argument handling (GH-108816) (#…
68a5640 
…111064)

* [3.12] gh-108791: Fix `pdb` CLI invalid argument handling (GH-108816)
(cherry picked from commit 162213f)

Co-authored-by: Radislav Chugunov <52372310+chgnrdv@users.noreply.github.com>
iritkatriel pushed a commit that referenced this issue Oct 19, 2023
@chgnrdv
[3.11] gh-108791: Fix pdb CLI invalid argument handling (GH-108816) (#…
26a0282 
…111063)

* [3.11] gh-108791: Fix `pdb` CLI invalid argument handling (GH-108816)
(cherry picked from commit 162213f)

Co-authored-by: Radislav Chugunov <52372310+chgnrdv@users.noreply.github.com>
aisk pushed a commit to aisk/cpython that referenced this issue Feb 11, 2024
@chgnrdv @aisk
pythongh-108791: Fix pdb CLI invalid argument handling (python#108816)
72a98ad
@gaogaotiantian gaogaotiantian mentioned this issue May 2, 2024
Merged
Glyphack pushed a commit to Glyphack/cpython that referenced this issue Sep 2, 2024
@chgnrdv @Glyphack
pythongh-108791: Fix pdb CLI invalid argument handling (python#108816)
643f3fd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-108791: Fix pdb CLI invalid argument handling chgnrdv/cpython
1 participant
@chgnrdv