Jupyter connection socket types. You can find information about each Jupyter socket type here: https://jupyter-client.readthedocs.io/en/stable/messaging.html#introduction

KernelRepository

@Serializable(with = KernelRepositorySerializer::class)

data class KernelRepository(val path: String, val username: String? = null, val password: String? = null) : VariablesSubstitutionAware<KernelRepository> , Comparable<KernelRepository>

LibrariesDefinitionDeclaration

@Serializable

data class LibrariesDefinitionDeclaration(val fqn: TypeName) : LibrariesInstantiable<LibraryDefinition>

Declaration of LibraryDefinition implementor

LibrariesInstantiable

interface LibrariesInstantiable<T>

Entity inside library that may be instantiated to an object of type T

LibrariesProducerDeclaration

@Serializable

data class LibrariesProducerDeclaration(val fqn: TypeName) : LibrariesInstantiable<LibraryDefinitionProducer>

Declaration of LibraryDefinitionProducer implementor

LibrariesScanResult

@Serializable

data class LibrariesScanResult(val definitions: List<LibrariesDefinitionDeclaration> = emptyList(), val producers: List<LibrariesProducerDeclaration> = emptyList())

Serialized form of this class instance is a correct content of KOTLIN_JUPYTER_LIBRARIES_FILE_NAME file, and vice versa.

LibraryCacheable

interface LibraryCacheable

LibraryDefinition

interface LibraryDefinition

Library definition represents "library" concept in Kotlin kernel.

LibraryDefinitionImpl

class LibraryDefinitionImpl : LibraryDefinition

Trivial implementation of LibraryDefinition - simple container.

LibraryDefinitionProducer

interface LibraryDefinitionProducer

LibraryDefinitionProducer may produce several library definitions. You may want produce or not produce definitions based on kernel, Kotlin or JRE version, or some other info provided by Notebook

LibraryReference

data class LibraryReference(val info: LibraryResolutionInfo, val name: String? = null) : LibraryCacheable

LibraryResolutionInfo

interface LibraryResolutionInfo : LibraryCacheable

Implementations of this class provide information on how the libraries should be resolved. Different implementations of LibraryResolver use this information for adjusting the resolution process. Resolution info is encoded by a part of a LibraryReference that goes after @ character

LibraryResolutionRequest

class LibraryResolutionRequest(val reference: LibraryReference, val arguments: List<Variable>, val definition: LibraryDefinition)

LibraryResource

@Serializable

data class LibraryResource(val bundles: List<ResourceFallbacksBundle>, val type: ResourceType, val name: String) : VariablesSubstitutionAware<LibraryResource>

MavenRepositoryConfigurationScope

interface MavenRepositoryConfigurationScope

RawMessage

interface RawMessage

Raw Jupyter message.

RawMessageAction

typealias RawMessageAction = (RawMessage) -> Unit

RawMessageCallback

interface RawMessageCallback

Callback for messages of type messageType coming to a certain socket If messageType is null, callback is called for any message

RepositoryHandlerScope

interface RepositoryHandlerScope

ResourceFallbacksBundle

@Serializable(with = ResourceBunchSerializer::class)

data class ResourceFallbacksBundle(val locations: List<ResourceLocation>) : VariablesSubstitutionAware<ResourceFallbacksBundle>

ResourceLocation

@Serializable

data class ResourceLocation(val path: String, val type: ResourcePathType) : VariablesSubstitutionAware<ResourceLocation>

ResourcePathType

enum ResourcePathType : Enum<ResourcePathType>

ResourcesBuilder

class ResourcesBuilder(loggerFactory: KernelLoggerFactory)

ResourceType

enum ResourceType : Enum<ResourceType>

TypeDetection

enum TypeDetection : Enum<TypeDetection>

Variable

@Serializable

data class Variable(val name: String, val value: String, val ignored: Boolean = false)

VariablesMapSerializer

object VariablesMapSerializer : ListToMapSerializer<Variable, String, String>

VariablesSubstitutionAware

interface VariablesSubstitutionAware<out T>

VariablesSubstitutionAware provides interface for variables substitution.

Properties

KOTLIN_JUPYTER_LIBRARIES_FILE_NAME

const val KOTLIN_JUPYTER_LIBRARIES_FILE_NAME: String

Name of file in KOTLIN_JUPYTER_RESOURCES_PATH containing information about library definitions and providers inside JAR

KOTLIN_JUPYTER_RESOURCES_PATH

const val KOTLIN_JUPYTER_RESOURCES_PATH: String

Path for all Kotlin Jupyter related stuff in library JARs

nameForUser

val JupyterSocketType.nameForUser: String

portField

val JupyterSocketType.portField: String

sessionId

val RawMessage.sessionId: String?

type

val RawMessage.type: String?

username

val RawMessage.username: String?

Functions

createLibrary

fun createLibrary(notebook: Notebook, builder: JupyterIntegration.Builder.() -> Unit): LibraryDefinition

dependencies

fun JupyterIntegration.Builder.dependencies(action: DependencyHandlerScope.() -> Unit)

filter

fun DescriptorVariables.filter(predicate: (Variable) -> Boolean): DescriptorVariables

google

fun RepositoryHandlerScope.google()

libraryDefinition

fun libraryDefinition(buildAction: (LibraryDefinitionImpl) -> Unit): LibraryDefinition

Builds an instance of LibraryDefinition. Build action receives LibraryDefinitionImpl as an explicit argument because of problems with names clashing that may arise.

mavenCentral

fun RepositoryHandlerScope.mavenCentral()

mavenLocal

fun RepositoryHandlerScope.mavenLocal()

onData

inline fun <T> Comm.onData(crossinline action: (T) -> Unit): CommMsgCallback

rawMessageCallback

fun rawMessageCallback(socket: JupyterSocketType, messageType: String?, action: RawMessageAction): RawMessageCallback

Construct raw message callback

repositories

fun JupyterIntegration.Builder.repositories(action: RepositoryHandlerScope.() -> Unit)

resources

fun JupyterIntegration.Builder.resources(block: ResourcesBuilder.() -> Unit)

Build a resource tree using ResourcesBuilder. The builder allows to construct js and css bundles. Each bundle could contain multiple files or urls. Each of those could contain multiple fallback paths (for example if URL not found, local resource is used.

sendData

inline fun <T> Comm.sendData(data: T)

Send an object. data should be serializable to JSON object (generally it means that the corresponding class should be marked with @Serializable)