gh-108791: Fix `pdb` CLI invalid argument handling by chgnrdv · Pull Request #108816 · python/cpython

chgnrdv · 2023-09-02T16:04:48Z

Fixes #108791.
pdb module, if invoked with invalid command line arguments, produces large traceback and/or tries to run debugger on errorneus target, such as directory. This patch improves error handling in pdb CLI, making error messages more concise.

Issue: pdb CLI doesn't handle incorrect arguments properly #108791

`pdb` module, if invoked with invalid command line arguments, produces large traceback and/or tries to run debugger on errorneus target, such as directory. This patch improves error handling in pdb CLI, making error messages more concise.

chgnrdv · 2023-09-02T16:11:16Z

I had to make changes in test_module_without_a_main, as it was taking error message from context exception.

Traceback (most recent call last):
  File "/home/radislav/projects/cpython/Lib/runpy.py", line 148, in _get_module_details
    return _get_module_details(pkg_main_name, error)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  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 t_main.__main__

During handling of the above exception, another exception occurred:

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 152, in _get_module_details
    raise error(("%s; %r is a package and cannot " +
ImportError: No module named t_main.__main__; 't_main' is a package and cannot be directly executed

…on into pdb-cli-fix-error-handling

sunmy2019 · 2023-09-02T18:30:28Z

Lib/pdb.py

-        except Exception:
-            traceback.print_exc()
+        except Exception as e:
+            print(f"{type(e).__name__}: {e}")


Can you make it something like

try: self._details except ... : # Something you expect print(f"{type(e).__name__}: {e}") except Exception: traceback.print_exc()

to leave the general case untouched.

Looking at the runpy._get_module_details source, ImportError seems to be the only type of exception that can be raised here.

…eback otherwise

gaogaotiantian

I think the improvement is fine. The argument parser piece is a bit hacky, but I'm planning to convert that part to argparse anyway (getopt has not been updated for like 10 years) so it's okay.

gaogaotiantian · 2023-10-07T00:24:27Z

Hi @chgnrdv , as I updated pdb to use argparse instead of getopt, the argument parsing piece might be fixed (more importantly, the code in this PR was definitely outdated). Could you resolve the conflicts in this PR, hopefully keep the relevant tests? I'll try to find the core dev to review this once it's fixed. Thanks.

chgnrdv · 2023-10-07T23:26:30Z

@gaogaotiantian, thanks for notice, I'll take a look tomorrow.

gaogaotiantian · 2023-10-11T04:25:41Z

LGTM, @iritkatriel could you take a look? Thanks!

Lib/test/test_pdb.py

iritkatriel · 2023-10-15T19:36:55Z

LGTM.

Should this be backported?

gaogaotiantian · 2023-10-15T20:01:25Z

Rare case, but safe and backward compatible. I think it should be back-ported.

sunmy2019 · 2023-10-16T07:36:59Z

Agreed

miss-islington · 2023-10-16T09:38:12Z

Thanks @chgnrdv for the PR, and @iritkatriel for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

…8816) (cherry picked from commit 162213f) Co-authored-by: Radislav Chugunov <[email protected]>

bedevere-app · 2023-10-16T09:38:29Z

GH-110915 is a backport of this pull request to the 3.12 branch.

bedevere-app · 2023-10-16T09:38:38Z

GH-110916 is a backport of this pull request to the 3.11 branch.

…8816) (cherry picked from commit 162213f) Co-authored-by: Radislav Chugunov <[email protected]>

bedevere-app · 2023-10-19T09:29:08Z

GH-111063 is a backport of this pull request to the 3.11 branch.

bedevere-app · 2023-10-19T09:30:39Z

GH-111064 is a backport of this pull request to the 3.12 branch.

…111064) * [3.12] gh-108791: Fix `pdb` CLI invalid argument handling (GH-108816) (cherry picked from commit 162213f) Co-authored-by: Radislav Chugunov <[email protected]>

…111063) * [3.11] gh-108791: Fix `pdb` CLI invalid argument handling (GH-108816) (cherry picked from commit 162213f) Co-authored-by: Radislav Chugunov <[email protected]>

Fix pdb command line interface error handling

e515e7c

`pdb` module, if invoked with invalid command line arguments, produces large traceback and/or tries to run debugger on errorneus target, such as directory. This patch improves error handling in pdb CLI, making error messages more concise.

