-
Notifications
You must be signed in to change notification settings - Fork 45
/
patch_ipdb.py
65 lines (52 loc) · 2.41 KB
/
patch_ipdb.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# Copyright 2024 The Penzai Authors.
#
# 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.
"""Patches the ipdb debugger to enable rich output (e.g. with treescope).
``displayhook`` is the method that is called to print outputs in PDB to the
console. This isn't a documented attribute on `pdb.PDB` but overriding it
appears to work correctly.
This patch is fairly unergonomic, since it directly rewrites methods on the
IPython ``Pdb`` class. However, modifying this displayhook is otherwise fairly
complex, since the debugger class is hardcoded in various places to enable
IPython magics like ``%debug``. This also has the advantage of automatically
patching all subclasses of IPython's debugger as well (unless they specifically
override the displayhook).
Note that this will only use `penzai.treescope` if treescope has been registered
as the default IPython display hook, using
`pz.ts.register_as_default()`
"""
import IPython.core.debugger
import IPython.display
def displayhook_with_ipython(self, obj):
"""Custom displayhook to display results with IPython."""
del self
# reproduce the behavior of the standard displayhook, not printing None
if obj is not None:
IPython.display.display(obj)
old_displayhook = None
def patch_ipdb(force: bool = False):
"""Patches the IPython debugger to use `IPython.display.display`."""
global old_displayhook
if old_displayhook is not None and not force:
raise ValueError(
"IPython.core.debugger.Pdb.displayhook has already been patched!"
)
old_displayhook = IPython.core.debugger.Pdb.displayhook
IPython.core.debugger.Pdb.displayhook = displayhook_with_ipython
def unpatch_ipdb():
"""Unpatches the IPython debugger so that it uses its original displayhook."""
global old_displayhook
assert old_displayhook is not None
assert IPython.core.debugger.Pdb.displayhook is displayhook_with_ipython
IPython.core.debugger.Pdb.displayhook = old_displayhook
old_displayhook = None