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.

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

New JupyterLab API for spawning kernels has a different config option name for which kernel to spawn #349

Open
rkevin-arch opened this issue Jan 15, 2021 · 2 comments
Assignees
Labels
Milestone

Comments

@rkevin-arch
Copy link
Contributor

Describe the bug

The commit 11ff270 (in PR #268) updated the APIs we use to spawn a kernel in Jupyter. We were using Session.startNew, but are now using kernelManager.startNew to spawn the kernel.

The new API uses name to refer towhich kernel should be spawned, but the old API uses kernelName for this purpose.

This means that using kernelOptions.kernelName to specify which kernel to use in a Thebe config will be ignored in Thebe 0.6.0 and above. Instead, users should use kernelOptions.name.

To Reproduce

Here's a sample HTML file that reproduces this issue. If Thebe version is 0.5.1 and we use kernelName: "ir", it works. If Thebe version is 0.6.0 and we use kernelName: "ir", it doesn't work. If Thebe version is 0.6.0 and we use name: "ir", it works.

Expected behavior

We should do one of the following:

  1. Update documentation, saying that 0.6.0 is a breaking change and you should change the kernelName config option to name
  2. Add some logic in our code to use kernelName as name if a name field is not defined, to maintain backwards compatibility.
@welcome
Copy link

welcome bot commented Jan 15, 2021

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@stevejpurves
Copy link
Collaborator

stevejpurves commented Feb 21, 2023

Update on this. In thebe 0.9.x, thebe-core has switched back to using the SessionManager, so kernelName remains a relevant parameter and should be maintained.

Suggestion 2) in the OP is the preferred way to go in that case.

Tracking modifications on both release branches in #595

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants