| Name | patdb JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Pat's Python debugger |
| upload_time | 2025-07-16 19:37:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. |
| keywords |
bdb
debug
debugger
patdb
pdb
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">patdb</h1>
<h2 align="center">A snappy + easy + pretty TUI debugger for Python.</h2>
- The only Python debugger to allow inspecting re-raised or grouped exceptions!
- Inspect frames in a full Python REPL, with syntax highlighting and autocompletion.
- Walk through the whole stack interactively.
- A snappy single-keystroke interface.
- Respects `__tracebackhide__` hidden frames.
- Usable inside `threading`, `asyncio`, and even `multiprocessing`.
<br>
<div align="center">
<div><em>Here we have a program that raises an error. So we display the <code>s</code>ource of the problem function, then walk the s<code>t</code>ack into the nested <code>__cause__</code> of the exception, display the <code>s</code>ource of the called function, and finally open an <code>i</code>nterpreter inside that frame.</em></div><br>
<img style="width: 70%;" src="https://github.com/patrick-kidger/patdb/blob/main/imgs/splash.png?raw=true" alt="Demo image">
</div>
## Installation
```
pip install patdb
```
## Usage
### To use this as your `breakpoint()`:
Set the environment variable `PYTHONBREAKPOINT=patdb.debug`, and then place a `breakpoint()` anywhere in your source code. (Or call `import patdb; patdb.debug()` directly yourself, [which is the same thing](https://peps.python.org/pep-0553/).)
### With `pytest`:
Pass the `--patdb` flag, e.g. `pytest test_foo.py --patdb`, to open the debugger on failure.
### To open a debugger 'post mortem', after an error hits the top level:
When running interactively: call `patdb.debug()` after the error has returned you to the REPL. (Or `breakpoint()` if you've set the environment variable as above.)
When running code in a file: `python -m patdb foo.py`.
When running code on the command line: `python -m patdb -c "import foo; foo.problematic_function()"`.
## Commands
```
j: down_frame - Move one frame down.
k: up_frame - Move one frame up.
J: down_callstack - Move one callstack down.
K: up_callstack - Move one callstack up.
s: show_function - Show the current function's source code and interactively set breakpoints.
S: show_file - Show the current file's source code and interactively set breakpoints.
t: stack - Show all frames in all callstacks and interactively scroll through them.
p: print - Pretty-prints the value of an expression.
P: print_long_arrays - Pretty-prints the value of an expression, without summarising arrays.
e: edit - Open the current function in your `$EDITOR`.
i: interpret - Open a Python interpreter in the current frame.
v: visibility - Toggles skipping hidden frames when moving frames or callstacks.
c: continue - Close the debugger and continue the program.
q: quit - Quit the whole Python program.
?: help - Display a list of all debugger commands.
```
These can be rebound, see 'configuration' below.
Here, a "callstack" refers to all of the frames in the traceback of a single exception, so e.g. `J` moves down to a nested exception.
## Configuration
<details>
<summary>The following environment variables are respected:</summary>
```
PATDB_CODE_STYLE
PATDB_EMPH_COLOR
PATDB_ERROR_COLOR
PATDB_INFO_COLOR
PATDB_PROMPT_COLOR
PATDB_DEPTH
PATDB_EDITOR
PATDB_KEY_{command name}, e.g. `PATDB_DOWN_FRAME`
COLORFGBG
EDITOR
PTPYTHON_CONFIG_HOME
```
- `PATDB_CODE_STYLE`: used by the `show_function` and `show_file` commands, as the colour theme for displaying code. Can be the name of any [Pygments style](https://pygments.org/styles/), to use as the theme for code. Defaults to `solarized-dark`.
- `PATDB_EMPH_COLOR`: the colour used to emphasise the file/function/lines when displaying location, e.g. in `File *foo.py*, at *some_fn* from *1*, line *2*`. Defaults to `#4cb066`.
- `PATDB_ERROR_COLOR`: the colour used to display the type of error e.g. in `*RuntimeError*: something went wrong`. Defaults to `#dc322f`.
- `PATDB_INFO_COLOR`: the colour used to display `patdb:` info prompts. Defaults to `#888888`.
- `PATDB_PROMPT_COLOR`: the color used to display the `patdb>` REPL prompt. Defaults to `#268bd2`.
- `PATDB_DEPTH`: controls the `patdb` prompt and the prompt of any nested `interpret`ers. By default it is just `patdb>` and `>>>` respectively. If you nest `patdb->interpret->patdb->...` then this environment variable will increment and successive prompts will appear as `patdb1>`, `1>>>`, `patdb2>` etc.
- `PATDB_EDITOR`: used by the `edit` command. If set then this command will call `$PATDB_EDITOR $filename $linenumber`. If not set then it will fall back to just `$EDITOR $filename`.
- `PATDB_KEY_{command name}`: this offers a way to rebind keys. For example `PATDB_KEY_DOWN_FRAME=d` to replace the default `j` with `d`.
- Can require that a chain of keys is pressed by separating them with `+`. For example `PATDB_KEY_DOWN_FRAME=a+b` requires that `a` and then `b` be pressed to trigger that command.
- Can accept multiple different key bindings for the same command by separating them with a `/`. For example `PATDB_KEY_DOWN_FRAME=j/d`.
- Modifiers keys can be applied following [prompt_toolkit syntax](https://python-prompt-toolkit.readthedocs.io/en/master/pages/advanced_topics/key_bindings.html). In particular this treats `Control` as part of the same key, so that for example `c-x` is `Control x`. Meanwhile `Alt` is (in the usual way for terminals) treated as a separate key press of `escape`, so that for example `escape+d` is `Alt d`
- Overall, for example: `a/c-k+b/escape+l` means that any of `a`, or `Control k` followed by `b`, or `Alt l`, will trigger that keybind.
- The full list of all keys is as follows. The group of keys starting `PATDB_KEY_SHOW_` correspond to the interactive commands within the `show_file` and `show_function` command. The group of keys starting `PATDB_KEY_STACK_` correspond to the interactive commands within the `stack` command.
```
PATDB_KEY_DOWN_FRAME
PATDB_KEY_UP_FRAME
PATDB_KEY_DOWN_CALLSTACK
PATDB_KEY_UP_CALLSTACK
PATDB_KEY_SHOW_FUNCTION
PATDB_KEY_SHOW_FILE
PATDB_KEY_STACK
PATDB_KEY_PRINT
PATDB_KEY_PRINT_LONG_ARRAYS
PATDB_KEY_EDIT
PATDB_KEY_INTERPRET
PATDB_KEY_VISIBILITY
PATDB_KEY_CONTINUE
PATDB_KEY_QUIT
PATDB_KEY_HELP
PATDB_KEY_SHOW_DOWN_LINE
PATDB_KEY_SHOW_UP_LINE
PATDB_KEY_SHOW_LEFT
PATDB_KEY_SHOW_RIGHT
PATDB_KEY_SHOW_DOWN_CALL
PATDB_KEY_SHOW_SELECT
PATDB_KEY_SHOW_LEAVE
PATDB_KEY_STACK_DOWN_FRAME
PATDB_KEY_STACK_UP_FRAME
PATDB_KEY_STACK_DOWN_CALLSTACK
PATDB_KEY_STACK_UP_CALLSTACK
PATDB_KEY_STACK_LEFT
PATDB_KEY_STACK_RIGHT
PATDB_KEY_STACK_VISIBILITY
PATDB_KEY_STACK_ERROR
PATDB_KEY_STACK_COLLAPSE_SINGLE
PATDB_KEY_STACK_COLLAPSE_ALL
PATDB_KEY_STACK_SELECT
PATDB_KEY_STACK_LEAVE
```
- `COLORFGBG`: some environments provide this to describe the colour of the terminal. If available, this will be queried to determine if your terminal is using a light or dark background. This is used to determine the fallback colour for any tokens not specified by the code style specified in `PATDB_CODE_STYLE`.
- `EDITOR`: used as a fallback if `PATDB_EDITOR` is not available.
- `PTPYTHON_CONFIG_HOME`: used by the `interpret` command. This command uses [`ptpython`](https://github.com/prompt-toolkit/ptpython) for the interpreter, and we respect any existing configuration you have configured for `ptpython`.
</details>
## FAQ
<details>
<summary>Why the name <code>patdb</code>?</summary>
<br>
The built-in debugger is called `pdb`, and my name is Patrick! 😁
</details>
<details>
<summary>Why this (fairly small) set of commands?</summary>
<br>
`patdb` was designed for its commands to be almost entirely be about understanding the stack trace. Once you're where you need to be, then hit `i` to open a REPL and start interacting with the variables directly.
</details>
<details>
<summary>How does <code>patdb</code> differ from <code>pdb</code>/... etc?</summary>
##### `pdb`/`pdb++`/`ipdb`?
We handle nested exceptions; scrolling through the stack; syntax highlighting; interacting with hidden frames; etc etc. (`ipdb` does offer a couple of those last ones as well.)
`patdb` largely aims to supersede these debuggers.
##### `pudb`?
We handle nested exceptions. The main difference, though, is that `pudb` offers a "graphical" interface, displaying information about variables / exceptions / code / etc. in multiple panes. This is a bit of a philosophical choice -- personally I prefer REPL-like interfaces, as these keep a history of all the things I've ever done, which I can go back and check if required. I find this particularly valuable when debugging! But others may prefer the graphical interface of `pudb`.
</details>
## Advanced usage
<details>
<summary>Can I customise the interpreter?</summary>
<br>
Yes! We use [`ptpython`](https://github.com/prompt-toolkit/ptpython) for our nested REPL, and will respect any `ptpython` configuration you already have.
Why not `ipython`? The reason is that I found `ipython` to be pretty unclear to work with. They have all of:
```
IPython.core.interactiveshell.InteractiveShell
IPython.terminal.interactiveshell.TerminalInteractiveShell
IPython.terminal.embed.InteractiveShellEmbed
```
and I couldn't easily figure out how to get any of them to operate correctly when embedded in a larger program. In contrast `ptpython` pretty much worked out-of-the-box!
</details>
</details>
<details>
<summary>When using <code>edit</code>, how can I open my <code>$EDITOR</code> to the current line number? (And not just the top of the current file.)</summary>
<br>
Set `PATDB_EDITOR` as discussed in 'configuration' above.
</details>
<details>
<summary>How can I access the current exception or the current frame?</summary>
<br>
When `p`rinting or `i`nteracting then the current exception is available as `__exception__` and the current frame is available as `__frame__`.
</details>
<details>
<summary>Investigating an existing exception, traceback, or frame object.</summary>
<br>
Call either `patdb.debug(some_exception)` or `patdb.debug(some_traceback)` or `patdb.debug(some_frame)` if you have a particular exception/traceback/frame that you'd like to investigate. Exceptions may potentially have multiple callstacks (subexceptions via `__cause__` and `__context__` are checked, with one callstack for each exception), the others will enable debugging of a single callstack.
</details>
<details>
<summary>Setting <code>sys.excepthook</code>.</summary>
<br>
By default, Python will call `sys.excepthook` on any exception that reaches the top of your program. In practice we usually recommend using `python -m patdb foo.py` as the way to open a debugger when an exception occurs, as unfortunately Python offers no easy way to set `sys.excepthook` from outside a program.
However if you can modify the top of your script, or if you use [`usercustomize.py`](https://docs.python.org/3/library/site.html#module-usercustomize), then another way to enable `patdb` is to set `sys.excepthook = patdb.debug` before any exceptions hit the top level.
</details>
Raw data
{
"_id": null,
"home_page": null,
"name": "patdb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "bdb, debug, debugger, patdb, pdb",
"author": null,
"author_email": "Patrick Kidger <contact@kidger.site>",
"download_url": "https://files.pythonhosted.org/packages/f1/5e/a84bb34fca45b295db118a951719e78bc48768888ec93315fa371772b51b/patdb-0.1.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">patdb</h1>\n<h2 align=\"center\">A snappy + easy + pretty TUI debugger for Python.</h2>\n\n- The only Python debugger to allow inspecting re-raised or grouped exceptions!\n- Inspect frames in a full Python REPL, with syntax highlighting and autocompletion.\n- Walk through the whole stack interactively.\n- A snappy single-keystroke interface.\n- Respects `__tracebackhide__` hidden frames.\n- Usable inside `threading`, `asyncio`, and even `multiprocessing`.\n\n<br>\n<div align=\"center\">\n<div><em>Here we have a program that raises an error. So we display the <code>s</code>ource of the problem function, then walk the s<code>t</code>ack into the nested <code>__cause__</code> of the exception, display the <code>s</code>ource of the called function, and finally open an <code>i</code>nterpreter inside that frame.</em></div><br>\n<img style=\"width: 70%;\" src=\"https://github.com/patrick-kidger/patdb/blob/main/imgs/splash.png?raw=true\" alt=\"Demo image\">\n</div>\n\n## Installation\n\n```\npip install patdb\n```\n\n## Usage\n\n### To use this as your `breakpoint()`:\n\nSet the environment variable `PYTHONBREAKPOINT=patdb.debug`, and then place a `breakpoint()` anywhere in your source code. (Or call `import patdb; patdb.debug()` directly yourself, [which is the same thing](https://peps.python.org/pep-0553/).)\n\n### With `pytest`:\n\nPass the `--patdb` flag, e.g. `pytest test_foo.py --patdb`, to open the debugger on failure.\n\n### To open a debugger 'post mortem', after an error hits the top level:\n\nWhen running interactively: call `patdb.debug()` after the error has returned you to the REPL. (Or `breakpoint()` if you've set the environment variable as above.) \nWhen running code in a file: `python -m patdb foo.py`. \nWhen running code on the command line: `python -m patdb -c \"import foo; foo.problematic_function()\"`.\n\n## Commands\n\n```\nj: down_frame - Move one frame down.\nk: up_frame - Move one frame up.\nJ: down_callstack - Move one callstack down.\nK: up_callstack - Move one callstack up.\ns: show_function - Show the current function's source code and interactively set breakpoints.\nS: show_file - Show the current file's source code and interactively set breakpoints.\nt: stack - Show all frames in all callstacks and interactively scroll through them.\np: print - Pretty-prints the value of an expression.\nP: print_long_arrays - Pretty-prints the value of an expression, without summarising arrays.\ne: edit - Open the current function in your `$EDITOR`.\ni: interpret - Open a Python interpreter in the current frame.\nv: visibility - Toggles skipping hidden frames when moving frames or callstacks.\nc: continue - Close the debugger and continue the program.\nq: quit - Quit the whole Python program.\n?: help - Display a list of all debugger commands.\n```\n\nThese can be rebound, see 'configuration' below.\n\nHere, a \"callstack\" refers to all of the frames in the traceback of a single exception, so e.g. `J` moves down to a nested exception.\n\n## Configuration\n\n<details>\n<summary>The following environment variables are respected:</summary>\n\n```\nPATDB_CODE_STYLE\nPATDB_EMPH_COLOR\nPATDB_ERROR_COLOR\nPATDB_INFO_COLOR\nPATDB_PROMPT_COLOR\n\nPATDB_DEPTH\nPATDB_EDITOR\n\nPATDB_KEY_{command name}, e.g. `PATDB_DOWN_FRAME`\n\nCOLORFGBG\nEDITOR\nPTPYTHON_CONFIG_HOME\n```\n\n- `PATDB_CODE_STYLE`: used by the `show_function` and `show_file` commands, as the colour theme for displaying code. Can be the name of any [Pygments style](https://pygments.org/styles/), to use as the theme for code. Defaults to `solarized-dark`.\n- `PATDB_EMPH_COLOR`: the colour used to emphasise the file/function/lines when displaying location, e.g. in `File *foo.py*, at *some_fn* from *1*, line *2*`. Defaults to `#4cb066`.\n- `PATDB_ERROR_COLOR`: the colour used to display the type of error e.g. in `*RuntimeError*: something went wrong`. Defaults to `#dc322f`.\n- `PATDB_INFO_COLOR`: the colour used to display `patdb:` info prompts. Defaults to `#888888`.\n- `PATDB_PROMPT_COLOR`: the color used to display the `patdb>` REPL prompt. Defaults to `#268bd2`.\n\n- `PATDB_DEPTH`: controls the `patdb` prompt and the prompt of any nested `interpret`ers. By default it is just `patdb>` and `>>>` respectively. If you nest `patdb->interpret->patdb->...` then this environment variable will increment and successive prompts will appear as `patdb1>`, `1>>>`, `patdb2>` etc.\n- `PATDB_EDITOR`: used by the `edit` command. If set then this command will call `$PATDB_EDITOR $filename $linenumber`. If not set then it will fall back to just `$EDITOR $filename`.\n\n- `PATDB_KEY_{command name}`: this offers a way to rebind keys. For example `PATDB_KEY_DOWN_FRAME=d` to replace the default `j` with `d`.\n - Can require that a chain of keys is pressed by separating them with `+`. For example `PATDB_KEY_DOWN_FRAME=a+b` requires that `a` and then `b` be pressed to trigger that command.\n - Can accept multiple different key bindings for the same command by separating them with a `/`. For example `PATDB_KEY_DOWN_FRAME=j/d`.\n - Modifiers keys can be applied following [prompt_toolkit syntax](https://python-prompt-toolkit.readthedocs.io/en/master/pages/advanced_topics/key_bindings.html). In particular this treats `Control` as part of the same key, so that for example `c-x` is `Control x`. Meanwhile `Alt` is (in the usual way for terminals) treated as a separate key press of `escape`, so that for example `escape+d` is `Alt d` \n - Overall, for example: `a/c-k+b/escape+l` means that any of `a`, or `Control k` followed by `b`, or `Alt l`, will trigger that keybind.\n - The full list of all keys is as follows. The group of keys starting `PATDB_KEY_SHOW_` correspond to the interactive commands within the `show_file` and `show_function` command. The group of keys starting `PATDB_KEY_STACK_` correspond to the interactive commands within the `stack` command.\n ```\n PATDB_KEY_DOWN_FRAME\n PATDB_KEY_UP_FRAME\n PATDB_KEY_DOWN_CALLSTACK\n PATDB_KEY_UP_CALLSTACK\n PATDB_KEY_SHOW_FUNCTION\n PATDB_KEY_SHOW_FILE\n PATDB_KEY_STACK\n PATDB_KEY_PRINT\n PATDB_KEY_PRINT_LONG_ARRAYS\n PATDB_KEY_EDIT\n PATDB_KEY_INTERPRET\n PATDB_KEY_VISIBILITY\n PATDB_KEY_CONTINUE\n PATDB_KEY_QUIT\n PATDB_KEY_HELP\n PATDB_KEY_SHOW_DOWN_LINE\n PATDB_KEY_SHOW_UP_LINE\n PATDB_KEY_SHOW_LEFT\n PATDB_KEY_SHOW_RIGHT\n PATDB_KEY_SHOW_DOWN_CALL\n PATDB_KEY_SHOW_SELECT\n PATDB_KEY_SHOW_LEAVE\n PATDB_KEY_STACK_DOWN_FRAME\n PATDB_KEY_STACK_UP_FRAME\n PATDB_KEY_STACK_DOWN_CALLSTACK\n PATDB_KEY_STACK_UP_CALLSTACK\n PATDB_KEY_STACK_LEFT\n PATDB_KEY_STACK_RIGHT\n PATDB_KEY_STACK_VISIBILITY\n PATDB_KEY_STACK_ERROR\n PATDB_KEY_STACK_COLLAPSE_SINGLE\n PATDB_KEY_STACK_COLLAPSE_ALL\n PATDB_KEY_STACK_SELECT\n PATDB_KEY_STACK_LEAVE\n ```\n\n- `COLORFGBG`: some environments provide this to describe the colour of the terminal. If available, this will be queried to determine if your terminal is using a light or dark background. This is used to determine the fallback colour for any tokens not specified by the code style specified in `PATDB_CODE_STYLE`.\n- `EDITOR`: used as a fallback if `PATDB_EDITOR` is not available.\n- `PTPYTHON_CONFIG_HOME`: used by the `interpret` command. This command uses [`ptpython`](https://github.com/prompt-toolkit/ptpython) for the interpreter, and we respect any existing configuration you have configured for `ptpython`.\n</details>\n\n## FAQ\n\n<details>\n<summary>Why the name <code>patdb</code>?</summary>\n<br>\n\nThe built-in debugger is called `pdb`, and my name is Patrick! \ud83d\ude01\n</details>\n<details>\n<summary>Why this (fairly small) set of commands?</summary>\n<br>\n\n`patdb` was designed for its commands to be almost entirely be about understanding the stack trace. Once you're where you need to be, then hit `i` to open a REPL and start interacting with the variables directly.\n</details>\n<details>\n<summary>How does <code>patdb</code> differ from <code>pdb</code>/... etc?</summary>\n\n##### `pdb`/`pdb++`/`ipdb`?\n\nWe handle nested exceptions; scrolling through the stack; syntax highlighting; interacting with hidden frames; etc etc. (`ipdb` does offer a couple of those last ones as well.)\n\n`patdb` largely aims to supersede these debuggers.\n\n##### `pudb`?\n\nWe handle nested exceptions. The main difference, though, is that `pudb` offers a \"graphical\" interface, displaying information about variables / exceptions / code / etc. in multiple panes. This is a bit of a philosophical choice -- personally I prefer REPL-like interfaces, as these keep a history of all the things I've ever done, which I can go back and check if required. I find this particularly valuable when debugging! But others may prefer the graphical interface of `pudb`.\n</details>\n\n## Advanced usage\n\n<details>\n<summary>Can I customise the interpreter?</summary>\n<br>\n\nYes! We use [`ptpython`](https://github.com/prompt-toolkit/ptpython) for our nested REPL, and will respect any `ptpython` configuration you already have.\n\nWhy not `ipython`? The reason is that I found `ipython` to be pretty unclear to work with. They have all of:\n\n```\nIPython.core.interactiveshell.InteractiveShell\nIPython.terminal.interactiveshell.TerminalInteractiveShell\nIPython.terminal.embed.InteractiveShellEmbed\n```\n\nand I couldn't easily figure out how to get any of them to operate correctly when embedded in a larger program. In contrast `ptpython` pretty much worked out-of-the-box!\n</details>\n</details>\n<details>\n<summary>When using <code>edit</code>, how can I open my <code>$EDITOR</code> to the current line number? (And not just the top of the current file.)</summary>\n<br>\n\nSet `PATDB_EDITOR` as discussed in 'configuration' above.\n</details>\n<details>\n<summary>How can I access the current exception or the current frame?</summary>\n<br>\n\nWhen `p`rinting or `i`nteracting then the current exception is available as `__exception__` and the current frame is available as `__frame__`.\n</details>\n<details>\n<summary>Investigating an existing exception, traceback, or frame object.</summary>\n<br>\n\nCall either `patdb.debug(some_exception)` or `patdb.debug(some_traceback)` or `patdb.debug(some_frame)` if you have a particular exception/traceback/frame that you'd like to investigate. Exceptions may potentially have multiple callstacks (subexceptions via `__cause__` and `__context__` are checked, with one callstack for each exception), the others will enable debugging of a single callstack.\n</details>\n<details>\n<summary>Setting <code>sys.excepthook</code>.</summary>\n<br>\n\nBy default, Python will call `sys.excepthook` on any exception that reaches the top of your program. In practice we usually recommend using `python -m patdb foo.py` as the way to open a debugger when an exception occurs, as unfortunately Python offers no easy way to set `sys.excepthook` from outside a program.\n\nHowever if you can modify the top of your script, or if you use [`usercustomize.py`](https://docs.python.org/3/library/site.html#module-usercustomize), then another way to enable `patdb` is to set `sys.excepthook = patdb.debug` before any exceptions hit the top level.\n</details>\n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [yyyy] [name of copyright owner]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.",
"summary": "Pat's Python debugger",
"version": "0.1.1",
"project_urls": {
"repository": "https://github.com/patrick-kidger/patdb"
},
"split_keywords": [
"bdb",
" debug",
" debugger",
" patdb",
" pdb"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1fd53d5ebdc92ff0f7ecb32f3c49e3485083e5856fb3bf9d404549007ce6cfb6",
"md5": "9c50c3de963472275773d4f1d74b045e",
"sha256": "af6146607fe5de1e3c39c49e9c7894f0b2a5683045d19c4d2a3d99fefd1e9d1b"
},
"downloads": -1,
"filename": "patdb-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c50c3de963472275773d4f1d74b045e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 44559,
"upload_time": "2025-07-16T19:37:58",
"upload_time_iso_8601": "2025-07-16T19:37:58.189922Z",
"url": "https://files.pythonhosted.org/packages/1f/d5/3d5ebdc92ff0f7ecb32f3c49e3485083e5856fb3bf9d404549007ce6cfb6/patdb-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f15ea84bb34fca45b295db118a951719e78bc48768888ec93315fa371772b51b",
"md5": "3ca9b933f80d6fe0de9f3f56fe131dec",
"sha256": "8b496119af38e35dc0dcbfd20d9fec2e50b3ee6cf204d95def16c940da23465d"
},
"downloads": -1,
"filename": "patdb-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "3ca9b933f80d6fe0de9f3f56fe131dec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 39766,
"upload_time": "2025-07-16T19:37:59",
"upload_time_iso_8601": "2025-07-16T19:37:59.000089Z",
"url": "https://files.pythonhosted.org/packages/f1/5e/a84bb34fca45b295db118a951719e78bc48768888ec93315fa371772b51b/patdb-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-16 19:37:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "patrick-kidger",
"github_project": "patdb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "patdb"
}
