Process libraries from resolved classpath

Author: ileasile

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/api.kt

@@ -1,5 +1,12 @@
 package org.jetbrains.kotlinx.jupyter.api
 
+import org.jetbrains.kotlinx.jupyter.api.libraries.CodeExecution
+import org.jetbrains.kotlinx.jupyter.api.libraries.Execution
+import org.jetbrains.kotlinx.jupyter.api.libraries.LibraryDefinition
+
+typealias TypeName = String
+typealias Code = String
+
 /**
  * Single evaluated notebook cell representation
  */

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/libraries/CodeExecution.kt

@@ -0,0 +1,18 @@
+package org.jetbrains.kotlinx.jupyter.api.libraries
+
+import kotlinx.serialization.Serializable
+import org.jetbrains.kotlinx.jupyter.api.Code
+import org.jetbrains.kotlinx.jupyter.api.KotlinKernelHost
+import org.jetbrains.kotlinx.jupyter.util.CodeExecutionSerializer
+import org.jetbrains.kotlinx.jupyter.util.replaceVariables
+
+@Serializable(with = CodeExecutionSerializer::class)
+class CodeExecution(val code: Code) : Execution {
+    override fun execute(host: KotlinKernelHost): Any? {
+        return host.execute(code)
+    }
+
+    override fun replaceVariables(mapping: Map<String, String>): CodeExecution {
+        return CodeExecution(replaceVariables(code, mapping))
+    }
+}

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/libraries/Execution.kt

@@ -0,0 +1,9 @@
+package org.jetbrains.kotlinx.jupyter.api.libraries
+
+import org.jetbrains.kotlinx.jupyter.api.KotlinKernelHost
+
+fun interface Execution : VariablesSubstitutionAware<Execution> {
+    fun execute(host: KotlinKernelHost): Any?
+
+    override fun replaceVariables(mapping: Map<String, String>): Execution = this
+}

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/libraries/FunctionalLibraryDefinition.kt

@@ -0,0 +1,44 @@
+package org.jetbrains.kotlinx.jupyter.api.libraries
+
+import org.jetbrains.kotlinx.jupyter.api.AlwaysRendererTypeHandler
+import org.jetbrains.kotlinx.jupyter.api.KotlinKernelHost
+import org.jetbrains.kotlinx.jupyter.api.RendererTypeHandler
+
+open class FunctionalLibraryDefinition(
+    override val repositories: List<String> = emptyList(),
+    override val dependencies: List<String> = emptyList(),
+    override val imports: List<String> = emptyList(),
+) : LibraryDefinition {
+    open fun onInit(host: KotlinKernelHost): Any? {
+        return Unit
+    }
+    open fun onCellInit(host: KotlinKernelHost): Any? {
+        return Unit
+    }
+    open fun onShutdown(host: KotlinKernelHost): Any? {
+        return Unit
+    }
+    open fun render(host: KotlinKernelHost, value: Any?, resultFieldName: String?): Any? {
+        return value
+    }
+
+    override val init: List<Execution> by lazy {
+        listOf(Execution(::onInit))
+    }
+
+    override val initCell: List<Execution> by lazy {
+        listOf(Execution(::onCellInit))
+    }
+
+    override val shutdown: List<Execution> by lazy {
+        listOf(Execution(::onShutdown))
+    }
+
+    override val renderers: List<RendererTypeHandler> by lazy {
+        listOf(
+            AlwaysRendererTypeHandler { host, value, fieldName ->
+                KotlinKernelHost.Result(render(host, value, fieldName), null)
+            }
+        )
+    }
+}

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/libraries/LibraryDefinition.kt

