data class ExecuteRequest(val code: String, val silent: Boolean = false, val storeHistory: Boolean = true, val userExpressions: Map<String, String> = mapOf(), val userVariables: List<String> = listOf(), val allowStdin: Boolean = true, val stopOnError: Boolean = true) : MessageContent

ExecuteResult

@Serializable

class ExecuteResult(val data: JsonElement, val metadata: JsonElement, val executionCount: ExecutionCount) : MessageContent

ExecuteSuccessReply

@Serializable

class ExecuteSuccessReply(val executionCount: ExecutionCount, val payload: List<Payload> = listOf(), val userExpressions: Map<String, JsonElement> = mapOf(), val additionalInfo: JsonObject? = null) : OkReplyContent, ExecuteReply

ExecutionCount

@JvmInline

@Serializable

value class ExecutionCount(val value: Int)

Typesafe wrapper for execution counts created by ExecutionCounter.

ExecutionCounter

class ExecutionCounter(initialValue: Int)

Class responsible for tracking the execution count that is sent from the kernel to the client for all execution requests. It should be sent back to the client in execute_reply and execute_input messages.

HelpLink

@Serializable

class HelpLink(val text: String, val url: String)

HistoryReply

@Serializable

class HistoryReply(val history: List<String>) : OkReplyContent

HistoryRequest

@Serializable

class HistoryRequest(val output: Boolean, val raw: Boolean, val hist_access_type: String, val session: Int? = null, val start: Int? = null, val stop: Int? = null, val n: Int? = null, val pattern: String? = null, val unique: Boolean? = null) : MessageContent

IdeCompatibleMessageRequestProcessor

open class IdeCompatibleMessageRequestProcessor(rawIncomingMessage: RawMessage, messageFactoryProvider: MessageFactoryProvider, val socketManager: JupyterBaseSockets, commManager: CommManagerInternal, executor: JupyterExecutor, executionCounter: ExecutionCounter, loggerFactory: KernelLoggerFactory, repl: ReplForJupyter) : AbstractMessageRequestProcessor, JupyterCommunicationFacility

InputReply

@Serializable

class InputReply(val value: String) : MessageContent

InputRequest

@Serializable

class InputRequest(val prompt: String, val password: Boolean = false) : MessageContent

InspectReply

@Serializable

class InspectReply(val found: Boolean, val data: JsonObject = Json.EMPTY, val metadata: JsonObject = Json.EMPTY) : OkReplyContent

InspectRequest

@Serializable

class InspectRequest(val code: String, val cursorPos: Int, val detailLevel: DetailLevel) : MessageContent

InterruptReply

@Serializable

class InterruptReply : OkReplyContent

InterruptRequest

@Serializable

class InterruptRequest : MessageContent

IsCompleteReply

@Serializable

class IsCompleteReply(val status: String, val indent: String? = null) : MessageContent

IsCompleteRequest

@Serializable

class IsCompleteRequest(val code: String) : MessageContent

JupyterBaseSockets

interface JupyterBaseSockets

Interface describing the sockets available in a Jupyter Kernel.

JupyterCommunicationFacility

interface JupyterCommunicationFacility

JupyterCommunicationFacilityImpl

class JupyterCommunicationFacilityImpl(val socketManager: JupyterBaseSockets, messageFactoryProvider: Provider<MessageFactory>) : JupyterCommunicationFacility

JupyterConnectionInternal

interface JupyterConnectionInternal : JupyterConnection

JupyterOutType

enum JupyterOutType : Enum<JupyterOutType>

JupyterResponse

sealed interface JupyterResponse

JupyterSocketManager

interface JupyterSocketManager : JupyterBaseSockets, JupyterSocketManagerBase, Closeable

Interface responsible for controlling the lifecycle of kernel sockets.

KernelInfoReply

@Serializable

class KernelInfoReply(val protocolVersion: String, val implementation: String, val implementationVersion: String, val banner: String, val languageInfo: LanguageInfo, val helpLinks: List<HelpLink>) : OkReplyContent

KernelInfoReplyMetadata

@Serializable

class KernelInfoReplyMetadata(val state: EvaluatedSnippetMetadata)

KernelInfoRequest

@Serializable

class KernelInfoRequest : MessageContent

KernelStatus

@Serializable

enum KernelStatus : Enum<KernelStatus>

ListErrorsReply

@Serializable

class ListErrorsReply(val code: String, val errors: List<ScriptDiagnostic>) : MessageContent

ListErrorsRequest

@Serializable

class ListErrorsRequest(val code: String) : MessageContent

Message

data class Message(val id: List<ByteArray> = listOf(), val data: MessageData = MessageData())

MessageContent

sealed interface MessageContent

Top-level interface for the generic content part of a Jupyter message. See https://jupyter-client.readthedocs.io/en/latest/messaging.html#content

