ipdb: pdef, pdoc, pinfo magics all broken #2169

bfroehle · 2012-07-18T23:12:41Z

In[1]: dg.meshes.square.qmesh(2)
...
IndexError: index (48) out of range (0<=index<47) in dimension 0

In [2]: debug
...
ipdb> pinfo jx
...
/usr/lib/python2.7/dist-packages/IPython/core/debugger.pyc in do_pinfo(self, arg)
    490         namespaces = [('Locals', self.curframe.f_locals),
    491                       ('Globals', self.curframe.f_globals)]
--> 492         self.shell.magic_pinfo("pinfo %s" % arg, namespaces=namespaces)
    493 
    494     def checkline(self, filename, lineno):

AttributeError: 'TerminalInteractiveShell' object has no attribute 'magic_pinfo'

bfroehle · 2012-07-18T23:10:08Z

Pull request in the works.

bfroehle · 2012-07-18T23:14:08Z

IPython/core/debugger.py

@@ -478,19 +478,20 @@ def do_pdef(self, arg):
        """The debugger interface to magic_pdef"""
        namespaces = [('Locals', self.curframe.f_locals),
                      ('Globals', self.curframe.f_globals)]
-        self.shell.magic_pdef(arg, namespaces=namespaces)
+        self.shell.find_line_magic('pdef')(arg, namespaces=namespaces)


Note that we cannot use self.shell.run_line_magic since we need to pass the namespaces parameter along.

takluyver · 2012-07-18T23:21:50Z

Is there a convenient way to test this automatically?

bfroehle · 2012-07-18T23:28:25Z

No idea. Clearly not a heavily used feature since it's been broken for almost 2 years...

takluyver · 2012-07-19T00:31:34Z

I didn't even realise magic commands worked in the debugger ;-)

It looks OK to me, but I'll let someone else have a look over it.

bfroehle · 2012-07-19T00:35:38Z

Test results for commit 4767539 merged into master
Platform: linux2

python2.7: OK
python3.2: OK (libraries not available: oct2py pymongo rpy2 wx wx.aui)

Not available for testing: python2.6

bfroehle · 2012-07-19T00:36:03Z

(Not that any of this is actually tested by anything...)

fperez · 2012-07-20T12:17:14Z

At the very least a set of smoke tests with a toy function would catch the worst offences.

Ideally, magics meant to print output should always be written as two components: a pure function that returns a string, and the user-facing one that simply calls print. That way we can test programatically the inner one, and ignore the print one-liner tests-wise (or simply smoke-test it without worrying about trying to capture stdout).

If you want to refactor these in two each to that effect, that would be awesome. The more we pay little by little our technical debt, the better...

fperez · 2012-07-20T12:18:46Z

ps - the PR is still better than the current situation, so if you think you can't do the little refactoring step for those tests now, just add the outer smoke tests at least, which are better than nothing and trivial to do.

bfroehle · 2012-07-20T15:40:29Z

Let's do this in two phases then, the first a simple fix for inclusion in 0.13.1 and then a bigger refactoring.

I'm looking in to how to write a test for the debugger. I think I should be able to find some examples in the CPython source.

bfroehle · 2012-07-20T18:37:03Z

Okay, so I've added some tests for calling pdef/pdoc/pinfo from ipdb.

fperez · 2012-07-21T04:49:07Z

IPython/core/debugger.py


    def do_pinfo(self, arg):
        """The debugger equivalant of ?obj"""
        namespaces = [('Locals', self.curframe.f_locals),
                      ('Globals', self.curframe.f_globals)]
