Skip to content
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.

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

pytest pdb commands missing documentation #12946

Open
adamchainz opened this issue Nov 8, 2024 · 0 comments · May be fixed by #12947
Open

pytest pdb commands missing documentation #12946

adamchainz opened this issue Nov 8, 2024 · 0 comments · May be fixed by #12947
Labels
plugin: debugging related to the debugging builtin plugin type: docs documentation improvement, missing or needing clarification

Comments

@adamchainz
Copy link
Member

Run pdb's h (help) command during a pytest run with --pdb and it reports c (cont, continue) and debug as undocumented:

(Pdb) h

Documented commands (type help <topic>):
========================================
EOF    cl         down      j         next     return  tbreak     w
a      clear      enable    jump      p        retval  u          whatis
alias  commands   exit      l         pp       run     unalias    where
args   condition  h         list      q        rv      undisplay
b      d          help      ll        quit     s       unt
break  disable    ignore    longlist  r        source  until
bt     display    interact  n         restart  step    up

Miscellaneous help topics:
==========================
exec  pdb

Undocumented commands:
======================
c  cont  continue  debug

Under regular pdb, they are documented:

(Pdb) h

Documented commands (type help <topic>):
========================================
EOF    c          d        h         list      q        rv       undisplay
a      cl         debug    help      ll        quit     s        unt
alias  clear      disable  ignore    longlist  r        source   until
args   commands   display  interact  n         restart  step     up
b      condition  down     j         next      return   tbreak   w
break  cont       enable   jump      p         retval   u        whatis
bt     continue   exit     l         pp        run      unalias  where

Miscellaneous help topics:
==========================
exec  pdb

The docstrings are missing from pytest's wrapped methods here:

def do_debug(self, arg):
cls._recursive_debug += 1
ret = super().do_debug(arg)
cls._recursive_debug -= 1
return ret
def do_continue(self, arg):
ret = super().do_continue(arg)

They aren't missing for the other wrapped commands like q (quit).

This is for pytest 8.3.3 but seems to be on main too from the above link.

@adamchainz adamchainz linked a pull request Nov 8, 2024 that will close this issue
@Zac-HD Zac-HD added type: docs documentation improvement, missing or needing clarification plugin: debugging related to the debugging builtin plugin labels Nov 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
plugin: debugging related to the debugging builtin plugin type: docs documentation improvement, missing or needing clarification
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants