IPython Widget #5754

blink1073 · 2015-12-27T13:28:01Z

Fixes #4582. Fixes #5111. Fixes #4940. Fixes #5219. Fixes jupyter/notebook#244.

Makes the nbagg canvas an IPython Widget. mpl.js is wrapped in a define() and installed as an nbextension alongside nbagg_mpl.js.

blink1073 · 2015-12-27T13:39:38Z

I'll back out the inadvertent changes to the UAT notebook in a subsequent commit. (done).

blink1073 · 2015-12-27T14:34:30Z

Added toolbar.

blink1073 · 2015-12-27T16:13:35Z

We can't install the nb extension from a wheel, so I'd recommend the following: check for the existence of the nb extension when importing backend_nbagg.py. If it does not exist, install it in the user directory. Provide a function to manually update the nb extension, and call that automatically when installing from source or from conda.

blink1073 · 2015-12-27T16:18:31Z

cc @ellisonbg @jdfreder @SylvainCorlay

blink1073 · 2015-12-27T16:44:34Z

The last commit implements the idea.

blink1073 · 2015-12-27T19:55:16Z

The UAT passes now, except for reshow, is that still needed @tacaswell?

blink1073 · 2015-12-27T20:13:37Z

Interact now works with nbagg (see demo above)!

blink1073 · 2015-12-27T20:28:10Z

Note to self: add an explicit "export" button instead of spitting out an image automatically when the widget is closed. (done).

blink1073 · 2015-12-27T20:57:26Z

lib/matplotlib/backend_bases.py