@@ -0,0 +1,49 @@
+package org.jetbrains.kotlinx.jupyter.api.libraries
+
+import org.jetbrains.kotlinx.jupyter.api.GenerativeTypeHandler
+import org.jetbrains.kotlinx.jupyter.api.RendererTypeHandler
+
+interface LibraryDefinition {
+    /**
+     * List of artifact dependencies in gradle colon-separated format
+     */
+    val dependencies: List<String>
+        get() = emptyList()
+
+    /**
+     * List of repository URLs to resolve dependencies in
+     */
+    val repositories: List<String>
+        get() = emptyList()
+
+    /**
+     * List of imports: simple and star imports are both allowed
+     */
+    val imports: List<String>
+        get() = emptyList()
+
+    /**
+     * List of code snippets evaluated on library initialization
+     */
+    val init: List<Execution>
+        get() = emptyList()
+
+    /**
+     * List of code snippets evaluated before every cell evaluation
+     */
+    val initCell: List<Execution>
+        get() = emptyList()
+
+    /**
+     * List of code snippets evaluated on kernel shutdown
+     */
+    val shutdown: List<Execution>
+        get() = emptyList()
+
+    val renderers: List<RendererTypeHandler>
+        get() = emptyList()
+    val converters: List<GenerativeTypeHandler>
+        get() = emptyList()
+    val annotations: List<GenerativeTypeHandler>
+        get() = emptyList()
+}

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/libraries/LibraryDefinitionImpl.kt

@@ -0,0 +1,16 @@
+package org.jetbrains.kotlinx.jupyter.api.libraries
+
+import org.jetbrains.kotlinx.jupyter.api.GenerativeTypeHandler
+import org.jetbrains.kotlinx.jupyter.api.RendererTypeHandler
+
+class LibraryDefinitionImpl(
+    override val dependencies: List<String> = emptyList(),
+    override val repositories: List<String> = emptyList(),
+    override val imports: List<String> = emptyList(),
+    override val init: List<Execution> = emptyList(),
+    override val initCell: List<Execution> = emptyList(),
+    override val shutdown: List<Execution> = emptyList(),
+    override val renderers: List<RendererTypeHandler> = emptyList(),
+    override val converters: List<GenerativeTypeHandler> = emptyList(),
+    override val annotations: List<GenerativeTypeHandler> = emptyList(),
+) : LibraryDefinition

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/libraries/LibraryDefinitionProducer.kt

@@ -0,0 +1,7 @@
+package org.jetbrains.kotlinx.jupyter.api.libraries
+
+import org.jetbrains.kotlinx.jupyter.api.Notebook
+
+interface LibraryDefinitionProducer {
+    fun getDefinitions(notebook: Notebook<*>?): List<LibraryDefinition>
+}

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/libraries/VariablesSubstitutionAware.kt

@@ -0,0 +1,5 @@
+package org.jetbrains.kotlinx.jupyter.api.libraries
+
+interface VariablesSubstitutionAware<out T> {
+    fun replaceVariables(mapping: Map<String, String>): T
+}

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/libraryConnection.kt

@@ -1,17 +1,18 @@
 package org.jetbrains.kotlinx.jupyter.api
 
 import kotlinx.serialization.Serializable
+import org.jetbrains.kotlinx.jupyter.api.libraries.VariablesSubstitutionAware
 import org.jetbrains.kotlinx.jupyter.util.TypeHandlerCodeExecutionSerializer
 import org.jetbrains.kotlinx.jupyter.util.replaceVariables
 import kotlin.reflect.KClass
 
