Using the new Comm Python package #3533

martinRenou · 2022-08-01T13:39:22Z

Related discussions:

Currently working on a Python comm package on https://github.com/martinRenou/comm for now, but it should probably be moved in the IPython org

This has the benefit of being able to:

remove the ipykernel dependency in ipywidgets Using the new Comm Python package #3533
remove the ipykernel monkey patch in xeus-python POC: Creation of a Comm Python package jupyter-xeus/xeus-python#548
remove the ipykernel package mock in jupyterlite's pyolite
remove the ipykernel package mock in emscripten-forge

github-actions · 2022-08-01T13:39:37Z

👈 Launch a binder notebook on branch martinRenou/ipywidgets/move_comm

python/ipywidgets/ipywidgets/__init__.py

maartenbreddels · 2022-10-21T13:42:08Z

python/ipywidgets/ipywidgets/widgets/widget.py

@@ -421,7 +421,7 @@ def get_view_spec(self):

    _view_count = Int(None, allow_none=True,
        help="EXPERIMENTAL: The number of views of the model displayed in the frontend. This attribute is experimental and may change or be removed in the future. None signifies that views will not be tracked. Set this to 0 to start tracking view creation/deletion.").tag(sync=True)
-    comm = Instance('ipykernel.comm.Comm', allow_none=True)


See #3602 for removing this as a trait.

SylvainCorlay · 2022-11-18T14:58:37Z

This has the benefit of being able to:

remove the ipykernel dependency in ipywidgets #3533
remove the ipykernel monkey patch in xeus-python jupyter-xeus/xeus-python#548
remove the ipykernel package mock in jupyterlite's pyolite
remove the ipykernel package mock in emscripten-forge

Wow. I think it is quite an improvement.

maartenbreddels

Great work.

I do worry we do not have a test yet that exposes ipython/ipykernel#1090

I'm pretty sure this fixes it, but #3653 also didn't pick up this issue, which leaves me a bit worries that we're vulnerable for regressions.

python/ipywidgets/ipywidgets/__init__.py

python/ipywidgets/ipywidgets/widgets/tests/utils.py

python/ipywidgets/ipywidgets/widgets/widget_output.py

martinRenou · 2023-02-10T12:34:54Z

Thanks a lot for your review @maartenbreddels ! I will resolve your comment and get the CI green hopefully :D

martinRenou · 2023-02-16T14:40:16Z

@maartenbreddels it was difficult to get green but now it seems good!

Thankfully, the Python 3.7 build requires an old version of ipykernel (latest ipykernel does not support 3.7?) so we have tests against the old versions and new versions.

martinRenou · 2023-03-16T13:09:06Z

Would you have time to make it a review @maartenbreddels ?

maartenbreddels

awesome work, some minor comments

python/ipywidgets/ipywidgets/__init__.py

maartenbreddels · 2023-03-16T15:51:59Z

python/ipywidgets/ipywidgets/widgets/tests/test_widget_templates.py

@@ -229,7 +229,7 @@ def test_update_dynamically(self, send_state): #pylint: disable=no-self-use
        assert box.layout.grid_template_areas == ('"top-left top-right"\n' +
                                                  '"bottom-left bottom-right"')
        # check whether frontend was informed
-        send_state.assert_called_once_with(key="grid_template_areas")
+        send_state.assert_called_with(key="grid_template_areas")


why is it not called once? is it called multiple times?

Yes, I think the test was faulty from the beginning. Though it's unclear to me as to why my PR fixes it.

Setting bottom_left would not only trigger changing grid_template_areas but also a couple more properties from layout

python/ipywidgets/ipywidgets/widgets/widget.py

python/ipywidgets/ipywidgets/widgets/widget_output.py

martinRenou · 2023-03-17T08:32:43Z

Thanks for the review! I resolved your comments

pllim · 2023-03-20T16:11:14Z

Hello. Is there a plan to merge and release this soon? We are seeing deprecation warning from stable version of ipykernel downstream. Thank you!

maartenbreddels · 2023-03-20T17:39:16Z

@martinRenou do you know what caused that change?
I'm fine removing the newlines, but maybe good to be aware what is responsible for this change?

Hello. Is there a plan to merge and release this soon?

Yes, I think we should get this released asap, which I could do tomorrow if we manage to get this in.

This test was supposed to fail, as setting the bottom_left value will trigger a ipywidgets.Layout.send_state on `child.layout.grid_area = position` (ipywidgets.widgets.widget_template.py L419) and on `self.layout.grid_template_areas = grid_template_areas_css` (ipywidgets.widgets.widget_template.py L448)

Co-authored-by: Maarten Breddels <maartenbreddels@gmail.com>

martinRenou · 2023-03-21T08:36:55Z

@maartenbreddels all green!

maartenbreddels · 2023-03-21T08:46:26Z

@martinRenou great work, i guess we also need to backport this to 7.x
do you want to try the bot?

