jupyter 2.8.3 (latest) · OCaml Package

Contents on IOPUB channels

Streams

type stream_name =

| IOPUB_STDOUT
| IOPUB_STDERR

val stream_name_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> stream_name

val yojson_of_stream_name : stream_name -> Ppx_yojson_conv_lib.Yojson.Safe.t

type stream = {

stream_name : stream_name Json.enum;
stream_text : string;

}

val stream_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> stream

val yojson_of_stream : stream -> Ppx_yojson_conv_lib.Yojson.Safe.t

Display data

type transient = {

display_id : string;

}

val transient_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> transient

val yojson_of_transient : transient -> Ppx_yojson_conv_lib.Yojson.Safe.t

type display_data = {

display_data : Json.t;
display_metadata : Json.t;
display_transient : transient option;

}

val display_data_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> display_data

val yojson_of_display_data : display_data -> Ppx_yojson_conv_lib.Yojson.Safe.t

Code inputs

type exec_input = {

exin_code : string;
exin_count : int;

}

val exec_input_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> exec_input

val yojson_of_exec_input : exec_input -> Ppx_yojson_conv_lib.Yojson.Safe.t

Execution results

type exec_result = {

exres_count : int;
exres_data : Json.t;
exres_metadata : Json.t;

}

val exec_result_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> exec_result

val yojson_of_exec_result : exec_result -> Ppx_yojson_conv_lib.Yojson.Safe.t

Kernel status

type exec_status =

| IOPUB_BUSY
| IOPUB_IDLE
| IOPUB_STARTING

val exec_status_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> exec_status

val yojson_of_exec_status : exec_status -> Ppx_yojson_conv_lib.Yojson.Safe.t

type status = {

kernel_state : exec_status Json.enum;

}

val status_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> status

val yojson_of_status : status -> Ppx_yojson_conv_lib.Yojson.Safe.t

Execution errors

type error = {

ename : string;
evalue : string;
traceback : string list;

}

val error_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> error

val yojson_of_error : error -> Ppx_yojson_conv_lib.Yojson.Safe.t

Clear output

type clear_output = {

clear_wait : bool;

}

val clear_output_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> clear_output

val yojson_of_clear_output : clear_output -> Ppx_yojson_conv_lib.Yojson.Safe.t

IOPUB Request

type request = unit

val request_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> request

val yojson_of_request : request -> Ppx_yojson_conv_lib.Yojson.Safe.t

IOPUB Reply

type reply =

| IOPUB_STREAM of stream
| IOPUB_DISPLAY_DATA of display_data
| IOPUB_UPDATE_DISPLAY_DATA of display_data
| IOPUB_EXECUTE_INPUT of exec_input
| IOPUB_EXECUTE_RESULT of exec_result
| IOPUB_ERROR of error
| IOPUB_STATUS of status
| IOPUB_CLEAR_OUTPUT of clear_output
| IOPUB_COMM_OPEN of Comm.t
| IOPUB_COMM_MSG of Comm.t
| IOPUB_COMM_CLOSE of Comm.t

val reply_of_yojson : Ppx_yojson_conv_lib.Yojson.Safe.t -> reply

val yojson_of_reply : reply -> Ppx_yojson_conv_lib.Yojson.Safe.t

val stream : name:stream_name Json.enum -> string -> reply

val execute_result : ?metadata:Json.t -> count:int -> Json.t -> reply

val error : ?name:string -> value:string -> string list -> reply

package jupyter