Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DRAFT: Single widget manager per kernel #3922

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open

DRAFT: Single widget manager per kernel #3922

wants to merge 25 commits into from

Conversation

fleming79
Copy link

@fleming79 fleming79 commented May 27, 2024 •
edited
Loading

Replaces #3920.

Features:

  • Widgets can render anywhere the WidgetRenderer can be accessed (anywhere the global rendermime or clones work).
  • Correctly indicates when comms is disconnected.
  • Re-renders widgets when comms is restored.
  • Easier to manage and find widgets - the KernelWidgetManager.

Significant changes

  • The KernelWidgetManager is a single instance per kernel by the kernel ID.
  • The KernelWidgetManager stores and creates widgets.
  • The default rendermime will actively search for the [Kernel]WidgetManager that owns the widget model.
  • WidgetManager (not to be confused with KenelWidgetManager) has been re-purposed to track the renderers belonging to a session context and set the KernelWidgetManager when the kernel is loaded. WidgetManager informs the renderer that the [Kernel]WidgetManager is pending.
  • Re-rendering on demand.

Notebooks and Consoles can share widgets

image

When the notebook is closed ipwidgets takes over comms and re-renders the widget.

image

Shutting down the kernel breaks the connection (note the red paper clips)

image

Re-opening the notebook now gives a message

Model not found for this kernel: AppLayout(children=(HTML(value='<h1>Fictional World Weather</h1>', layout=Layout(grid_area='header', height='a…

image

@github-actions GitHub Actions
Copy link

Binder 👈 Launch a binder notebook on branch fleming79/ipywidgets/per-kernel-widget-manager

@fleming79 fleming79 mentioned this pull request Jun 8, 2024
Closed
Alan Fleming added 16 commits June 9, 2024 09:07
Per-kernel widget manager.
07ce11b
Add attachToRendermime function.
5bb3c52
Update lock file.
9452054
WidgetModel: set comm_live to false when comm closed and remove redun…
90e010f 
…dant comm_closed argument.
Improve ManagerBase_loadFromKernel
7715db9
Update jupyterlab_widgets package.json
f7c2dcf
Improved restoring widgets when opening and closing of notebooks.
9cd1b47
manager and render code refactoring.
fc3967c
Avoid generating a warning "Failed to fetch ipywidgets through the "j…
3819e7d 
…upyter.widget.control" comm channel ..." when loading a kernel where ipywidgets hasn't been imported yet.
WidgetModel.close - catch any error when closing comm to ensure closi…
b873722 
…ng runs to completion.
Improved manager logic and re-rendering when the kernel is re-connected.
b830b76
Added delays for getWidgetManager and get_model if the model isn't im…
a7a6d5f 
…mediately available.
Manager, WidgetManager and plugin refactoring (simplification) . Warn…
ab0c544 
…ing: some signature changes.
Change packaging workflow to jupyterlab~4.0.
658f151
WidgetManager - do nothing if rendermime is the global rendermime ins…
70864f9 
…tead of raising an error.
Fix not awaiting delay promise in get_model.
23d9b2b
@martinRenou martinRenou mentioned this pull request Sep 4, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@fleming79