-fun interface TypeHandlerExecution : VariablesSubstitutionAvailable<TypeHandlerExecution> {
+fun interface TypeHandlerExecution : VariablesSubstitutionAware<TypeHandlerExecution> {
     fun execute(host: KotlinKernelHost, value: Any?, resultFieldName: String?): KotlinKernelHost.Result
 
     override fun replaceVariables(mapping: Map<String, String>): TypeHandlerExecution = this
 }
 
-interface RendererTypeHandler : VariablesSubstitutionAvailable<RendererTypeHandler> {
+interface RendererTypeHandler : VariablesSubstitutionAware<RendererTypeHandler> {
     fun acceptsType(type: KClass<*>): Boolean
 
     val execution: TypeHandlerExecution
@@ -46,7 +47,7 @@ class ExactRendererTypeHandler(val className: TypeName, override val execution:
 }
 
 @Serializable
-class GenerativeTypeHandler(val className: TypeName, val code: Code) : VariablesSubstitutionAvailable<GenerativeTypeHandler> {
+class GenerativeTypeHandler(val className: TypeName, val code: Code) : VariablesSubstitutionAware<GenerativeTypeHandler> {
     override fun replaceVariables(mapping: Map<String, String>): GenerativeTypeHandler {
         return GenerativeTypeHandler(className, replaceVariables(code, mapping))
     }

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/api/typeHandlers.kt

@@ -1,6 +1,6 @@
 package org.jetbrains.kotlinx.jupyter.util
 
-import org.jetbrains.kotlinx.jupyter.api.VariablesSubstitutionAvailable
+import org.jetbrains.kotlinx.jupyter.api.libraries.VariablesSubstitutionAware
 
 fun replaceVariables(str: String, mapping: Map<String, String>) =
     mapping.asSequence().fold(str) { s, template ->
@@ -11,4 +11,4 @@ fun replaceVariables(str: String, mapping: Map<String, String>) =
 fun Iterable<String>.replaceVariables(mapping: Map<String, String>) = map { replaceVariables(it, mapping) }
 
 @JvmName("replaceVariablesExecution")
-fun <T : VariablesSubstitutionAvailable<T>> Iterable<T>.replaceVariables(mapping: Map<String, String>) = map { it.replaceVariables(mapping) }
+fun <T : VariablesSubstitutionAware<T>> Iterable<T>.replaceVariables(mapping: Map<String, String>) = map { it.replaceVariables(mapping) }

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/util/libraryProcessing.kt

@@ -8,10 +8,10 @@ import kotlinx.serialization.encoding.Decoder
 import kotlinx.serialization.encoding.Encoder
 import kotlinx.serialization.serializer
 import org.jetbrains.kotlinx.jupyter.api.Code
-import org.jetbrains.kotlinx.jupyter.api.CodeExecution
 import org.jetbrains.kotlinx.jupyter.api.ExactRendererTypeHandler
 import org.jetbrains.kotlinx.jupyter.api.GenerativeTypeHandler
 import org.jetbrains.kotlinx.jupyter.api.TypeHandlerCodeExecution
+import org.jetbrains.kotlinx.jupyter.api.libraries.CodeExecution
 import kotlin.reflect.KClass
 import kotlin.reflect.KProperty1
 

jupyter-lib/api/src/main/kotlin/org/jetbrains/kotlinx/jupyter/util/serializers.kt

@@ -1,8 +1,8 @@
 package jupyter.kotlin
 
-import org.jetbrains.kotlinx.jupyter.api.CodeExecution
 import org.jetbrains.kotlinx.jupyter.api.Notebook
 import org.jetbrains.kotlinx.jupyter.api.ResultsAccessor
+import org.jetbrains.kotlinx.jupyter.api.libraries.CodeExecution
 
 abstract class ScriptTemplateWithDisplayHelpers(
     val notebook: Notebook<*>,

jupyter-lib/lib/src/main/kotlin/jupyter/kotlin/ScriptTemplateWithDisplayHelpers.kt

@@ -11,4 +11,5 @@ val defaultRepositories = arrayOf(
 val defaultGlobalImports = listOf(
     "kotlin.math.*",
     "org.jetbrains.kotlinx.jupyter.api.*",
+    "org.jetbrains.kotlinx.jupyter.api.libraries.*",
 )

jupyter-lib/shared-compiler/src/main/kotlin/org/jetbrains/kotlinx/jupyter/config/defaultImports.kt

@@ -1,7 +1,8 @@
 package org.jetbrains.kotlinx.jupyter.libraries
 
 import org.jetbrains.kotlinx.jupyter.api.KotlinKernelVersion
-import org.jetbrains.kotlinx.jupyter.api.LibraryDefinitionProducer
+import org.jetbrains.kotlinx.jupyter.api.libraries.LibraryDefinitionImpl
+import org.jetbrains.kotlinx.jupyter.api.libraries.LibraryDefinitionProducer
 import org.jetbrains.kotlinx.jupyter.compiler.util.ReplCompilerException
 import org.jetbrains.kotlinx.jupyter.util.replaceVariables