Custom tracebacks #2223

takluyver · 2012-07-30T21:05:22Z

Rather than special casing IPython.parallel errors (which led to issue #2221), this adds a simple API where exception classes can offer a custom traceback, by defining a _render_traceback_(self) method.

It also adds some documentation on how third parties can integrate packages with IPython. 'Configuration & customisation' seemed the most natural home for this.

We should remember to close #2221 when we merge this - I forgot to put it in a commit message.

…() method.

minrk · 2012-07-30T21:24:51Z

IPython/parallel/error.py

        """render traceback to a list of lines"""
        return (self.traceback or "No traceback available").splitlines()
+
+    # Previous name retained for backwards compatibility.
+    render_traceback = _render_traceback_


I would reverse this alias, because render_traceback is a real public API (not deprecated), and _render_traceback_ is the custom IPython-specific semi-private API.

I know there's no real difference, but I think this way gives the wrong idea.

OK, I've done that.

minrk · 2012-07-30T21:52:10Z

I know it's technically adding a new API, but it seems like we should include this in 0.13.1 to avoid the inappropriate imports. Do you agree?

takluyver · 2012-07-30T22:05:00Z

Once we're confident it works, I think the flaw is significant enough to warrant backporting the fix, yes.

minrk · 2012-07-30T22:15:02Z

Do we want to add a test to catch this sort of thing in the future?

i.e. start a fresh subprocess IPython, and verify that 'numpy' and
'IPython.parallel/zmq' are not in sys.modules?

I don't remember what the state of our subprocess tests is.

… on startup.

takluyver · 2012-07-30T22:38:23Z

A subprocess test turned out to be pretty easy. I'm running test_pr now.

minrk · 2012-07-30T23:06:05Z

Test results for commit 464d50a merged into master
Platform: darwin

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

Not available for testing:

minrk · 2012-07-30T23:07:36Z

Great, then I think it should be good to go.

takluyver · 2012-07-30T23:58:57Z

I'll leave it overnight (my time) in case anyone else wants to look at it, then I'll merge tomorrow. Thanks for the review.

Carreau · 2012-07-31T08:14:17Z

docs/source/config/integrating.txt

+
+Both the notebook and the Qt console can display ``svg``, ``png`` and ``jpeg``
+representations. The notebook can also display ``html``, ``javascript``,
+``json`` and ``latex``. If the methods don't exist, or return ``None``, it falls


Out of curiosity, is there any example of something using display_json?

No, and it seems it doesn't actually work in the notebook. I'll take it out of the list.

we do have a display_json in IPython.display do we want to write a warning that not many frontend support it ?

takluyver · 2012-07-31T11:17:51Z

I've updated the docs.

Carreau · 2012-07-31T11:24:48Z

I'm ok with merging this.

About json, what is/was the use of it ?

takluyver · 2012-07-31T11:57:56Z

OK, I'll merge this now. Thanks.

I'm not sure about displaying json, but I think maybe it's the future tense we need - what will be the use of it?

Custom traceback API Closes gh-2221

Carreau · 2012-07-31T12:12:14Z

hum... to exchange data with widget, maybe, but then i wouldn't call it display_ ...
we'll see.

minrk · 2012-07-31T16:29:38Z

Pretty much every js widget I have written uses display_json.

Rather than special casing IPython.parallel errors (which led to issue #2221), this adds a simple API where exception classes can offer a custom traceback, by defining a `_render_traceback_(self)` method. It also adds some documentation on how third parties can integrate packages with IPython. 'Configuration & customisation' seemed the most natural home for this. We should remember to close #2221 when we merge this - I forgot to put it in a commit message.

* 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) ...

Custom traceback API Closes ipythongh-2221

takluyver added 2 commits July 30, 2012 21:10

Allow custom tracebacks for exception types with a _render_traceback_…

6c86c46

…() method.

Document ways of integrating objects with IPython.

2b342f1

minrk reviewed Jul 30, 2012
View reviewed changes

Switch round alias of render_traceback() method.

3c9e386

Add test that numpy, IPython.parallel and IPython.zmq aren't imported…

464d50a

… on startup.

Carreau reviewed Jul 31, 2012
View reviewed changes

Notebook does not support displaying JSON

61295bd

takluyver added a commit that referenced this pull request Jul 31, 2012

Merge pull request #2223 from takluyver/custom_traceback

06c27d8

Custom traceback API Closes gh-2221

takluyver merged commit 06c27d8 into ipython:master Jul 31, 2012

juliantaylor mentioned this pull request Aug 14, 2012

remote tracebacks broken since 952d0d6 (PR #2223) #2303

Closed

bfroehle mentioned this pull request Aug 18, 2012

RemoteError._render_traceback_ calls self.render_traceback #2305

Merged

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

Merge pull request ipython#2223 from takluyver/custom_traceback

958272e

Custom traceback API Closes ipythongh-2221

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom tracebacks #2223

Custom tracebacks #2223

takluyver commented Jul 30, 2012

minrk Jul 30, 2012

takluyver Jul 30, 2012

minrk commented Jul 30, 2012

takluyver commented Jul 30, 2012

minrk commented Jul 30, 2012

takluyver commented Jul 30, 2012

minrk commented Jul 30, 2012

minrk commented Jul 30, 2012

takluyver commented Jul 30, 2012

Carreau Jul 31, 2012

takluyver Jul 31, 2012

Carreau Jul 31, 2012

takluyver commented Jul 31, 2012

Carreau commented Jul 31, 2012

takluyver commented Jul 31, 2012

Carreau commented Jul 31, 2012

minrk commented Jul 31, 2012

Custom tracebacks #2223

Custom tracebacks #2223

Conversation

takluyver commented Jul 30, 2012

minrk Jul 30, 2012

Choose a reason for hiding this comment

takluyver Jul 30, 2012

Choose a reason for hiding this comment

minrk commented Jul 30, 2012

takluyver commented Jul 30, 2012

minrk commented Jul 30, 2012

takluyver commented Jul 30, 2012

minrk commented Jul 30, 2012

minrk commented Jul 30, 2012

takluyver commented Jul 30, 2012

Carreau Jul 31, 2012

Choose a reason for hiding this comment

takluyver Jul 31, 2012

Choose a reason for hiding this comment

Carreau Jul 31, 2012

Choose a reason for hiding this comment

takluyver commented Jul 31, 2012

Carreau commented Jul 31, 2012

takluyver commented Jul 31, 2012

Carreau commented Jul 31, 2012

minrk commented Jul 31, 2012