-        self.shell.magic_pinfo("pinfo %s" % arg, namespaces=namespaces)
+        self.shell.find_line_magic('pinfo')("pinfo %s" % arg,


Why did you decide to make the call this way and not with the higher-level run_line_magic method?

fperez · 2012-07-21T04:50:38Z

Code looks great, will post test_pr results soon with 604b310 and we can merge once the minor question above is clarified. thanks!

fperez · 2012-07-21T04:52:22Z

Test results for commit 604b310 merged into master
Platform: linux2

python2.7: OK
python3.2: OK (libraries not available: cython matplotlib oct2py pygments pymongo rpy2 wx wx.aui)

Not available for testing: python2.6, python3.1

minrk · 2012-07-21T05:50:28Z

@fperez he answered that above with:

Note that we cannot use self.shell.run_line_magic since we need to pass the namespaces parameter along.

ipdb: Fix pdef, pdoc, pinfo commands.

bfroehle · 2012-07-23T20:17:35Z

@minrk Are you handling cherry-picking these commits into the 0.13.1 branch?

minrk · 2012-07-23T20:19:15Z

yeah - I've been putting together a script that applies the patch from GitHub, so I (or anyone) can do python backport_pr.py 2169. The 0.13.1 branch on ipython is the result of this script so far.

fperez · 2012-07-23T23:42:09Z

Right, missed that. Thanks!

``` In[1]: dg.meshes.square.qmesh(2) ... IndexError: index (48) out of range (0<=index<47) in dimension 0 In [2]: debug ... ipdb> pinfo jx ... /usr/lib/python2.7/dist-packages/IPython/core/debugger.pyc in do_pinfo(self, arg) 490 namespaces = [('Locals', self.curframe.f_locals), 491 ('Globals', self.curframe.f_globals)] --> 492 self.shell.magic_pinfo("pinfo %s" % arg, namespaces=namespaces) 493 494 def checkline(self, filename, lineno): AttributeError: 'TerminalInteractiveShell' object has no attribute 'magic_pinfo' ```

* commit 'rel-0.13-33-gcfc5692': (33 commits) Backport PR ipython#2347: adjust division error message checking to account for Python 3 Backport PR ipython#2305: RemoteError._render_traceback_ calls self.render_traceback Backport PR ipython#2280: fix SSH passwordless check for OpenSSH Backport PR ipython#2270: SSHLauncher tweaks Backport PR ipython#2261: Fix: longest_substr([]) -> '' Backport PR ipython#2250: fix html in notebook example Backport PR ipython#2235: remove spurious print statement from setupbase.py fixup Backport PR ipython#2223: Custom tracebacks Backport PR ipython#2214: use KernelApp.exec_lines/files in IPEngineApp Backport PR ipython#2212: catch errors in markdown javascript Backport PR ipython#2194: clean nan/inf in json_clean Backport PR ipython#2177: remove numpy install from travis/tox scripts Backport PR ipython#2169: ipdb: pdef, pdoc, pinfo magics all broken Backport PR ipython#2186: removed references to h5py dependence in octave magic documentation Backport PR ipython#2185: added test for %store, fixed storemagic Backport PR ipython#2170: Fix tab completion with IPython.embed_kernel(). Backport PR ipython#2163: fix 'remote_profie_dir' typo in SSH launchers Backport PR ipython#2117: use explicit url in notebook example Backport PR ipython#2126: ipcluster broken with any batch (PBS/LSF/SGE) ...

ipdb: Fix pdef, pdoc, pinfo commands.

bfroehle added 2 commits July 18, 2012 16:11

ipdb interface: look up magics by name and call them.

f156465

Pass along namespaces, so that we can find objects when calling in ipdb.

4767539

ghost assigned bfroehle Jul 18, 2012

bfroehle reviewed Jul 18, 2012
View reviewed changes

ghost assigned bfroehle Jul 20, 2012

Add basic tests for calling pdef/pdoc/pinfo from ipdb.

604b310

fperez reviewed Jul 21, 2012
View reviewed changes

bfroehle added a commit that referenced this pull request Jul 23, 2012

Merge pull request #2169 from bfroehle/ipdb_magics

2e3f3b3

ipdb: Fix pdef, pdoc, pinfo commands.

bfroehle merged commit 2e3f3b3 into ipython:master Jul 23, 2012

mattvonrocketstein pushed a commit to mattvonrocketstein/ipython that referenced this pull request Nov 3, 2014

Merge pull request ipython#2169 from bfroehle/ipdb_magics

2a5b552

ipdb: Fix pdef, pdoc, pinfo commands.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ipdb: pdef, pdoc, pinfo magics all broken #2169

ipdb: pdef, pdoc, pinfo magics all broken #2169

bfroehle commented Jul 18, 2012

bfroehle commented Jul 18, 2012

bfroehle Jul 18, 2012

takluyver commented Jul 18, 2012

bfroehle commented Jul 18, 2012

takluyver commented Jul 19, 2012

bfroehle commented Jul 19, 2012

bfroehle commented Jul 19, 2012

fperez commented Jul 20, 2012

fperez commented Jul 20, 2012

bfroehle commented Jul 20, 2012

bfroehle commented Jul 20, 2012

fperez Jul 21, 2012

fperez commented Jul 21, 2012

fperez commented Jul 21, 2012

minrk commented Jul 21, 2012

bfroehle commented Jul 23, 2012

minrk commented Jul 23, 2012

fperez commented Jul 23, 2012

ipdb: pdef, pdoc, pinfo magics all broken #2169

ipdb: pdef, pdoc, pinfo magics all broken #2169

Conversation

bfroehle commented Jul 18, 2012

bfroehle commented Jul 18, 2012

bfroehle Jul 18, 2012

Choose a reason for hiding this comment

takluyver commented Jul 18, 2012

bfroehle commented Jul 18, 2012

takluyver commented Jul 19, 2012

bfroehle commented Jul 19, 2012

bfroehle commented Jul 19, 2012

fperez commented Jul 20, 2012

fperez commented Jul 20, 2012

bfroehle commented Jul 20, 2012

bfroehle commented Jul 20, 2012

fperez Jul 21, 2012

Choose a reason for hiding this comment

fperez commented Jul 21, 2012

fperez commented Jul 21, 2012

minrk commented Jul 21, 2012

bfroehle commented Jul 23, 2012

minrk commented Jul 23, 2012

fperez commented Jul 23, 2012