package jupyter

  1. Overview
  2. Docs

Contents on IOPUB channels

Streams

type stream_name =
  1. | IOPUB_STDOUT
  2. | 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 = {
  1. stream_name : stream_name Json.enum;
  2. 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 = {
  1. 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 = {
  1. display_data : Json.t;
  2. display_metadata : Json.t;
  3. 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 = {
  1. exin_code : string;
  2. 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 = {
  1. exres_count : int;
  2. exres_data : Json.t;
  3. 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 =
  1. | IOPUB_BUSY
  2. | IOPUB_IDLE
  3. | 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 = {
  1. 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 = {
  1. ename : string;
  2. evalue : string;
  3. 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 = {
  1. 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 =
  1. | IOPUB_STREAM of stream
  2. | IOPUB_DISPLAY_DATA of display_data
  3. | IOPUB_UPDATE_DISPLAY_DATA of display_data
  4. | IOPUB_EXECUTE_INPUT of exec_input
  5. | IOPUB_EXECUTE_RESULT of exec_result
  6. | IOPUB_ERROR of error
  7. | IOPUB_STATUS of status
  8. | IOPUB_CLEAR_OUTPUT of clear_output
  9. | IOPUB_COMM_OPEN of Comm.t
  10. | IOPUB_COMM_MSG of Comm.t
  11. | 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