{"author":"Godefroid Chapelle","author_email":"gotcha@bubblenet.be","bugtrack_url":null,"classifiers":["License :: OSI Approved :: BSD License","Operating System :: MacOS :: MacOS X","Operating System :: Microsoft :: Windows","Operating System :: POSIX :: Linux","Programming Language :: Python :: 2.7","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.4","Programming Language :: Python :: 3.5","Programming Language :: Python :: 3.6","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Software Development :: Debuggers"],"description":"IPython `pdb`\n=============\n\n.. image:: https://travis-ci.org/gotcha/ipdb.png?branch=master\n :target: https://travis-ci.org/gotcha/ipdb\n.. image:: https://codecov.io/gh/gotcha/ipdb/branch/master/graphs/badge.svg?style=flat\n :target: https://codecov.io/gh/gotcha/ipdb?branch=master\n\nUse\n---\n\nipdb exports functions to access the IPython_ debugger, which features\ntab completion, syntax highlighting, better tracebacks, better introspection\nwith the same interface as the `pdb` module.\n\nExample usage:\n\n.. code-block:: python\n\n import ipdb\n ipdb.set_trace()\n ipdb.set_trace(context=5) # will show five lines of code\n # instead of the default three lines\n # or you can set it via IPDB_CONTEXT_SIZE env variable\n # or setup.cfg file\n ipdb.pm()\n ipdb.run('x[0] = 3')\n result = ipdb.runcall(function, arg0, arg1, kwarg='foo')\n result = ipdb.runeval('f(1,2) - 3')\n\n\nArguments for `set_trace`\n+++++++++++++++++++++++++\n\nThe `set_trace` function accepts `context` which will show as many lines of code as defined,\nand `cond`, which accepts boolean values (such as `abc == 17`) and will start ipdb's\ninterface whenever `cond` equals to `True`.\n\nUsing configuration file\n++++++++++++++++++++++++\n\nIt's possible to set up context using a `.ipdb` file on your home folder, `setup.cfg`\nor `pyproject.toml` on your project folder. You can also set your file location via\nenv var `$IPDB_CONFIG`. Your environment variable has priority over the home\nconfiguration file, which in turn has priority over the setup config file.\nCurrently, only context setting is available.\n\nA valid setup.cfg is as follows\n\n::\n\n [ipdb]\n context=5\n\n\nA valid .ipdb is as follows\n\n::\n\n context=5\n\n\nA valid pyproject.toml is as follows\n\n::\n\n [tool.ipdb]\n context=5\n\n\nThe post-mortem function, ``ipdb.pm()``, is equivalent to the magic function\n``%debug``.\n\n.. _IPython: http://ipython.org\n\nIf you install ``ipdb`` with a tool which supports ``setuptools`` entry points,\nan ``ipdb`` script is made for you. You can use it to debug your python 2 scripts like\n\n::\n\n $ bin/ipdb mymodule.py\n\nAnd for python 3\n\n::\n\n $ bin/ipdb3 mymodule.py\n\nAlternatively with Python 2.7 only, you can also use\n\n::\n\n $ python -m ipdb mymodule.py\n\nYou can also enclose code with the ``with`` statement to launch ipdb if an exception is raised:\n\n.. code-block:: python\n\n from ipdb import launch_ipdb_on_exception\n\n with launch_ipdb_on_exception():\n [...]\n\n.. warning::\n Context managers were introduced in Python 2.5.\n Adding a context manager implies dropping Python 2.4 support.\n Use ``ipdb==0.6`` with 2.4.\n\nOr you can use ``iex`` as a function decorator to launch ipdb if an exception is raised:\n\n.. code-block:: python\n\n from ipdb import iex\n\n @iex\n def main():\n [...]\n\n.. warning::\n Using ``from future import print_function`` for Python 3 compat implies dropping Python 2.5 support.\n Use ``ipdb<=0.8`` with 2.5.\n\nIssues with ``stdout``\n----------------------\n\nSome tools, like ``nose`` fiddle with ``stdout``.\n\nUntil ``ipdb==0.9.4``, we tried to guess when we should also\nfiddle with ``stdout`` to support those tools.\nHowever, all strategies tried until 0.9.4 have proven brittle.\n\nIf you use ``nose`` or another tool that fiddles with ``stdout``, you should\nexplicitly ask for ``stdout`` fiddling by using ``ipdb`` like this\n\n.. code-block:: python\n\n import ipdb\n ipdb.sset_trace()\n ipdb.spm()\n\n from ipdb import slaunch_ipdb_on_exception\n with slaunch_ipdb_on_exception():\n [...]\n\n\nDevelopment\n-----------\n\n``ipdb`` source code and tracker are at https://github.com/gotcha/ipdb.\n\nPull requests should take care of updating the changelog ``HISTORY.txt``.\n\nUnder the unreleased section, add your changes and your username.\n\nManual testing\n++++++++++++++\n\nTo test your changes, make use of ``manual_test.py``. Create a virtual environment,\ninstall IPython and run ``python manual_test.py`` and check if your changes are in effect.\nIf possible, create automated tests for better behaviour control.\n\nAutomated testing\n+++++++++++++++++\n\nTo run automated tests locally, create a virtual environment, install `coverage`\nand run `coverage run setup.py test`.\n\nThird-party support\n-------------------\n\nProducts.PDBDebugMode\n+++++++++++++++++++++\n\nZope2 Products.PDBDebugMode_ uses ``ipdb``, if available, in place of ``pdb``.\n\n.. _Products.PDBDebugMode: http://pypi.python.org/pypi/Products.PDBDebugMode\n\niw.debug\n++++++++\n\niw.debug_ allows you to trigger an ``ipdb`` debugger on any published object\nof a Zope2 application.\n\n.. _iw.debug: http://pypi.python.org/pypi/iw.debug\n\nipdbplugin\n++++++++++\n\nipdbplugin_ is a nose_ test runner plugin that also uses the IPython debugger\ninstead of ``pdb``. (It does not depend on ``ipdb`` anymore).\n\n.. _ipdbplugin: http://pypi.python.org/pypi/ipdbplugin\n.. _nose: http://readthedocs.org/docs/nose\n\n\nChangelog\n=========\n\n0.13.13 (2023-03-09)\n--------------------\n\n- Use context manager for opening toml config\n [andrewzwicky]\n\n\n0.13.12 (2023-03-09)\n--------------------\n\n- Modify tests to test 3.11 separately from earlier python versions.\n [andrewzwicky]\n\n\n0.13.11 (2022-12-13)\n--------------------\n\n- Better exception handling when looking for config.\n [bignose-debian]\n\n\n0.13.10 (2022-12-13)\n--------------------\n\n- Better toml support (use tomlib for 3.11, tomli for 3.6 to 3.10).\n [salty-horse, mgorny]\n\n- Minimal PEP 517 support.\n [cpcloud]\n\n- 3.11 support for run as module and run as script.\n [nphilipp, gotcha]\n\n- Based on OSV:PYSEC-2022-12 change ipython dependencies,\n for users using python 3.6, install 7.16.3 <= IPython < 7.17.0,\n for users using python>3.6, install IPython >= 7.31.1.\n [malkstar]\n\n\n0.13.9 (2021-06-02)\n-------------------\n\n- Fix again when `pyproject.toml` does not contain `tool` section.\n [markab108]\n\n\n0.13.8 (2021-05-26)\n-------------------\n\n- Fix when `pyproject.toml` does not contain `tool` section.\n [anjos]\n\n- Add the convenience function ``iex()``.\n [alanbernstein]\n\n\n0.13.7 (2021-03-16)\n-------------------\n\n- Do not instantiate IPython on import\n [adamchainz]\n\n\n0.13.6 (2021-03-08)\n-------------------\n\n- Fix broken parsing of pyproject.toml\n [alexandrebarbaruiva]\n\n\n0.13.5 (2021-03-02)\n-------------------\n\n- Add support for pyproject.toml as configuration file\n [alexandrebarbaruiva]\n\n- For users using python 3.4, install 6.0.0 <= IPython < 7.0.0,\n for users using python 3.5, install 7.0.0 <= IPython < 7.10.0,\n for users using python 3.6, install 7.10.0 <= IPython < 7.17.0,\n for users using python>3.6, install IPython >= 7.17.0.\n [d1618033]\n\n\n0.13.4 (2020-10-01)\n-------------------\n\n- Add '-m' option\n [mrmino]\n\n\n0.13.3 (2020-06-23)\n-------------------\n\n- Allow runcall, runeval to also use set context value\n [meowser]\n\n- Add condition argument to set_trace\n [alexandrebarbaruiva]\n\n\n0.13.2 (2020-03-03)\n-------------------\n\n- Remove leftover debug code\n [gotcha]\n\n\n0.13.1 (2020-02-28)\n-------------------\n\n- Fix when no configuration file\n [gotcha]\n\n\n0.13.0 (2020-02-28)\n-------------------\n\n- Add option to set context via environment variable or configuration file\n [alexandrebarbaruiva]\n\n\n0.12.3 (2019-12-03)\n-------------------\n\n- Fix version in usage\n [gotcha]\n\n\n0.12.2 (2019-07-30)\n-------------------\n\n- Avoid emitting term-title bytes\n [steinnes]\n\n\n0.12.1 (2019-07-26)\n-------------------\n\n- Fix --help \n [native-api]\n\n\n0.12 (2019-03-20)\n-----------------\n\n- Drop support for Python 3.3.x\n [bmw]\n- Stop deprecation warnings from being raised when IPython >= 5.1 is used.\n Support for IPython < 5.1 has been dropped.\n [bmw]\n\n\n0.11 (2018-02-15)\n-----------------\n\n- Simplify loading IPython and getting information from it.\n Drop support for python 2.6\n Drop support for IPython < 5.0.0\n [takluyver]\n\n\n0.10.3 (2017-04-22)\n-------------------\n\n- For users using python 2.6, do not install IPython >= 2.0.0.\n And for users using python 2.7, do not install IPython >= 6.0.0.\n [vphilippon]\n- Drop support for python 3.2.\n [vphilippon]\n- Command line usage consistent with pdb - Add argument commands\n [zvodd]\n\n\n0.10.2 (2017-01-25)\n-------------------\n\n- Ask IPython which debugger class to use.\n Closes https://github.com/gotcha/ipdb/issues/105\n [gnebehay, JBKahn] \n\n- ipdb.set_trace() does not ignore context arg anymore.\n Closes https://github.com/gotcha/ipdb/issues/93.\n [gnebehay, Garrett-R]\n\n\n0.10.1 (2016-06-14)\n-------------------\n\n- Support IPython 5.0.\n [ngoldbaum]\n\n\n0.10.0 (2016-04-29)\n-------------------\n\n- Stop trying to magically guess when stdout needs to be captured.\n Like needed by `nose`.\n Rather, provide a set of function that can be called explicitely when needed.\n [gotcha]\n\n- drop support of IPython before 0.10.2\n\n\n0.9.4 (2016-04-29)\n------------------\n\n- Fix Restart error when using `python -m ipdb`\n Closes https://github.com/gotcha/ipdb/issues/93.\n [gotcha]\n\n\n0.9.3 (2016-04-15)\n------------------\n\n- Don't require users to pass a traceback to post_mortem.\n [Wilfred]\n\n\n0.9.2 (2016-04-15)\n------------------\n\n- Closes https://github.com/gotcha/ipdb/issues/93.\n [gotcha]\n\n\n0.9.1 (2016-04-12)\n------------------\n\n- Reset ``sys.modules['__main__']`` to original value.\n Closes https://github.com/gotcha/ipdb/issues/85\n [gotcha]\n\n- Fix support of IPython versions 0.x\n [asivokon]\n\n\n0.9.0 (2016-02-22)\n------------------\n\n- Switch to revised BSD license (with approval of all contributors).\n Closes https://github.com/gotcha/ipdb/issues/68\n [lebedov, gotcha]\n\n0.8.3 (2016-02-17)\n------------------\n\n- Don't pass sys.argv to IPython for configuration.\n [emulbreh]\n\n\n0.8.2 (2016-02-15)\n------------------\n\n- Fix lexical comparison for version numbers.\n [sas23]\n\n- Allow configuring how many lines of code context are displayed\n by `set_trace`\n [JamshedVesuna]\n\n- If an instance of IPython is already running its configuration will be\n loaded.\n [IxDay]\n\n\n0.8.1 (2015-06-03)\n------------------\n\n- Make Nose support less invasive.\n Closes https://github.com/gotcha/ipdb/issues/52\n Closes https://github.com/gotcha/ipdb/issues/31\n [blink1073, gotcha]\n\n- Fix for post_mortem in context manager.\n Closes https://github.com/gotcha/ipdb/issues/20\n [omergertel]\n\n\n0.8 (2013-09-19)\n----------------\n\n- More Python 3 compatibility; implies dropping Python 2.5 support.\n Closes https://github.com/gotcha/ipdb/issues/37\n [gotcha]\n\n\n0.7.1 (2013-09-19)\n------------------\n\n- IPython 1.0 compatibility.\n Closes https://github.com/gotcha/ipdb/issues/44\n [pgularski]\n\n- Index into version_info in setup.py for Python 2.6 compatibility.\n [kynan]\n\n- Add Travis CI configuration.\n [kynan]\n\n0.7 (2012-07-06)\n----------------\n\n- Add ``launch_ipdb_on_exception`` context manager. Implies dropping Python 2.4 support.\n [Psycojoker]\n\n- Wrap sys.excepthook only once.\n [marciomazza]\n\n- Add GPL file and refer in headers.\n [stan3]\n\n- Python 3 support.\n [Piet Delport]\n\n- Basic tests.\n [msabramo]\n\n- Added the functions ``runcall``, ``runeval`` and ``run``.\n [dimasad]\n\n\n0.6.1 (2011-10-17)\n------------------\n\n- State dependency on IPython later or equal to 0.10.\n [gotcha]\n\n\n0.6 (2011-09-01)\n----------------\n\n- Add setuptools ``console_scripts`` entry point.\n [akrito, gotcha] \n\n- Nose support.\n Closes https://github.com/gotcha/ipdb/issues/8\n [akaihola, gotcha]\n\n\n0.5 (2011-08-05)\n----------------\n\n- IPython 0.11 support.\n [lebedov]\n\n\n0.4 (2011-06-13)\n----------------\n\n- When used from IPython, use its colors.\n Closes https://github.com/gotcha/ipdb/issues/1\n [gotcha]\n\n- Fixed errors when exiting with \"q\". \n [gotcha]\n\n- Allow use of ``python -m ipdb mymodule.py``.\n Python 2.7 only. \n Closes https://github.com/gotcha/ipdb/issues/3 \n [gotcha]\n\n- Fixed post_mortem when the traceback is None.\n [maurits]\n\n\n0.3 (2011-01-16)\n----------------\n\n- Add ``post_mortem()`` for ``Products.PDBDebugMode`` support.\n [Jean Jordaan]\n\n- Moved to github.com.\n\n\n0.2 (2010-10-20)\n----------------\n\n- Added ``pm()``.\n [Paulo Benedict Ang]\n\n\n0.1 (2010-04-26)\n----------------\n\n- First \"non dev\" release.\n","description_content_type":"","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/gotcha/ipdb","keywords":"pdb ipython","license":"BSD","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"ipdb","package_url":"https://pypi.org/project/ipdb/","platform":null,"project_url":"https://pypi.org/project/ipdb/","project_urls":{"Homepage":"https://github.com/gotcha/ipdb"},"provides_extra":null,"release_url":"https://pypi.org/project/ipdb/0.13.13/","requires_dist":["ipython (<6.0.0,>=5.1.0) ; python_version == \"2.7\"","toml (>=0.10.2) ; python_version == \"2.7\"","decorator (<5.0.0) ; python_version == \"2.7\"","pathlib ; python_version == \"2.7\"","ipython (<7.0.0,>=6.0.0) ; python_version == \"3.4\"","toml (>=0.10.2) ; python_version == \"3.4\"","decorator (<5.0.0) ; python_version == \"3.4\"","ipython (<7.10.0,>=7.0.0) ; python_version == \"3.5\"","toml (>=0.10.2) ; python_version == \"3.5\"","decorator ; python_version == \"3.5\"","ipython (<7.17.0,>=7.16.3) ; python_version == \"3.6\"","tomli ; python_version == \"3.6\"","decorator ; python_version == \"3.6\"","ipython (>=7.31.1) ; python_version > \"3.6\" and python_version < \"3.11\"","tomli ; python_version > \"3.6\" and python_version < \"3.11\"","decorator ; python_version > \"3.6\" and python_version < \"3.11\"","ipython (>=7.31.1) ; python_version >= \"3.11\"","decorator ; python_version >= \"3.11\""],"requires_python":">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*","summary":"IPython-enabled pdb","version":"0.13.13","yanked":false,"yanked_reason":null}

Dependencies of ipdb (5).
Dependency	Optional
decorator	false
ipython	false
pathlib	false
toml	false
tomli	false

Package search

ipdb

project_urls

Dependencies

All package metadata

Releases