martinRenou · 2023-03-21T09:08:32Z

@meeseeksdev please backport to 7.x

lumberbot-app · 2023-03-21T09:08:40Z

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

git checkout 7.x
git pull

Cherry pick the first parent branch of the this PR on top of the older branch:

git cherry-pick -x -m1 785d1598b38f6fb43917489f530d14e28876fc24

You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am 'Backport PR #3533: Using the new Comm Python package'

Push to a named branch:

git push YOURFORK 7.x:auto-backport-of-pr-3533-on-7.x

Create a PR against branch 7.x, I would have named this PR:

"Backport PR #3533 on branch 7.x (Using the new Comm Python package)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

* Move comm package * Fix wrongly written test This test was supposed to fail, as setting the bottom_left value will trigger a ipywidgets.Layout.send_state on `child.layout.grid_area = position` (ipywidgets.widgets.widget_template.py L419) and on `self.layout.grid_template_areas = grid_template_areas_css` (ipywidgets.widgets.widget_template.py L448) * Fix Python 3.7 test Co-authored-by: Maarten Breddels <maartenbreddels@gmail.com> (cherry picked from commit 785d159)

Backport #3720 and #3533 to 7.x

bollwyvl · 2023-03-21T20:06:37Z

If seeing errors like this in pytest:

    def _create_comm(*args, **kwargs):
        """Create a Comm.
    
        This method is intended to be replaced, so that it returns your Comm instance.
        """
>       raise NotImplementedError("Cannot ")
E       NotImplementedError: Cannot

Adding:

import ipykernel.ipkernel  # noqa

Is enough to trigger the side-effects to overload that manager.

Seems like it should go in the docs... or even in that unhelpful traceback itself, cuz 99% of the time, i reckon people are testing with ipykernel lying around.

- ModelManager features - import a spacy model created by DataManager - set metadata such as author, license, etc - publish the model to hugging face - add `test_model_manager` notebook with example of use - add `spacy-huggingface-hub` and `wheel` to dependencies also - refactor tests - simplify fixtures code in conftest.py - add `model_path` fixture to conftest.py - pin ipywidgets<8.0.5 for now to avoid test failures in CI - looks due to this change: jupyter-widgets/ipywidgets#3533

- ModelManager features - `load()` imports a spacy model created by DataManager - `metadata` dict exposes metadata the user should edit such as author, license, etc - `save()` saves changes (currently only the updated metadata can be changed) - `publish()` publishes the model to hugging face - add `test_model_manager` notebook with example of use - add `spacy-huggingface-hub` and `wheel` to dependencies also - refactor tests - simplify fixtures code in conftest.py - add `model_path` fixture to conftest.py that provides a trained spacy model - pin ipywidgets<8.0.5 for now to avoid test failures in CI - looks like it is due to this change: jupyter-widgets/ipywidgets#3533

This change is required by the upgrade of ipywidgets. jupyter-widgets/ipywidgets#3533 One of the changes in this new version is the removal of the dependency ipykernel, which we require to add it as explicit dependency.

This change is required by the release of ipywidgets at version 8.0.5. jupyter-widgets/ipywidgets#3533 One of the changes in this new version is the removal of the dependency ipykernel, which we would require to add it as explicit dependency. Due to potential breaking changes, we fix its maximum version below 8.0.5.

This was referenced Aug 1, 2022

POC: Creation of a Comm Python package jupyter-xeus/xeus-python#548

Closed

Extract the Comm Python package ipython/ipykernel#973

Merged

Remove ipykernel and IPython as dependencies #3514

Open

jtpio mentioned this pull request Aug 4, 2022

2022 Jupyter Widgets Dev Meetings jupyter-widgets/team-compass#13

Open

martinRenou mentioned this pull request Aug 8, 2022

Remove widgetsnbextension and ipywidgets recipes emscripten-forge/recipes#63

Closed

2 tasks

maartenbreddels reviewed Oct 21, 2022

View reviewed changes

python/ipywidgets/ipywidgets/__init__.py Show resolved Hide resolved

maartenbreddels reviewed Oct 21, 2022

View reviewed changes

jasongrout-db mentioned this pull request Oct 21, 2022

Jupyter Community Workshop - The Future of Jupyter Widgets [London] jupyter-widgets/team-compass#16

Open

martinRenou mentioned this pull request Oct 24, 2022

Transfer this repository under the IPython org? ipython/comm#1

Closed

martinRenou mentioned this pull request Feb 10, 2023

ipywidgets expects Comm, not BaseComm ipython/ipykernel#1090

Closed

martinRenou force-pushed the move_comm branch from 0f36487 to fb1aa4d Compare February 10, 2023 09:36

martinRenou changed the title ~~POC: Creation of a Comm Python package~~ Using the new Comm Python package Feb 10, 2023

maartenbreddels reviewed Feb 10, 2023

View reviewed changes

martinRenou force-pushed the move_comm branch 2 times, most recently from 81f707d to 822f93f Compare February 13, 2023 16:35

