Allow REPL/Kernel to be embedded and share classes/variables with its caller #102
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I have been testing and using this for the past week and it works quite well, and allows some really powerful extensions to at least one Java GUI tool that I am using. The approach should be general enough that this also works for every other JVM project that wants to simply embed a kernel in its context. |
ileasile
reviewed
Sep 28, 2020
| @@ -83,6 +83,26 @@ class RuntimeKernelProperties(val map: Map<String, String>): ReplRuntimeProperti | |||
| } | |||
| } | |||
|
|
|||
| data class KernelCfgFile( | |||
There was a problem hiding this comment.
I think that name KernelJupyterParams fits better. Anyway, please rename this class to something without abbreviations
There was a problem hiding this comment.
Sounds like a good name, changed it.
This allows a Java application to create a Kotlin kernel based on the kernel-*.json and parameters. Otherwise it would have to create fake commandline arguments or parse the kernel-*.json itself
|
The testcases work for me locally, both |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently the Kotlin kernel supports something similar to IPython.start_kernel. This PR aims to support something that covers the use cases of IPython.embed_kernel.
What this PR provides
An application can now call
org.jetbrains.kotlin.jupyter.iKotlin.kernelServerdirectly and pass a desiredKernelConfigand the runtime properties where theembeddedproperty is set totrueand return theKernelConfigas a standard JSON to user in an application specific way.The user can then run
jupyter console --existing=path/to/kernelconfig.jsonto attach a Kotlin REPL to the kernel and run arbitrary Kotlin code inside the application context with the same state as the the application.What this PR does not allow
This does not allow attaching a Jupyter Notebook to the Kernel. This is a limitation of Jupyter Notebooks and not the Kotlin kernel.
Status
This should work already, but I'm currently still writing the actual embedding code for the application I want to use it in, so until then I still consider this PR a draft, but appreciate an feedback on the general idea and current implementation.
EDIT:
The first proof of concept for this already works and I think anything else I wanted to achieve is an issue with the application embedding the kernel. This embedding could be simplified by allowing the embedding Java Application to acess
defaultRuntimeProperties. I am also feeling unsure if the runtimeproperties is really the right place for the embedding option, and ifKernelArgs/KernelConfigwouldn't be a better place.