Parameterized kernel specs #16487

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

AnastasiaSliusar wants to merge 34 commits into jupyterlab:main from AnastasiaSliusar:parameterized-kernel-specs

Contributor

AnastasiaSliusar commented Jun 14, 2024 •

edited

Loading

References

This work is in progress as JEP jupyter/enhancement-proposals#87.
This PR should be reviewed when the JEP has been accepted

Code changes

There are next changes in:

Notebook extension
Console extension

User-facing changes

When a user clicks on some kernel on Notebook section on Launch panel and that kernel includes custom kernel spec variables that will be used for customization then a user will see the dialog which will suggest to configure the kernel.
When a user has run a kernel and then they wants to change on another kernel, then the user can call another dialog window where they can select a kernel and if this kernel includes custom kernel spec variables the user will be suggested to configure that kernel.
When a user clicks on some kernel on Console section on Launch panel then the user will see the same dialog with suggestions to configure a kernel.
If a user does not select anything and then they run a kernel, and a kernel spec file includes default values then default values will be taken.
If a user does not select anything and then they run a kernel, and a kernel spec file does not include default values and there are kernel variables (for example, "{raw}" in the demo video) inside kernel.json file then these variables will be cleaned and a kernel will be run without them.

Demo video: https://drive.google.com/file/d/16kPyPoowsewuYkj1-3t6q6d-5G23fsQH/view?usp=sharing

How to run

Please use this PR with next PRs together:
Parameterized kernel specs jupyter-server/jupyter_server#1431
Parameterized kernel specs jupyter/jupyter_client#1028

AnastasiaSliusar added 21 commits

April 30, 2024 22:32


          Add dialog for kernel custom specs

04176cf


          Fix dialog, pass custom kernel spec to backend

f21e44b


          Merge branch 'jupyterlab:main' into parameterized-kernel-specs

e7bac9a


          Updte forms for seting custom kernel specs

f45d64e


          Add validation

53d6ba9


          Update a form and update data if there is no error

39eddd1


          fix form and validation


          Fix starting kernels

6961eb5


          Set custom kernel variables into metadata

4fe58f6


          Fix running a kernel by using metadata with custom kernel specs

6a27c01


          Fix saving custom kernel params into metadata

0272d69


          Setup a dialog window to a Console panel on Launcher

493f05d


          Running a console with a kernel, fix a dialog window

5fa63a6


          Fix showing part of a dialog when a kernel is selected by default

939d34b


          Add fixes to a dialog

42f54bd


          Fix a dialog window for selecting a kernel

df6e8f4


          Merge branch 'main' into parameterized-kernel-specs

bfdf0c1


          Fix selecting parameterized kernels

434718f


          Clean console.log and console.dir

fcfc13d


          Merge branch 'main' into parameterized-kernel-specs


          minor fix

jupyterlab-probot bot commented Jun 14, 2024

Thanks for making a pull request to jupyterlab!
To try out this branch on binder, follow this link:


          [pre-commit.ci] auto fixes from pre-commit.com hooks

05c32ca

for more information, see https://pre-commit.ci

github-actions bot assigned AnastasiaSliusar

github-actions bot added pkg:notebook pkg:console pkg:docregistry pkg:services pkg:apputils pkg:docmanager labels

github-actions bot added the pkg:ui-components label

This was referenced Jun 14, 2024

Parameterized kernel specs jupyter-server/jupyter_server#1431

Draft

Parameterized kernel specs jupyter/jupyter_client#1028

Draft

github-actions bot and others added 2 commits

June 14, 2024 21:40


          Automatic application of license header

398b819


          Fix pre-commit errors

1501b2b

github-actions bot removed the pkg:docmanager label

krassowski added the feature label

krassowski mentioned this pull request

4.3 Release Plan #16315

Closed

18 tasks

AnastasiaSliusar and others added 3 commits

June 21, 2024 14:48


          Fix updating launch parameters when a new kernel is selected

3de9803


          Remove saving a user kernel custom selection into notebook metadata

9cbb5e1


          [pre-commit.ci] auto fixes from pre-commit.com hooks

2cd96b5