martinRenou requested a review from maartenbreddels February 16, 2023 10:15

martinRenou force-pushed the move_comm branch from 73b0187 to 647315d Compare February 16, 2023 14:26

martinRenou marked this pull request as ready for review February 16, 2023 14:40

martinRenou mentioned this pull request Feb 16, 2023

Deprecate Comm class + Fix incompatibility with ipywidgets ipython/ipykernel#1097

Merged

maartenbreddels reviewed Mar 16, 2023

View reviewed changes

martinRenou mentioned this pull request Mar 20, 2023

Replace deprecated ipykernel.comm.Comm #3723

Closed

pllim mentioned this pull request Mar 20, 2023

Refactor get subsets to work with composite subset state spacetelescope/jdaviz#2087

Merged

13 tasks

martinRenou and others added 5 commits March 21, 2023 09:21

Fix Python 3.7 test

4e5dd22

Code suggestions

2a31b38

Co-authored-by: Maarten Breddels <maartenbreddels@gmail.com>

Add comment

74ee640

Any

ad8ec43

martinRenou force-pushed the move_comm branch from 99348b3 to ad8ec43 Compare March 21, 2023 08:22

maartenbreddels merged commit 785d159 into jupyter-widgets:main Mar 21, 2023

martinRenou deleted the move_comm branch March 21, 2023 09:07

lumberbot-app bot added the Still Needs Manual Backport label Mar 21, 2023

martinRenou mentioned this pull request Mar 21, 2023

Backport #3720 and #3533 to 7.x #3726

Merged

martinRenou added a commit that referenced this pull request Mar 21, 2023

Merge pull request #3726 from martinRenou/backport_move_comm

9042d87

Backport #3720 and #3533 to 7.x

eccabay mentioned this pull request Mar 21, 2023

Pin ipywidgets under 8.0.5 alteryx/evalml#4098

Closed

martinRenou mentioned this pull request Mar 22, 2023

Move comm jupyter-xeus/xeus-python#585

Merged

AaronStiff mentioned this pull request Mar 22, 2023

ipywidgets=8.0.5 breaks FigureWidget plotly/plotly.py#4120

Closed

manzt mentioned this pull request Mar 22, 2023

next steps for MimeBundleDescriptor: custom messages / non-synchronized state manzt/anywidget#71

Closed

This was referenced Mar 23, 2023

%%bigquery ipython / jupyter notebook magics prerelease tests failing googleapis/python-bigquery#1530

Closed

With latest ipywidgets and IPython, get AttributeError: 'tqdm_notebook' object has no attribute 'disp' tqdm/tqdm#1453

Open

lkeegan mentioned this pull request Mar 24, 2023

add ModelManager ssciwr/moralization-analyzer#66

Merged

marcofavoritobi mentioned this pull request Mar 27, 2023

Chore/upgrade ipywidgets version bancaditalia/black-it#54

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Using the new Comm Python package #3533

Using the new Comm Python package #3533

martinRenou commented Aug 1, 2022 •

edited

github-actions bot commented Aug 1, 2022

maartenbreddels Oct 21, 2022

SylvainCorlay commented Nov 18, 2022

maartenbreddels left a comment

martinRenou commented Feb 10, 2023

martinRenou commented Feb 16, 2023

martinRenou commented Mar 16, 2023

maartenbreddels left a comment

maartenbreddels Mar 16, 2023

martinRenou Mar 17, 2023

martinRenou commented Mar 17, 2023

pllim commented Mar 20, 2023

maartenbreddels commented Mar 20, 2023

martinRenou commented Mar 21, 2023

maartenbreddels commented Mar 21, 2023

martinRenou commented Mar 21, 2023

lumberbot-app bot commented Mar 21, 2023

bollwyvl commented Mar 21, 2023

Using the new Comm Python package #3533

Using the new Comm Python package #3533

Conversation

martinRenou commented Aug 1, 2022 • edited

github-actions bot commented Aug 1, 2022

maartenbreddels Oct 21, 2022

Choose a reason for hiding this comment

SylvainCorlay commented Nov 18, 2022

maartenbreddels left a comment

Choose a reason for hiding this comment

martinRenou commented Feb 10, 2023

martinRenou commented Feb 16, 2023

martinRenou commented Mar 16, 2023

maartenbreddels left a comment

Choose a reason for hiding this comment

maartenbreddels Mar 16, 2023

Choose a reason for hiding this comment

martinRenou Mar 17, 2023

Choose a reason for hiding this comment

martinRenou commented Mar 17, 2023

pllim commented Mar 20, 2023

maartenbreddels commented Mar 20, 2023

martinRenou commented Mar 21, 2023

maartenbreddels commented Mar 21, 2023

martinRenou commented Mar 21, 2023

lumberbot-app bot commented Mar 21, 2023

bollwyvl commented Mar 21, 2023

martinRenou commented Aug 1, 2022 •

edited