{
"content": [
{
"type": "text",
"text": "# pdb (pydoc)\n\n**Summary:** pdb\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **MODULE REFERENCE** (8 lines)\n- **DESCRIPTION** (62 lines) — 16 subsections\n - h (5 lines)\n - w (4 lines)\n - d (3 lines)\n - u (3 lines)\n - b (17 lines)\n - cl (1 lines)\n - cl (66 lines)\n - s (4 lines)\n - n (3 lines)\n - unt (6 lines)\n - j (9 lines)\n - r (11 lines)\n - c (2 lines)\n - l (15 lines)\n - a (63 lines)\n - q (12 lines)\n- **CLASSES** (5 lines) — 1 subsections\n - class Pdb (744 lines)\n- **FUNCTIONS** (1 lines) — 8 subsections\n - help (2 lines)\n - pm (1 lines)\n - post_mortem (1 lines)\n - run (1 lines)\n - runcall (1 lines)\n - runctx (1 lines)\n - runeval (1 lines)\n - set_trace (1 lines)\n- **DATA** (2 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\npdb\n\n### MODULE REFERENCE\n\nhttps://docs.python.org/3.10/library/pdb.html\n\nThe following documentation is automatically generated from the Python\nsource files. It may be incomplete, incorrect or include features that\nare considered implementation detail and may vary between Python\nimplementations. When in doubt, consult the module reference at the\nlocation listed above.\n\n### DESCRIPTION\n\nThe Python Debugger Pdb\n=======================\n\nTo use the debugger in its simplest form:\n\n>>> import pdb\n>>> pdb.run('')\n\nThe debugger's prompt is '(Pdb) '. This will stop in the first\nfunction call in .\n\nAlternatively, if a statement terminated with an unhandled exception,\nyou can use pdb's post-mortem facility to inspect the contents of the\ntraceback:\n\n>>> \n\n>>> import pdb\n>>> pdb.pm()\n\nThe commands recognized by the debugger are listed in the next\nsection. Most can be abbreviated as indicated; e.g., h(elp) means\nthat 'help' can be typed as 'h' or 'help' (but not as 'he' or 'hel',\nnor as 'H' or 'Help' or 'HELP'). Optional arguments are enclosed in\nsquare brackets. Alternatives in the command syntax are separated\nby a vertical bar (|).\n\nA blank line repeats the previous command literally, except for\n'list', where it lists the next 11 lines.\n\nCommands that the debugger doesn't recognize are assumed to be Python\nstatements and are executed in the context of the program being\ndebugged. Python statements can also be prefixed with an exclamation\npoint ('!'). This is a powerful way to inspect the program being\ndebugged; it is even possible to change variables or call functions.\nWhen an exception occurs in such a statement, the exception name is\nprinted but the debugger's state is not changed.\n\nThe debugger supports aliases, which can save typing. And aliases can\nhave parameters (see the alias help entry) which allows one a certain\nlevel of adaptability to the context under examination.\n\nMultiple commands may be entered on a single line, separated by the\npair ';;'. No intelligence is applied to separating the commands; the\ninput is split at the first ';;', even if it is in the middle of a\nquoted string.\n\nIf a file \".pdbrc\" exists in your home directory or in the current\ndirectory, it is read in and executed as if it had been typed at the\ndebugger prompt. This is particularly useful for aliases. If both\nfiles exist, the one in the home directory is read first and aliases\ndefined there can be overridden by the local file. This behavior can be\ndisabled by passing the \"readrc=False\" argument to the Pdb constructor.\n\nAside from aliases, the debugger is not directly programmable; but it\nis implemented as a class from which you can derive your own debugger\nclass, which you can make as fancy as you like.\n\n\nDebugger commands\n=================\n\n#### h\n\nWithout argument, print the list of available commands.\nWith a command name as argument, print help about that command.\n\"help pdb\" shows the full pdb documentation.\n\"help exec\" gives help on the ! command.\n\n#### w\n\nPrint a stack trace, with the most recent frame at the bottom.\nAn arrow indicates the \"current frame\", which determines the\ncontext of most commands. 'bt' is an alias for this command.\n\n#### d\n\nMove the current frame count (default one) levels down in the\nstack trace (to a newer frame).\n\n#### u\n\nMove the current frame count (default one) levels up in the\nstack trace (to an older frame).\n\n#### b\n\nWithout argument, list all breaks.\n\nWith a line number argument, set a break at this line in the\ncurrent file. With a function name, set a break at the first\nexecutable line of that function. If a second argument is\npresent, it is a string specifying an expression which must\nevaluate to true before the breakpoint is honored.\n\nThe line number may be prefixed with a filename and a colon,\nto specify a breakpoint in another file (probably one that\nhasn't been loaded yet). The file is searched for on\nsys.path; the .py suffix may be omitted.\n\ntbreak [ ([filename:]lineno | function) [, condition] ]\nSame arguments as break, but sets a temporary breakpoint: it\nis automatically deleted when first hit.\n\n#### cl\n\n#### cl\n\nWith a space separated list of breakpoint numbers, clear\nthose breakpoints. Without argument, clear all breaks (but\nfirst ask confirmation). With a filename:lineno argument,\nclear all breaks at that line in that file.\n\ndisable bpnumber [bpnumber ...]\nDisables the breakpoints given as a space separated list of\nbreakpoint numbers. Disabling a breakpoint means it cannot\ncause the program to stop execution, but unlike clearing a\nbreakpoint, it remains in the list of breakpoints and can be\n(re-)enabled.\n\nenable bpnumber [bpnumber ...]\nEnables the breakpoints given as a space separated list of\nbreakpoint numbers.\n\nignore bpnumber [count]\nSet the ignore count for the given breakpoint number. If\ncount is omitted, the ignore count is set to 0. A breakpoint\nbecomes active when the ignore count is zero. When non-zero,\nthe count is decremented each time the breakpoint is reached\nand the breakpoint is not disabled and any associated\ncondition evaluates to true.\n\ncondition bpnumber [condition]\nSet a new condition for the breakpoint, an expression which\nmust evaluate to true before the breakpoint is honored. If\ncondition is absent, any existing condition is removed; i.e.,\nthe breakpoint is made unconditional.\n\ncommands [bpnumber]\n(com) ...\n(com) end\n(Pdb)\n\nSpecify a list of commands for breakpoint number bpnumber.\nThe commands themselves are entered on the following lines.\nType a line containing just 'end' to terminate the commands.\nThe commands are executed when the breakpoint is hit.\n\nTo remove all commands from a breakpoint, type commands and\nfollow it immediately with end; that is, give no commands.\n\nWith no bpnumber argument, commands refers to the last\nbreakpoint set.\n\nYou can use breakpoint commands to start your program up\nagain. Simply use the continue command, or step, or any other\ncommand that resumes execution.\n\nSpecifying any command resuming execution (currently continue,\nstep, next, return, jump, quit and their abbreviations)\nterminates the command list (as if that command was\nimmediately followed by end). This is because any time you\nresume execution (even with a simple next or step), you may\nencounter another breakpoint -- which could have its own\ncommand list, leading to ambiguities about which list to\nexecute.\n\nIf you use the 'silent' command in the command list, the usual\nmessage about stopping at a breakpoint is not printed. This\nmay be desirable for breakpoints that are to print a specific\nmessage and then continue. If none of the other commands\nprint anything, you will see no sign that the breakpoint was\nreached.\n\n#### s\n\nExecute the current line, stop at the first possible occasion\n(either in a function that is called or in the current\nfunction).\n\n#### n\n\nContinue execution until the next line in the current function\nis reached or it returns.\n\n#### unt\n\nWithout argument, continue execution until the line with a\nnumber greater than the current one is reached. With a line\nnumber, continue execution until a line with a number greater\nor equal to that is reached. In both cases, also stop when\nthe current frame returns.\n\n#### j\n\nSet the next line that will be executed. Only available in\nthe bottom-most frame. This lets you jump back and execute\ncode again, or jump forward to skip code that you don't want\nto run.\n\nIt should be noted that not all jumps are allowed -- for\ninstance it is not possible to jump into the middle of a\nfor loop or out of a finally clause.\n\n#### r\n\nContinue execution until the current function returns.\n\nretval\nPrint the return value for the last return of a function.\n\nrun [args...]\nRestart the debugged python program. If a string is supplied\nit is split with \"shlex\", and the result is used as the new\nsys.argv. History, breakpoints, actions and debugger options\nare preserved. \"restart\" is an alias for \"run\".\n\n#### c\n\nContinue execution, only stop when a breakpoint is encountered.\n\n#### l\n\nList source code for the current file. Without arguments,\nlist 11 lines around the current line or continue the previous\nlisting. With . as argument, list 11 lines around the current\nline. With one argument, list 11 lines starting at that line.\nWith two arguments, list the given range; if the second\nargument is less than the first, it is a count.\n\nThe current line in the current frame is indicated by \"->\".\nIf an exception is being debugged, the line where the\nexception was originally raised or propagated is indicated by\n\">>\", if it differs from the current line.\n\nlonglist | ll\nList the whole source code for the current function or frame.\n\n#### a\n\nPrint the argument list of the current function.\n\np expression\nPrint the value of the expression.\n\npp expression\nPretty-print the value of the expression.\n\nwhatis arg\nPrint the type of the argument.\n\nsource expression\nTry to get source code for the given object and display it.\n\ndisplay [expression]\n\nDisplay the value of the expression if it changed, each time execution\nstops in the current frame.\n\nWithout expression, list all display expressions for the current frame.\n\nundisplay [expression]\n\nDo not display the expression any more in the current frame.\n\nWithout expression, clear all display expressions for the current frame.\n\ninteract\n\nStart an interactive interpreter whose global namespace\ncontains all the (global and local) names found in the current scope.\n\nalias [name [command [parameter parameter ...] ]]\nCreate an alias called 'name' that executes 'command'. The\ncommand must *not* be enclosed in quotes. Replaceable\nparameters can be indicated by %1, %2, and so on, while %* is\nreplaced by all the parameters. If no command is given, the\ncurrent alias for name is shown. If no name is given, all\naliases are listed.\n\nAliases may be nested and can contain anything that can be\nlegally typed at the pdb prompt. Note! You *can* override\ninternal pdb commands with aliases! Those internal commands\nare then hidden until the alias is removed. Aliasing is\nrecursively applied to the first word of the command line; all\nother words in the line are left alone.\n\nAs an example, here are two useful aliases (especially when\nplaced in the .pdbrc file):\n\n# Print instance variables (usage \"pi classInst\")\nalias pi for k in %1.dict.keys(): print(\"%1.\",k,\"=\",%1.dict[k])\n# Print instance variables in self\nalias ps pi self\n\nunalias name\nDelete the specified alias.\n\ndebug code\nEnter a recursive debugger that steps through the code\nargument (which is an arbitrary expression or statement to be\nexecuted in the current environment).\n\n#### q\n\nexit\nQuit from the debugger. The program being executed is aborted.\n\n(!) statement\nExecute the (one-line) statement in the context of the current\nstack frame. The exclamation point can be omitted unless the\nfirst word of the statement resembles a debugger command. To\nassign to a global variable you must always prefix the command\nwith a 'global' command, e.g.:\n(Pdb) global listoptions; listoptions = ['-l']\n(Pdb)\n\n### CLASSES\n\nbdb.Bdb(builtins.object)\nPdb(bdb.Bdb, cmd.Cmd)\ncmd.Cmd(builtins.object)\nPdb(bdb.Bdb, cmd.Cmd)\n\n#### class Pdb\n\n| Pdb(completekey='tab', stdin=None, stdout=None, skip=None, nosigint=False, readrc=True)\n|\n| Method resolution order:\n| Pdb\n| bdb.Bdb\n| cmd.Cmd\n| builtins.object\n|\n| Methods defined here:\n|\n| init(self, completekey='tab', stdin=None, stdout=None, skip=None, nosigint=False, readrc=True)\n| Instantiate a line-oriented interpreter framework.\n|\n| The optional argument 'completekey' is the readline name of a\n| completion key; it defaults to the Tab key. If completekey is\n| not None and the readline module is available, command completion\n| is done automatically. The optional arguments stdin and stdout\n| specify alternate input and output file objects; if not specified,\n| sys.stdin and sys.stdout are used.\n|\n| bpcommands(self, frame)\n| Call every command that was set for the current active breakpoint\n| (if there is one).\n|\n| Returns True if the normal interaction function must be called,\n| False otherwise.\n|\n| checkline(self, filename, lineno)\n| Check whether specified line seems to be executable.\n|\n| Return `lineno` if it is, 0 if not (e.g. a docstring, comment, blank\n| line or EOF). Warning: testing is not comprehensive.\n|\n| completeb = completelocation(self, text, line, begidx, endidx)\n|\n| completebreak = completelocation(self, text, line, begidx, endidx)\n|\n| completecl = completelocation(self, text, line, begidx, endidx)\n|\n| completeclear = completelocation(self, text, line, begidx, endidx)\n|\n| completecommands = completebpnumber(self, text, line, begidx, endidx)\n|\n| completecondition = completebpnumber(self, text, line, begidx, endidx)\n|\n| completedebug = completeexpression(self, text, line, begidx, endidx)\n|\n| completedisable = completebpnumber(self, text, line, begidx, endidx)\n|\n| completedisplay = completeexpression(self, text, line, begidx, endidx)\n|\n| completeenable = completebpnumber(self, text, line, begidx, endidx)\n|\n| completeignore = completebpnumber(self, text, line, begidx, endidx)\n|\n| completep = completeexpression(self, text, line, begidx, endidx)\n|\n| completepp = completeexpression(self, text, line, begidx, endidx)\n|\n| completeprint = completeexpression(self, text, line, begidx, endidx)\n|\n| completesource = completeexpression(self, text, line, begidx, endidx)\n|\n| completetbreak = completelocation(self, text, line, begidx, endidx)\n|\n| completeunalias(self, text, line, begidx, endidx)\n|\n| completeundisplay(self, text, line, begidx, endidx)\n|\n| completewhatis = completeexpression(self, text, line, begidx, endidx)\n|\n| default(self, line)\n| Called on an input line when the command prefix is not recognized.\n|\n| If this method is not overridden, it prints an error message and\n| returns.\n|\n| defaultFile(self)\n| Produce a reasonable default.\n|\n| displayhook(self, obj)\n| Custom displayhook for the exec in default(), which prevents\n| assignment of the variable in the builtins.\n|\n| doEOF(self, arg)\n| EOF\n| Handles the receipt of EOF as a command.\n|\n| doa = doargs(self, arg)\n|\n| doalias(self, arg)\n| alias [name [command [parameter parameter ...] ]]\n| Create an alias called 'name' that executes 'command'. The\n| command must *not* be enclosed in quotes. Replaceable\n| parameters can be indicated by %1, %2, and so on, while %* is\n| replaced by all the parameters. If no command is given, the\n| current alias for name is shown. If no name is given, all\n| aliases are listed.\n|\n| Aliases may be nested and can contain anything that can be\n| legally typed at the pdb prompt. Note! You *can* override\n| internal pdb commands with aliases! Those internal commands\n| are then hidden until the alias is removed. Aliasing is\n| recursively applied to the first word of the command line; all\n| other words in the line are left alone.\n|\n| As an example, here are two useful aliases (especially when\n| placed in the .pdbrc file):\n|\n| # Print instance variables (usage \"pi classInst\")\n| alias pi for k in %1.dict.keys(): print(\"%1.\",k,\"=\",%1.dict[k])\n| # Print instance variables in self\n| alias ps pi self\n|\n| doargs(self, arg)\n| a(rgs)\n| Print the argument list of the current function.\n|\n| dob = dobreak(self, arg, temporary=0)\n|\n| dobreak(self, arg, temporary=0)\n| b(reak) [ ([filename:]lineno | function) [, condition] ]\n| Without argument, list all breaks.\n|\n| With a line number argument, set a break at this line in the\n| current file. With a function name, set a break at the first\n| executable line of that function. If a second argument is\n| present, it is a string specifying an expression which must\n| evaluate to true before the breakpoint is honored.\n|\n| The line number may be prefixed with a filename and a colon,\n| to specify a breakpoint in another file (probably one that\n| hasn't been loaded yet). The file is searched for on\n| sys.path; the .py suffix may be omitted.\n|\n| dobt = dowhere(self, arg)\n|\n| doc = docontinue(self, arg)\n|\n| docl = doclear(self, arg)\n|\n| doclear(self, arg)\n| cl(ear) filename:lineno\n| cl(ear) [bpnumber [bpnumber...]]\n| With a space separated list of breakpoint numbers, clear\n| those breakpoints. Without argument, clear all breaks (but\n| first ask confirmation). With a filename:lineno argument,\n| clear all breaks at that line in that file.\n|\n| docommands(self, arg)\n| commands [bpnumber]\n| (com) ...\n| (com) end\n| (Pdb)\n|\n| Specify a list of commands for breakpoint number bpnumber.\n| The commands themselves are entered on the following lines.\n| Type a line containing just 'end' to terminate the commands.\n| The commands are executed when the breakpoint is hit.\n|\n| To remove all commands from a breakpoint, type commands and\n| follow it immediately with end; that is, give no commands.\n|\n| With no bpnumber argument, commands refers to the last\n| breakpoint set.\n|\n| You can use breakpoint commands to start your program up\n| again. Simply use the continue command, or step, or any other\n| command that resumes execution.\n|\n| Specifying any command resuming execution (currently continue,\n| step, next, return, jump, quit and their abbreviations)\n| terminates the command list (as if that command was\n| immediately followed by end). This is because any time you\n| resume execution (even with a simple next or step), you may\n| encounter another breakpoint -- which could have its own\n| command list, leading to ambiguities about which list to\n| execute.\n|\n| If you use the 'silent' command in the command list, the usual\n| message about stopping at a breakpoint is not printed. This\n| may be desirable for breakpoints that are to print a specific\n| message and then continue. If none of the other commands\n| print anything, you will see no sign that the breakpoint was\n| reached.\n|\n| docondition(self, arg)\n| condition bpnumber [condition]\n| Set a new condition for the breakpoint, an expression which\n| must evaluate to true before the breakpoint is honored. If\n| condition is absent, any existing condition is removed; i.e.,\n| the breakpoint is made unconditional.\n|\n| docont = docontinue(self, arg)\n|\n| docontinue(self, arg)\n| c(ont(inue))\n| Continue execution, only stop when a breakpoint is encountered.\n|\n| dod = dodown(self, arg)\n|\n| dodebug(self, arg)\n| debug code\n| Enter a recursive debugger that steps through the code\n| argument (which is an arbitrary expression or statement to be\n| executed in the current environment).\n|\n| dodisable(self, arg)\n| disable bpnumber [bpnumber ...]\n| Disables the breakpoints given as a space separated list of\n| breakpoint numbers. Disabling a breakpoint means it cannot\n| cause the program to stop execution, but unlike clearing a\n| breakpoint, it remains in the list of breakpoints and can be\n| (re-)enabled.\n|\n| dodisplay(self, arg)\n| display [expression]\n|\n| Display the value of the expression if it changed, each time execution\n| stops in the current frame.\n|\n| Without expression, list all display expressions for the current frame.\n|\n| dodown(self, arg)\n| d(own) [count]\n| Move the current frame count (default one) levels down in the\n| stack trace (to a newer frame).\n|\n| doenable(self, arg)\n| enable bpnumber [bpnumber ...]\n| Enables the breakpoints given as a space separated list of\n| breakpoint numbers.\n|\n| doexit = doquit(self, arg)\n|\n| doh = dohelp(self, arg)\n|\n| dohelp(self, arg)\n| h(elp)\n| Without argument, print the list of available commands.\n| With a command name as argument, print help about that command.\n| \"help pdb\" shows the full pdb documentation.\n| \"help exec\" gives help on the ! command.\n|\n| doignore(self, arg)\n| ignore bpnumber [count]\n| Set the ignore count for the given breakpoint number. If\n| count is omitted, the ignore count is set to 0. A breakpoint\n| becomes active when the ignore count is zero. When non-zero,\n| the count is decremented each time the breakpoint is reached\n| and the breakpoint is not disabled and any associated\n| condition evaluates to true.\n|\n| dointeract(self, arg)\n| interact\n|\n| Start an interactive interpreter whose global namespace\n| contains all the (global and local) names found in the current scope.\n|\n| doj = dojump(self, arg)\n|\n| dojump(self, arg)\n| j(ump) lineno\n| Set the next line that will be executed. Only available in\n| the bottom-most frame. This lets you jump back and execute\n| code again, or jump forward to skip code that you don't want\n| to run.\n|\n| It should be noted that not all jumps are allowed -- for\n| instance it is not possible to jump into the middle of a\n| for loop or out of a finally clause.\n|\n| dol = dolist(self, arg)\n|\n| dolist(self, arg)\n| l(ist) [first [,last] | .]\n|\n| List source code for the current file. Without arguments,\n| list 11 lines around the current line or continue the previous\n| listing. With . as argument, list 11 lines around the current\n| line. With one argument, list 11 lines starting at that line.\n| With two arguments, list the given range; if the second\n| argument is less than the first, it is a count.\n|\n| The current line in the current frame is indicated by \"->\".\n| If an exception is being debugged, the line where the\n| exception was originally raised or propagated is indicated by\n| \">>\", if it differs from the current line.\n|\n| doll = dolonglist(self, arg)\n|\n| dolonglist(self, arg)\n| longlist | ll\n| List the whole source code for the current function or frame.\n|\n| don = donext(self, arg)\n|\n| donext(self, arg)\n| n(ext)\n| Continue execution until the next line in the current function\n| is reached or it returns.\n|\n| dop(self, arg)\n| p expression\n| Print the value of the expression.\n|\n| dopp(self, arg)\n| pp expression\n| Pretty-print the value of the expression.\n|\n| doq = doquit(self, arg)\n|\n| doquit(self, arg)\n| q(uit)\n| exit\n| Quit from the debugger. The program being executed is aborted.\n|\n| dor = doreturn(self, arg)\n|\n| dorestart = dorun(self, arg)\n|\n| doreturn(self, arg)\n| r(eturn)\n| Continue execution until the current function returns.\n|\n| doretval(self, arg)\n| retval\n| Print the return value for the last return of a function.\n|\n| dorun(self, arg)\n| run [args...]\n| Restart the debugged python program. If a string is supplied\n| it is split with \"shlex\", and the result is used as the new\n| sys.argv. History, breakpoints, actions and debugger options\n| are preserved. \"restart\" is an alias for \"run\".\n|\n| dorv = doretval(self, arg)\n|\n| dos = dostep(self, arg)\n|\n| dosource(self, arg)\n| source expression\n| Try to get source code for the given object and display it.\n|\n| dostep(self, arg)\n| s(tep)\n| Execute the current line, stop at the first possible occasion\n| (either in a function that is called or in the current\n| function).\n|\n| dotbreak(self, arg)\n| tbreak [ ([filename:]lineno | function) [, condition] ]\n| Same arguments as break, but sets a temporary breakpoint: it\n| is automatically deleted when first hit.\n|\n| dou = doup(self, arg)\n|\n| dounalias(self, arg)\n| unalias name\n| Delete the specified alias.\n|\n| doundisplay(self, arg)\n| undisplay [expression]\n|\n| Do not display the expression any more in the current frame.\n|\n| Without expression, clear all display expressions for the current frame.\n|\n| dount = dountil(self, arg)\n|\n| dountil(self, arg)\n| unt(il) [lineno]\n| Without argument, continue execution until the line with a\n| number greater than the current one is reached. With a line\n| number, continue execution until a line with a number greater\n| or equal to that is reached. In both cases, also stop when\n| the current frame returns.\n|\n| doup(self, arg)\n| u(p) [count]\n| Move the current frame count (default one) levels up in the\n| stack trace (to an older frame).\n|\n| dow = dowhere(self, arg)\n|\n| dowhatis(self, arg)\n| whatis arg\n| Print the type of the argument.\n|\n| dowhere(self, arg)\n| w(here)\n| Print a stack trace, with the most recent frame at the bottom.\n| An arrow indicates the \"current frame\", which determines the\n| context of most commands. 'bt' is an alias for this command.\n|\n| error(self, msg)\n|\n| execRcLines(self)\n| # Can be executed earlier than 'setup' if desired\n|\n| forget(self)\n|\n| handlecommanddef(self, line)\n| Handles one command line during command list definition.\n|\n| helpexec(self)\n| (!) statement\n| Execute the (one-line) statement in the context of the current\n| stack frame. The exclamation point can be omitted unless the\n| first word of the statement resembles a debugger command. To\n| assign to a global variable you must always prefix the command\n| with a 'global' command, e.g.:\n| (Pdb) global listoptions; listoptions = ['-l']\n| (Pdb)\n|\n| helppdb(self)\n|\n| interaction(self, frame, traceback)\n|\n| lineinfo(self, identifier)\n|\n| lookupmodule(self, filename)\n| Helper function for break/clear parsing -- may be overridden.\n|\n| lookupmodule() translates (possibly incomplete) file or module name\n| into an absolute file name.\n|\n| message(self, msg)\n|\n| onecmd(self, line)\n| Interpret the argument as though it had been typed in response\n| to the prompt.\n|\n| Checks whether this line is typed at the normal prompt or in\n| a breakpoint command list definition.\n|\n| precmd(self, line)\n| Handle alias expansion and ';;' separator.\n|\n| preloop(self)\n| Hook method executed once when the cmdloop() method is called.\n|\n| printstackentry(self, framelineno, promptprefix='\\n-> ')\n|\n| printstacktrace(self)\n|\n| reset(self)\n| Set values of attributes as ready to start debugging.\n|\n| setup(self, f, tb)\n|\n| siginthandler(self, signum, frame)\n|\n| usercall(self, frame, argumentlist)\n| This method is called when there is the remote possibility\n| that we ever need to stop in this function.\n|\n| userexception(self, frame, excinfo)\n| This function is called if an exception occurs,\n| but only if we are to stop at or just below this level.\n|\n| userline(self, frame)\n| This function is called when we stop or break at this line.\n|\n| userreturn(self, frame, returnvalue)\n| This function is called when a return trap is set here.\n|\n| ----------------------------------------------------------------------\n| Data and other attributes defined here:\n|\n| commandsresuming = ['docontinue', 'dostep', 'donext', 'doreturn',...\n|\n| ----------------------------------------------------------------------\n| Methods inherited from bdb.Bdb:\n|\n| breakanywhere(self, frame)\n| Return True if there is any breakpoint for frame's filename.\n|\n| breakhere(self, frame)\n| Return True if there is an effective breakpoint for this line.\n|\n| Check for line or function breakpoint and if in effect.\n| Delete temporary breakpoints if effective() says to.\n|\n| canonic(self, filename)\n| Return canonical form of filename.\n|\n| For real filenames, the canonical form is a case-normalized (on\n| case insensitive filesystems) absolute path. 'Filenames' with\n| angle brackets, such as \"\", generated in interactive\n| mode, are returned unchanged.\n|\n| clearallbreaks(self)\n| Delete all existing breakpoints.\n|\n| If none were set, return an error message.\n|\n| clearallfilebreaks(self, filename)\n| Delete all breakpoints in filename.\n|\n| If none were set, return an error message.\n|\n| clearbpbynumber(self, arg)\n| Delete a breakpoint by its index in Breakpoint.bpbynumber.\n|\n| If arg is invalid, return an error message.\n|\n| clearbreak(self, filename, lineno)\n| Delete breakpoints for filename:lineno.\n|\n| If no breakpoints were set, return an error message.\n|\n| dispatchcall(self, frame, arg)\n| Invoke user function and return trace function for call event.\n|\n| If the debugger stops on this function call, invoke\n| self.usercall(). Raise BdbQuit if self.quitting is set.\n| Return self.tracedispatch to continue tracing in this scope.\n|\n| dispatchexception(self, frame, arg)\n| Invoke user function and return trace function for exception event.\n|\n| If the debugger stops on this exception, invoke\n| self.userexception(). Raise BdbQuit if self.quitting is set.\n| Return self.tracedispatch to continue tracing in this scope.\n|\n| dispatchline(self, frame)\n| Invoke user function and return trace function for line event.\n|\n| If the debugger stops on the current line, invoke\n| self.userline(). Raise BdbQuit if self.quitting is set.\n| Return self.tracedispatch to continue tracing in this scope.\n|\n| dispatchreturn(self, frame, arg)\n| Invoke user function and return trace function for return event.\n|\n| If the debugger stops on this function return, invoke\n| self.userreturn(). Raise BdbQuit if self.quitting is set.\n| Return self.tracedispatch to continue tracing in this scope.\n|\n| formatstackentry(self, framelineno, lprefix=': ')\n| Return a string with information about a stack entry.\n|\n| The stack entry framelineno is a (frame, lineno) tuple. The\n| return string contains the canonical filename, the function name\n| or '', the input arguments, the return value, and the\n| line of code (if it exists).\n|\n| getallbreaks(self)\n| Return all breakpoints that are set.\n|\n| getbpbynumber(self, arg)\n| Return a breakpoint by its index in Breakpoint.bybpnumber.\n|\n| For invalid arg values or if the breakpoint doesn't exist,\n| raise a ValueError.\n|\n| getbreak(self, filename, lineno)\n| Return True if there is a breakpoint for filename:lineno.\n|\n| getbreaks(self, filename, lineno)\n| Return all breakpoints for filename:lineno.\n|\n| If no breakpoints are set, return an empty list.\n|\n| getfilebreaks(self, filename)\n| Return all lines with breakpoints for filename.\n|\n| If no breakpoints are set, return an empty list.\n|\n| getstack(self, f, t)\n| Return a list of (frame, lineno) in a stack trace and a size.\n|\n| List starts with original calling frame, if there is one.\n| Size may be number of frames above or below f.\n|\n| isskippedmodule(self, modulename)\n| Return True if modulename matches any skip pattern.\n|\n| run(self, cmd, globals=None, locals=None)\n| Debug a statement executed via the exec() function.\n|\n| globals defaults to main.dict; locals defaults to globals.\n|\n| runcall(self, func, /, *args, kwds)\n| Debug a single function call.\n|\n| Return the result of the function call.\n|\n| runctx(self, cmd, globals, locals)\n| For backwards-compatibility. Defers to run().\n|\n| runeval(self, expr, globals=None, locals=None)\n| Debug an expression executed via the eval() function.\n|\n| globals defaults to main.dict; locals defaults to globals.\n|\n| setbreak(self, filename, lineno, temporary=False, cond=None, funcname=None)\n| Set a new breakpoint for filename:lineno.\n|\n| If lineno doesn't exist for the filename, return an error message.\n| The filename should be in canonical form.\n|\n| setcontinue(self)\n| Stop only at breakpoints or when finished.\n|\n| If there are no breakpoints, set the system trace function to None.\n|\n| setnext(self, frame)\n| Stop on the next line in or below the given frame.\n|\n| setquit(self)\n| Set quitting attribute to True.\n|\n| Raises BdbQuit exception in the next call to a dispatch*() method.\n|\n| setreturn(self, frame)\n| Stop when returning from the given frame.\n|\n| setstep(self)\n| Stop after one line of code.\n|\n| settrace(self, frame=None)\n| Start debugging from frame.\n|\n| If frame is not specified, debugging starts from caller's frame.\n|\n| setuntil(self, frame, lineno=None)\n| Stop when the line with the lineno greater than the current one is\n| reached or when returning from current frame.\n|\n| stophere(self, frame)\n| Return True if frame is below the starting frame in the stack.\n|\n| tracedispatch(self, frame, event, arg)\n| Dispatch a trace function for debugged frames based on the event.\n|\n| This function is installed as the trace function for debugged\n| frames. Its return value is the new trace function, which is\n| usually itself. The default implementation decides how to\n| dispatch a frame, depending on the type of event (passed in as a\n| string) that is about to be executed.\n|\n| The event can be one of the following:\n| line: A new line of code is going to be executed.\n| call: A function is about to be called or another code block\n| is entered.\n| return: A function or other code block is about to return.\n| exception: An exception has occurred.\n| ccall: A C function is about to be called.\n| creturn: A C function has returned.\n| cexception: A C function has raised an exception.\n|\n| For the Python events, specialized functions (see the dispatch*()\n| methods) are called. For the C events, no action is taken.\n|\n| The arg parameter depends on the previous event.\n|\n| ----------------------------------------------------------------------\n| Data descriptors inherited from bdb.Bdb:\n|\n| dict\n| dictionary for instance variables (if defined)\n|\n| weakref\n| list of weak references to the object (if defined)\n|\n| ----------------------------------------------------------------------\n| Methods inherited from cmd.Cmd:\n|\n| cmdloop(self, intro=None)\n| Repeatedly issue a prompt, accept input, parse an initial prefix\n| off the received input, and dispatch to action methods, passing them\n| the remainder of the line as argument.\n|\n| columnize(self, list, displaywidth=80)\n| Display a list of strings as a compact set of columns.\n|\n| Each column is only as wide as necessary.\n| Columns are separated by two spaces (one was not legible enough).\n|\n| complete(self, text, state)\n| Return the next possible completion for 'text'.\n|\n| If a command has not been entered, then complete against command list.\n| Otherwise try to call complete to get list of completions.\n|\n| completehelp(self, *args)\n|\n| completedefault(self, *ignored)\n| Method called to complete an input line when no command-specific\n| complete*() method is available.\n|\n| By default, it returns an empty list.\n|\n| completenames(self, text, *ignored)\n|\n| emptyline(self)\n| Called when an empty line is entered in response to the prompt.\n|\n| If this method is not overridden, it repeats the last nonempty\n| command entered.\n|\n| getnames(self)\n|\n| parseline(self, line)\n| Parse the line into a command name and a string containing\n| the arguments. Returns a tuple containing (command, args, line).\n| 'command' and 'args' may be None if the line couldn't be parsed.\n|\n| postcmd(self, stop, line)\n| Hook method executed just after a command dispatch is finished.\n|\n| postloop(self)\n| Hook method executed once when the cmdloop() method is about to\n| return.\n|\n| printtopics(self, header, cmds, cmdlen, maxcol)\n|\n| ----------------------------------------------------------------------\n| Data and other attributes inherited from cmd.Cmd:\n|\n| docheader = 'Documented commands (type help ):'\n|\n| docleader = ''\n|\n| identchars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123...\n|\n| intro = None\n|\n| lastcmd = ''\n|\n| mischeader = 'Miscellaneous help topics:'\n|\n| nohelp = '* No help on %s'\n|\n| prompt = '(Cmd) '\n|\n| ruler = '='\n|\n| undocheader = 'Undocumented commands:'\n|\n| userawinput = 1\n\n### FUNCTIONS\n\n#### help\n\n# print help\n\n#### pm\n\n#### post_mortem\n\n#### run\n\n#### runcall\n\n#### runctx\n\n#### runeval\n\n#### set_trace\n\n### DATA\n\nall = ['run', 'pm', 'Pdb', 'runeval', 'runctx', 'runcall', 'settr...\n\n### FILE\n\n/usr/lib/python3.10/pdb.py\n\n"
}
],
"structuredContent": {
"command": "pdb",
"section": "",
"mode": "pydoc",
"summary": "pdb",
"synopsis": null,
"tldr_summary": null,
"tldr_examples": [],
"tldr_source": null,
"flags": [],
"examples": [],
"see_also": [],
"section_outline": [
{
"name": "NAME",
"lines": 2,
"subsections": []
},
{
"name": "MODULE REFERENCE",
"lines": 8,
"subsections": []
},
{
"name": "DESCRIPTION",
"lines": 62,
"subsections": [
{
"name": "h",
"lines": 5
},
{
"name": "w",
"lines": 4
},
{
"name": "d",
"lines": 3
},
{
"name": "u",
"lines": 3
},
{
"name": "b",
"lines": 17
},
{
"name": "cl",
"lines": 1
},
{
"name": "cl",
"lines": 66
},
{
"name": "s",
"lines": 4
},
{
"name": "n",
"lines": 3
},
{
"name": "unt",
"lines": 6
},
{
"name": "j",
"lines": 9
},
{
"name": "r",
"lines": 11
},
{
"name": "c",
"lines": 2
},
{
"name": "l",
"lines": 15
},
{
"name": "a",
"lines": 63
},
{
"name": "q",
"lines": 12
}
]
},
{
"name": "CLASSES",
"lines": 5,
"subsections": [
{
"name": "class Pdb",
"lines": 744
}
]
},
{
"name": "FUNCTIONS",
"lines": 1,
"subsections": [
{
"name": "help",
"lines": 2
},
{
"name": "pm",
"lines": 1
},
{
"name": "post_mortem",
"lines": 1
},
{
"name": "run",
"lines": 1
},
{
"name": "runcall",
"lines": 1
},
{
"name": "runctx",
"lines": 1
},
{
"name": "runeval",
"lines": 1
},
{
"name": "set_trace",
"lines": 1
}
]
},
{
"name": "DATA",
"lines": 2,
"subsections": []
},
{
"name": "FILE",
"lines": 3,
"subsections": []
}
]
}
}