MessageData

@Serializable(with = MessageDataSerializer::class)

data class MessageData(val header: MessageHeader? = null, val parentHeader: MessageHeader? = null, val metadata: JsonElement? = null, val content: MessageContent? = null)

Class representing general messages sent across the Jupyter Protocol. See https://jupyter-client.readthedocs.io/en/latest/messaging.html#a-full-message

MessageFactory

interface MessageFactory

MessageFactoryImpl

class MessageFactoryImpl : MessageFactory

MessageFactoryProvider

interface MessageFactoryProvider : UpdatableProvider<MessageFactory>

MessageFactoryProviderImpl

class MessageFactoryProviderImpl : UpdatableProviderImpl<MessageFactory> , MessageFactoryProvider

MessageHandler

interface MessageHandler

MessageHeader

@Serializable

data class MessageHeader(val id: String, val type: MessageType, val session: String? = null, val username: String? = null, val version: String? = null, val date: String? = null)

MessageReplyContent

@Serializable

sealed class MessageReplyContent : MessageContent

Top-level class for the content of "reply" messages. This class is abstract with status as a constructor parameter so we can serialize the status field. In an ideal world, this would be an interface instead.

MessageRequestProcessor

interface MessageRequestProcessor

MessageStatus

@Serializable

enum MessageStatus : Enum<MessageStatus>

See https://jupyter-client.readthedocs.io/en/latest/messaging.html#request-reply for the definition of these values.

MessageType

@Serializable(with = MessageTypeSerializer::class)

enum MessageType : Enum<MessageType>

See https://jupyter-client.readthedocs.io/en/latest/messaging.html#messages-on-the-shell-router-dealer-channel for details on how these messages are defined and how they are used in the Jupyter protocol.

NoOpDisplayHandler

object NoOpDisplayHandler : DisplayHandler

OkJupyterResponse

class OkJupyterResponse(val displayResult: DisplayResult?, val metadata: EvaluatedSnippetMetadata? = null) : JupyterResponse

OkReplyContent

@Serializable

abstract class OkReplyContent : MessageReplyContent

OpenDebugPortReply

@Serializable

class OpenDebugPortReply(val port: Int?) : OkReplyContent

Paragraph

@Serializable

class Paragraph(val cursor: Int, val text: String)

Data wrapper used by custom code completion events.

Payload

@Serializable

class Payload(val source: String)

ProvidedCommMessages

object ProvidedCommMessages

ShutdownReply

@Serializable

class ShutdownReply(val restart: Boolean) : OkReplyContent

ShutdownRequest

@Serializable

class ShutdownRequest(val restart: Boolean) : MessageContent

SocketDisplayHandler

class SocketDisplayHandler(communicationFacility: JupyterCommunicationFacility, notebook: MutableNotebook) : DisplayHandler

StatusMessage

@Serializable

class StatusMessage(val status: KernelStatus) : MessageContent

StreamMessage

@Serializable

class StreamMessage(val name: String, val text: String) : MessageContent

UpdateClientMetadataErrorReply

@Serializable

class UpdateClientMetadataErrorReply(val name: String, val value: String, val traceback: List<String>) : ErrorReplyContent, UpdateClientMetadataReply

UpdateClientMetadataReply

@Serializable(with = UpdateClientMetadataReplySerializer::class)

sealed interface UpdateClientMetadataReply : MessageContent

UpdateClientMetadataRequest

@Serializable

class UpdateClientMetadataRequest(val absoluteNotebookFilePath: Path) : MessageContent

UpdateClientMetadataSuccessReply

@Serializable

class UpdateClientMetadataSuccessReply : OkReplyContent, UpdateClientMetadataReply

Properties

EXECUTION_INTERRUPTED_MESSAGE

const val EXECUTION_INTERRUPTED_MESSAGE: String

ISO8601DateNow

val ISO8601DateNow: String

Functions

doWrappedInBusyIdle

fun JupyterCommunicationFacility.doWrappedInBusyIdle(action: () -> Unit)

getInput

fun JupyterCommunicationFacility.getInput(prompt: String = DefaultPromptOptions.PROMPT, password: Boolean = DefaultPromptOptions.IS_PASSWORD): String

makeDefaultHeader

fun MessageFactory.makeDefaultHeader(msgType: MessageType): MessageHeader

makeHeader

fun makeHeader(type: MessageType, sessionId: String?, username: String?): MessageHeader

fun makeHeader(msgType: MessageType? = null, incomingMsg: RawMessage? = null, sessionId: String? = null): MessageHeader

makeReplyMessage

fun makeReplyMessage(msg: RawMessage, msgType: MessageType? = null, sessionId: String? = null, header: MessageHeader? = null, parentHeader: MessageHeader? = null, metadata: JsonElement? = null, content: MessageContent? = null): Message

makeReplyMessage