for more information, see https://pre-commit.ci

krassowski mentioned this pull request

Issue patching SessionConnection class in extension after moving to pip based install #16513

Closed

AnastasiaSliusar added 4 commits

June 26, 2024 16:36


          Add condition when a dialog should be shown

e852ee9


          Merge branch 'parameterized-kernel-specs' of https://github.com/Anast…

562e9dc

…asiaSliusar/jupyterlab into parameterized-kernel-specs


          fix showing a dialog when a kernel spec file are secure and insecure

c48f438


          Fix showing a dialog from console when kernel spec files are filtered

7f07a5d

AnastasiaSliusar mentioned this pull request

Parameterized kernel specs proposal jupyter/enhancement-proposals#87

Open

krassowski added this to the 4.4.0 milestone

AnastasiaSliusar mentioned this pull request

Add allow_insecure_kernelspec_params to page config jupyterlab/jupyterlab_server#460

Draft

AnastasiaSliusar and others added 3 commits

August 12, 2024 13:06


          Resolve conflicts

80d8944


          Fix showing the dialog part for setuping kernel custom params


          [pre-commit.ci] auto fixes from pre-commit.com hooks

8baa65c

for more information, see https://pre-commit.ci

github-advanced-security bot found potential problems

View reviewed changes

packages/apputils/src/sessioncontext.tsx

    
                  if (model) {

                    await sessionContext.changeKernel(model);

                    if (hasCheckbox && result.isChecked !== null) {

                      if (model && sessionContext.kernelPreference?.customKernelSpecs) {

Check warning

Code scanning / CodeQL

Useless conditional

This use of variable 'model' always evaluates to true.

packages/apputils/src/sessioncontext.tsx

    
                        sessionContext.kernelPreference.customKernelSpecs = undefined;

                      }

                      if (model && dialogResult.custom_kernel_specs) {

Check warning

Code scanning / CodeQL

Useless conditional

This use of variable 'model' always evaluates to true.

packages/apputils/src/sessioncontext.tsx

    
                      };

                    }

                    if (model === null && !sessionContext.hasNoKernel) {

Check warning

Code scanning / CodeQL

Comparison between inconvertible types

Variable 'model' is of type object, but it is compared to [an expression](1) of type null.

packages/apputils/src/sessioncontext.tsx

    
                    if (model === null && !sessionContext.hasNoKernel) {

                      return sessionContext.shutdown();

                    }

                    if (model) {

Check warning

Code scanning / CodeQL

Useless conditional

This use of variable 'model' always evaluates to true.

github-advanced-security bot found potential problems

View reviewed changes

packages/apputils/src/sessioncontext.tsx

    
                  if (model) {

                    await sessionContext.changeKernel(model);

                    if (hasCheckbox && result.isChecked !== null) {

                      if (model && sessionContext.kernelPreference?.customKernelSpecs) {

Check warning

Code scanning / CodeQL

Useless conditional

This use of variable 'model' always evaluates to true.

packages/apputils/src/sessioncontext.tsx

    
                        sessionContext.kernelPreference.customKernelSpecs = undefined;

                      }

                      if (model && dialogResult.custom_kernel_specs) {

Check warning

Code scanning / CodeQL

Useless conditional

This use of variable 'model' always evaluates to true.

packages/apputils/src/sessioncontext.tsx

    
                      };

                    }

                    if (model === null && !sessionContext.hasNoKernel) {

Check warning

Code scanning / CodeQL

Comparison between inconvertible types

Variable 'model' is of type object, but it is compared to [an expression](1) of type null.

packages/apputils/src/sessioncontext.tsx

    
                    if (model === null && !sessionContext.hasNoKernel) {

                      return sessionContext.shutdown();

                    }

                    if (model) {

Check warning

Code scanning / CodeQL

Useless conditional

This use of variable 'model' always evaluates to true.

jtpio modified the milestones: 4.4.0, 4.5.0

jtpio modified the milestones: 4.5.0, 4.6.0

pr-triage-board bot added this to PR triage (experimental)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature pkg:apputils pkg:console pkg:docregistry pkg:notebook pkg:services pkg:ui-components