@@ -2148,7 +2148,8 @@ def print_figure(self, filename, dpi=None, facecolor='w', edgecolor='w',
        origfacecolor = self.figure.get_facecolor()
        origedgecolor = self.figure.get_edgecolor()

-        self.figure.dpi = dpi
+        if dpi != 'figure':


This avoids an error I saw.

FWIW: This was fixed recently by #5720 (in the exact same way).

jdfreder · 2015-12-29T17:11:17Z

Cool!

mdboom · 2015-12-29T18:38:14Z

lib/matplotlib/backends/backend_nbagg.py

@@ -98,6 +103,7 @@ def connection_info():
    'zoom_to_rect': 'fa fa-square-o icon-check-empty',
    'move': 'fa fa-arrows icon-move',
    'download': 'fa fa-floppy-o icon-save',
+    'export': 'fa fa-file-picture-o icon-picture',


Can you elaborate on what "export" does? It inserts a static image into the notebook?

Why is this preferable to the automatic replacement with a static image upon saving? Won't users often forget to push this button?

Yes, it inserts a static image into the notebook. I'm looking at this from the point of view where the canvas is one of many widgets in a gui, and you want explicit control over export behavior.

Maybe we should think about the name. Export makes me think of "save" - I guess this is a kind of "snapshot" type behaviour, right?

mdboom · 2015-12-29T18:48:27Z

This is very cool. Thanks for taking this on.

Fixes #244

I don't see how this relates. Maybe wrong issue number?

We can't install the nb extension from a wheel, so I'd recommend the following: check for the existence of the nb extension when importing backend_nbagg.py. If it does not exist, install it in the user directory. Provide a function to manually update the nb extension, and call that automatically when installing from source or from conda.

Can you elaborate on this? It seems to add a lot of complexity for reasons that are lost to me, as someone who hasn't really followed Jupyter/IPython widgets. How does this work in the context where the matplotlib package is installed system-wide?

blink1073 · 2015-12-30T00:21:14Z

@mdboom, I removed the reference to 244, I can't find the issue I had meant to put there, it was referring to the fact that you could not "print" events to the notebook (as is now shown in the demo above).

For reference, installing bqplot is a two-step process, you install the source, and then install the nbextension. For a system-wide install, this could be done once. A conda recipe could load the extension in the current enviroment. Wheels are not allowed to execute code on installation, they just move source around to known Python locations.

https://github.com/bloomberg/bqplot#installation

blink1073 · 2015-12-30T00:24:51Z

@mdboom, found it: jupyter/notebook#244

mdboom · 2015-12-30T15:15:14Z

Sorry, I still don't understand the need for the complexity of installing the Python code and Javascript code separately. Can't we get to the JavaScript code from where it's installed under the matplotlib package (as we do now)?

pelson · 2016-01-03T07:42:16Z

lib/matplotlib/backends/web_backend/nbagg_mpl.js


-mpl.find_output_cell = function(html_output) {


I'm glad to see the back of this function. 👍

pelson · 2016-01-03T07:44:17Z

Untested, but 👍 in principle. Now that we are benefiting from hooking into the widget framework, do we also get a plot when the notebook page is refreshed? It might be worth going through the UATs and adding a refresh test.

ngoldbaum · 2016-01-20T20:30:14Z

Just want to say that this is awesome, I'm glad progress is being made on #5111.

jdfreder · 2016-01-21T00:22:23Z

@mdboom I think you're interested in what I've proposed here: jupyter/notebook#116

mdboom · 2016-01-21T15:00:19Z

@jdfreder: Thanks for the pointer. Indeed, it looks at first glance that jupyter/notebook#116 is moving in the direction that would really help us here. (It also helps me understand all the gory details and opposing requirements much better).

izaid · 2016-04-28T16:43:19Z

Hey all. And directly pinging @blink1073 @SylvainCorlay @mdboom.

I'd really like to see this get merged into Matplotlib. I understand there are issues on the Jupyter side that may be holding this up.

I can devote some of my time (on the order of days, if necessary) to get this resolved. Can someone tell me what needs to be done and what I can do to move things forward?

tacaswell · 2016-04-28T17:10:31Z

Did jupyter settle how to do package and distribute the js side of the widgets?

izaid · 2016-04-28T17:32:23Z

@tacaswell I don't know the answer to that, and I'm not sure who to ask. Pinging @SylvainCorlay again (sorry), because I think he knows. I just want to volunteer my time and effort to finish this, and need some direction on what needs to be done.

If the packaging isn't solved, can we not just merge this as is and have a follow-up PR for that?

blink1073 · 2016-05-02T15:45:28Z

@SylvainCorlay, I am actually at a loss at the moment. I'm going to have to leave this to you.

blink1073 · 2016-05-02T15:47:58Z

I thought I had it working at one point, but I've spent all morning on this and have not gotten it figured out.

izaid · 2016-05-02T16:21:38Z

Yeah, I'm stumped here too. @SylvainCorlay, if you can drop in and save the day, that would be really cool.

blink1073 · 2016-05-02T16:39:06Z

Okay, I've almost got it sorted.

blink1073 · 2016-05-02T16:55:03Z

The latest change allows it to work, but the extension needs to installed on a per environment basis and enabled for the user in order to allow different versions per environment IIUC.

izaid · 2016-05-02T17:52:07Z

I just confirmed that it works on my local version of Jupyter 4.2. This is really great, thanks for picking this up again!

Re: Local installation. Isn't that the model for Jupyter now?

izaid · 2016-05-04T17:23:02Z

@tacaswell @blink1073 So, I've been using this branch for a few days now, and my understanding is it is done. Any chance we can get this merged into master? I wouldn't mind building a few things on top of it, but I'd rather do that after merge in separate, unrelated PRs.

blink1073 · 2016-05-04T17:34:25Z

I agree, this should be good to go.

tacaswell · 2016-05-04T17:55:50Z

I am going to merge this on the good word of @blink1073 .

tacaswell · 2016-05-04T17:57:19Z

If people were doing things in the notebook which relied on the previous version of the js we shipped we will re-address adding it back.

blink1073 · 2016-05-04T18:11:43Z

🎉

izaid · 2016-05-04T18:13:16Z

This is actually a pretty big deal -- we can arrange plots in the IPython notebook now. Great work, @blink1073!

danielballan · 2016-05-04T18:19:24Z

👏

ngoldbaum · 2016-05-04T18:21:20Z

and callbacks that raise exceptions no longer get silently ignored 💯

fperez · 2016-05-05T01:12:57Z

Thanks everyone!! 🎉

…get" This reverts commit 9c100c9, reversing changes made to 6bed1be. The reason for doing this is that ipywidgets is still moving much too fast for Matplotlib to keep up with. The original work done in matplotlib#5754 was done against ipywidgets v4, as of now the final touches are being put on v7. We are reverting back to our old inject-into-the-DOM method from `nbagg`, which is what is used by `%matplotlib notebook`. For embedding as a 'proper' widget use ipympl (github.com/matplotlib/jupyter-wigets) which will release on a schedule that matches the upstream jupyter ecosystem. closes matplotlib#7695

Revert "Merge pull request #5754 from blink1073/ipython-widget"

These files were moved as part of matplotlib#5754 which was reverted in matplotlib#9027, however matplotlib#6370 fixed the paths, but was not also reverted. Putting the js files in sub-directory makes sense, move the files rather than revert the changes in matplotlib#6370. fixes matplotlib#9380

tacaswell added the status: needs review label Dec 27, 2015

blink1073 mentioned this pull request Dec 27, 2015

Cannot use interact with matplotlib figures that are updated in-place ipython/ipython#7520

Open

blink1073 reviewed Dec 27, 2015
View reviewed changes

mdboom reviewed Dec 29, 2015
View reviewed changes

mdboom mentioned this pull request Dec 30, 2015

Improving 4.x nbextensions jupyter/notebook#878

Closed

pelson reviewed Jan 3, 2016
View reviewed changes

mdboom mentioned this pull request Jan 29, 2016

Figures in the notebook backend are too large following DPI changes #5945

Closed

tacaswell added this to the 2.1 (next point release) milestone Jan 29, 2016

Clean up the includes

de652b7

Update the package data

1ec611a

QuLogic added the GUI: nbagg label May 2, 2016

blink1073 changed the title ~~[WIP] IPython Widget~~ IPython Widget May 4, 2016

tacaswell merged commit 9c100c9 into matplotlib:master May 4, 2016

tacaswell removed the status: needs review label May 4, 2016

blink1073 mentioned this pull request May 4, 2016

Print events from matplotlib event handlers get swallowed jupyter/notebook#244

Closed

izaid mentioned this pull request May 12, 2016

Matplotlib Jupyter widget follow-up #6414

Closed

jenshnielsen mentioned this pull request May 21, 2016

Notebook backend not working #6454

Closed

francisco-dlp mentioned this pull request May 19, 2017

IPywidgets UI hyperspy/hyperspy#1544

Merged

92 tasks

tacaswell mentioned this pull request Aug 13, 2017

Revert "Merge pull request #5754 from blink1073/ipython-widget" #9027

Merged

6 tasks

dopplershift added a commit that referenced this pull request Aug 14, 2017

Merge pull request #9027 from tacaswell/api_revert_ipywidget_work

3045391

Revert "Merge pull request #5754 from blink1073/ipython-widget"

anntzer mentioned this pull request Oct 12, 2017

Cannot import pyplot. NameError: 'FigureManagerWebAgg' is not defined #9380

Closed


		mpl.find_output_cell = function(html_output) {

IPython Widget #5754

IPython Widget #5754

Conversation

blink1073 commented Dec 27, 2015

blink1073 commented Dec 27, 2015

blink1073 commented Dec 27, 2015

blink1073 commented Dec 27, 2015

blink1073 commented Dec 27, 2015

blink1073 commented Dec 27, 2015

blink1073 commented Dec 27, 2015

blink1073 commented Dec 27, 2015

blink1073 commented Dec 27, 2015

blink1073 Dec 27, 2015

Choose a reason for hiding this comment

mdboom Dec 29, 2015

Choose a reason for hiding this comment

jdfreder commented Dec 29, 2015

mdboom Dec 29, 2015

Choose a reason for hiding this comment

mdboom Dec 29, 2015

Choose a reason for hiding this comment

blink1073 Dec 30, 2015

Choose a reason for hiding this comment

pelson Jan 3, 2016

Choose a reason for hiding this comment

mdboom commented Dec 29, 2015

blink1073 commented Dec 30, 2015

blink1073 commented Dec 30, 2015

mdboom commented Dec 30, 2015

pelson Jan 3, 2016

Choose a reason for hiding this comment

pelson commented Jan 3, 2016

ngoldbaum commented Jan 20, 2016

jdfreder commented Jan 21, 2016

mdboom commented Jan 21, 2016

izaid commented Apr 28, 2016

tacaswell commented Apr 28, 2016

izaid commented Apr 28, 2016

blink1073 commented May 2, 2016

blink1073 commented May 2, 2016

izaid commented May 2, 2016

blink1073 commented May 2, 2016

blink1073 commented May 2, 2016 • edited

izaid commented May 2, 2016

izaid commented May 4, 2016

blink1073 commented May 4, 2016

tacaswell commented May 4, 2016

tacaswell commented May 4, 2016

blink1073 commented May 4, 2016

izaid commented May 4, 2016

danielballan commented May 4, 2016

ngoldbaum commented May 4, 2016

fperez commented May 5, 2016

blink1073 commented May 2, 2016 •

edited