bedevere-bot mentioned this pull request Sep 2, 2023

pdb CLI doesn't handle incorrect arguments properly #108791

Closed

2 tasks

bedevere-bot added the awaiting review label Sep 2, 2023

blurb-it bot and others added 2 commits September 2, 2023 16:07

📜🤖 Added by blurb_it.

601d2f4

Merge branch 'main' into pdb-cli-fix-error-handling

d55710e

AlexWaygood requested a review from gaogaotiantian September 2, 2023 16:15

chgnrdv added 3 commits September 2, 2023 19:25

fixed tests

256a955

Merge branch 'pdb-cli-fix-error-handling' of github.com:chgnrdv/cpyth…

de830e3

…on into pdb-cli-fix-error-handling

changed test_module_without_a_main

77ef451

sunmy2019 reviewed Sep 2, 2023

View reviewed changes

changed _ModuleTarget.check to handle only ImportError and print trac…

7f4c649

…eback otherwise

gaogaotiantian approved these changes Sep 3, 2023

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Sep 3, 2023

adapted fix/test to changes in pdb CLI

506ec9d

chgnrdv requested a review from gaogaotiantian October 10, 2023 14:07

gaogaotiantian approved these changes Oct 11, 2023

View reviewed changes

gaogaotiantian requested a review from iritkatriel October 11, 2023 04:25

iritkatriel reviewed Oct 11, 2023

View reviewed changes

Lib/test/test_pdb.py Show resolved Hide resolved

chgnrdv added 2 commits October 11, 2023 14:25

Merge branch 'main' into pdb-cli-fix-error-handling

4339575

assert in test_nonexistent_module that module doesn't exist

e6cdfce

chgnrdv requested a review from iritkatriel October 15, 2023 19:31

iritkatriel approved these changes Oct 15, 2023

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting core review labels Oct 15, 2023

sunmy2019 approved these changes Oct 16, 2023

View reviewed changes

iritkatriel added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Oct 16, 2023

iritkatriel merged commit 162213f into python:main Oct 16, 2023

bedevere-app bot removed the awaiting merge label Oct 16, 2023

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 16, 2023

pythongh-108791: Fix pdb CLI invalid argument handling (pythonGH-10…

7e69c98

…8816) (cherry picked from commit 162213f) Co-authored-by: Radislav Chugunov <[email protected]>

bedevere-app bot removed the needs backport to 3.12 only security fixes label Oct 16, 2023

bedevere-app bot removed the needs backport to 3.11 only security fixes label Oct 16, 2023

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 16, 2023

pythongh-108791: Fix pdb CLI invalid argument handling (pythonGH-10…

4ac4b07

…8816) (cherry picked from commit 162213f) Co-authored-by: Radislav Chugunov <[email protected]>

aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024

pythongh-108791: Fix pdb CLI invalid argument handling (python#108816)

72a98ad

Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024

pythongh-108791: Fix pdb CLI invalid argument handling (python#108816)

643f3fd

Uh oh!

Conversation

chgnrdv commented Sep 2, 2023 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chgnrdv commented Sep 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sunmy2019 Sep 2, 2023

Choose a reason for hiding this comment

Uh oh!

chgnrdv Sep 2, 2023

Choose a reason for hiding this comment

Uh oh!

gaogaotiantian left a comment

Choose a reason for hiding this comment

Uh oh!

gaogaotiantian commented Oct 7, 2023

Uh oh!

chgnrdv commented Oct 7, 2023

Uh oh!

gaogaotiantian commented Oct 11, 2023

Uh oh!

Uh oh!

iritkatriel commented Oct 15, 2023

Uh oh!

gaogaotiantian commented Oct 15, 2023

Uh oh!

sunmy2019 commented Oct 16, 2023

Uh oh!

miss-islington commented Oct 16, 2023

Uh oh!

bedevere-app bot commented Oct 16, 2023

Uh oh!

bedevere-app bot commented Oct 16, 2023

Uh oh!

bedevere-app bot commented Oct 19, 2023

Uh oh!

bedevere-app bot commented Oct 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

chgnrdv commented Sep 2, 2023 •

edited by bedevere-bot

Loading

chgnrdv commented Sep 2, 2023 •

edited

Loading