summaryrefslogtreecommitdiff
path: root/Doc/using
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2017-10-05 12:11:18 -0400
committerGitHub <noreply@github.com>2017-10-05 12:11:18 -0400
commit36c1d1f1e52ba54007cbecb42c5599e5ff62aa52 (patch)
tree317c296450800bfb25851dd92a62050e26c4c4fd /Doc/using
parent4d071897880b7e84e1a217ebe19971c118316970 (diff)
downloadcpython-git-36c1d1f1e52ba54007cbecb42c5599e5ff62aa52.tar.gz
PEP 553 built-in breakpoint() function (bpo-31353) (#3355)
Implement PEP 553, built-in breakpoint() with support from sys.breakpointhook(), along with documentation and tests. Closes bpo-31353
Diffstat (limited to 'Doc/using')
-rw-r--r--Doc/using/cmdline.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index 7b60a9b71f..a8cdff641e 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -502,6 +502,18 @@ conflict.
:option:`-O` multiple times.
+.. envvar:: PYTHONBREAKPOINT
+
+ If this is set, it names a callable using dotted-path notation. The module
+ containing the callable will be imported and then the callable will be run
+ by the default implementation of :func:`sys.breakpointhook` which itself is
+ called by built-in :func:`breakpoint`. If not set, or set to the empty
+ string, it is equivalent to the value "pdb.set_trace". Setting this to the
+ string "0" causes the default implementation of :func:`sys.breakpointhook`
+ to do nothing but return immediately.
+
+ .. versionadded:: 3.7
+
.. envvar:: PYTHONDEBUG
If this is set to a non-empty string it is equivalent to specifying the