IPython-enabled pdb
pdb.. image:: https://travis-ci.org/gotcha/ipdb.png?branch=master :target: https://travis-ci.org/gotcha/ipdb .. image:: https://codecov.io/gh/gotcha/ipdb/branch/master/graphs/badge.svg?style=flat :target: https://codecov.io/gh/gotcha/ipdb?branch=master
ipdb exports functions to access the IPython_ debugger, which features
tab completion, syntax highlighting, better tracebacks, better introspection
with the same interface as the pdb module.
Example usage:
.. code-block:: python
import ipdb
ipdb.set_trace()
ipdb.set_trace(context=5) # will show five lines of code
# instead of the default three lines
# or you can set it via IPDB_CONTEXT_SIZE env variable
# or setup.cfg file
ipdb.pm()
ipdb.run('x[0] = 3')
result = ipdb.runcall(function, arg0, arg1, kwarg='foo')
result = ipdb.runeval('f(1,2) - 3')
Arguments for set_trace
+++++++++++++++++++++++++
The set_trace function accepts context which will show as many lines of code as defined,
and cond, which accepts boolean values (such as abc == 17) and will start ipdb's
interface whenever cond equals to True.
Using configuration file ++++++++++++++++++++++++
It's possible to set up context using a .ipdb file on your home folder, setup.cfg
or pyproject.toml on your project folder. You can also set your file location via
env var $IPDB_CONFIG. Your environment variable has priority over the home
configuration file, which in turn has priority over the setup config file.
Currently, only context setting is available.
A valid setup.cfg is as follows
::
[ipdb]
context=5
A valid .ipdb is as follows
::
context=5
A valid pyproject.toml is as follows
::
[tool.ipdb]
context=5
The post-mortem function, ipdb.pm(), is equivalent to the magic function
%debug.
.. _IPython: http://ipython.org
If you install ipdb with a tool which supports setuptools entry points,
an ipdb script is made for you. You can use it to debug your python 2 scripts like
::
$ bin/ipdb mymodule.py
And for python 3
::
$ bin/ipdb3 mymodule.py
Alternatively with Python 2.7 only, you can also use
::
$ python -m ipdb mymodule.py
You can also enclose code with the with statement to launch ipdb if an exception is raised:
.. code-block:: python
from ipdb import launch_ipdb_on_exception
with launch_ipdb_on_exception():
[...]
.. warning::
Context managers were introduced in Python 2.5.
Adding a context manager implies dropping Python 2.4 support.
Use ipdb==0.6 with 2.4.
Or you can use iex as a function decorator to launch ipdb if an exception is raised:
.. code-block:: python
from ipdb import iex
@iex
def main():
[...]
.. warning::
Using from future import print_function for Python 3 compat implies dropping Python 2.5 support.
Use ipdb<=0.8 with 2.5.
stdoutSome tools, like nose fiddle with stdout.
Until ipdb==0.9.4, we tried to guess when we should also
fiddle with stdout to support those tools.
However, all strategies tried until 0.9.4 have proven brittle.
If you use nose or another tool that fiddles with stdout, you should
explicitly ask for stdout fiddling by using ipdb like this
.. code-block:: python
import ipdb
ipdb.sset_trace()
ipdb.spm()
from ipdb import slaunch_ipdb_on_exception
with slaunch_ipdb_on_exception():
[...]
ipdb source code and tracker are at https://github.com/gotcha/ipdb.
Pull requests should take care of updating the changelog HISTORY.txt.
Under the unreleased section, add your changes and your username.
Manual testing ++++++++++++++
To test your changes, make use of manual_test.py. Create a virtual environment,
install IPython and run python manual_test.py and check if your changes are in effect.
If possible, create automated tests for better behaviour control.
Automated testing +++++++++++++++++
To run automated tests locally, create a virtual environment, install coverage
and run coverage run setup.py test.
Products.PDBDebugMode +++++++++++++++++++++
Zope2 Products.PDBDebugMode_ uses ipdb, if available, in place of pdb.
.. _Products.PDBDebugMode: http://pypi.python.org/pypi/Products.PDBDebugMode
iw.debug ++++++++
iw.debug_ allows you to trigger an ipdb debugger on any published object
of a Zope2 application.
.. _iw.debug: http://pypi.python.org/pypi/iw.debug
ipdbplugin ++++++++++
ipdbplugin_ is a nose_ test runner plugin that also uses the IPython debugger
instead of pdb. (It does not depend on ipdb anymore).
.. _ipdbplugin: http://pypi.python.org/pypi/ipdbplugin .. _nose: http://readthedocs.org/docs/nose
Better toml support (use tomlib for 3.11, tomli for 3.6 to 3.10). [salty-horse, mgorny]
Minimal PEP 517 support. [cpcloud]
3.11 support for run as module and run as script. [nphilipp, gotcha]
Based on OSV:PYSEC-2022-12 change ipython dependencies, for users using python 3.6, install 7.16.3 <= IPython < 7.17.0, for users using python>3.6, install IPython >= 7.31.1. [malkstar]
pyproject.toml does not contain tool section.
[markab108]Fix when pyproject.toml does not contain tool section.
[anjos]
Add the convenience function iex().
[alanbernstein]
Add support for pyproject.toml as configuration file [alexandrebarbaruiva]
For users using python 3.4, install 6.0.0 <= IPython < 7.0.0, for users using python 3.5, install 7.0.0 <= IPython < 7.10.0, for users using python 3.6, install 7.10.0 <= IPython < 7.17.0, for users using python>3.6, install IPython >= 7.17.0. [d1618033]
Allow runcall, runeval to also use set context value [meowser]
Add condition argument to set_trace [alexandrebarbaruiva]
Ask IPython which debugger class to use. Closes https://github.com/gotcha/ipdb/issues/105 [gnebehay, JBKahn]
ipdb.set_trace() does not ignore context arg anymore. Closes https://github.com/gotcha/ipdb/issues/93. [gnebehay, Garrett-R]
Stop trying to magically guess when stdout needs to be captured.
Like needed by nose.
Rather, provide a set of function that can be called explicitely when needed.
[gotcha]
drop support of IPython before 0.10.2
python -m ipdb
Closes https://github.com/gotcha/ipdb/issues/93.
[gotcha]Reset sys.modules['__main__'] to original value.
Closes https://github.com/gotcha/ipdb/issues/85
[gotcha]
Fix support of IPython versions 0.x [asivokon]
Fix lexical comparison for version numbers. [sas23]
Allow configuring how many lines of code context are displayed
by set_trace
[JamshedVesuna]
If an instance of IPython is already running its configuration will be loaded. [IxDay]
Make Nose support less invasive. Closes https://github.com/gotcha/ipdb/issues/52 Closes https://github.com/gotcha/ipdb/issues/31 [blink1073, gotcha]
Fix for post_mortem in context manager. Closes https://github.com/gotcha/ipdb/issues/20 [omergertel]
IPython 1.0 compatibility. Closes https://github.com/gotcha/ipdb/issues/44 [pgularski]
Index into version_info in setup.py for Python 2.6 compatibility. [kynan]
Add Travis CI configuration. [kynan]
Add launch_ipdb_on_exception context manager. Implies dropping Python 2.4 support.
[Psycojoker]
Wrap sys.excepthook only once. [marciomazza]
Add GPL file and refer in headers. [stan3]
Python 3 support. [Piet Delport]
Basic tests. [msabramo]
Added the functions runcall, runeval and run.
[dimasad]
Add setuptools console_scripts entry point.
[akrito, gotcha]
Nose support. Closes https://github.com/gotcha/ipdb/issues/8 [akaihola, gotcha]
When used from IPython, use its colors. Closes https://github.com/gotcha/ipdb/issues/1 [gotcha]
Fixed errors when exiting with "q". [gotcha]
Allow use of python -m ipdb mymodule.py.
Python 2.7 only.
Closes https://github.com/gotcha/ipdb/issues/3
[gotcha]
Fixed post_mortem when the traceback is None. [maurits]
Add post_mortem() for Products.PDBDebugMode support.
[Jean Jordaan]
Moved to github.com.
pm().
[Paulo Benedict Ang]