jupyter 2.7.4 · OCaml Package

Contents on IOPUB channels

Streams

type stream_name =

| IOPUB_STDOUT
| IOPUB_STDERR

val stream_name_to_yojson : stream_name -> Yojson.Safe.t

val stream_name_of_yojson : 
  Yojson.Safe.t ->
  stream_name Ppx_deriving_yojson_runtime.error_or

type stream = {

stream_name : stream_name Json.enum;
stream_text : string;

}

val stream_to_yojson : stream -> Yojson.Safe.t

val stream_of_yojson : 
  Yojson.Safe.t ->
  stream Ppx_deriving_yojson_runtime.error_or

Display data

type transient = {

display_id : string;

}

val transient_to_yojson : transient -> Yojson.Safe.t

val transient_of_yojson : 
  Yojson.Safe.t ->
  transient Ppx_deriving_yojson_runtime.error_or

type display_data = {

display_data : Yojson.Safe.t;
display_metadata : Yojson.Safe.t;
display_transient : transient option;

}

val display_data_to_yojson : display_data -> Yojson.Safe.t

val display_data_of_yojson : 
  Yojson.Safe.t ->
  display_data Ppx_deriving_yojson_runtime.error_or

Code inputs

type exec_input = {

exin_code : string;
exin_count : int;

}

val exec_input_to_yojson : exec_input -> Yojson.Safe.t

val exec_input_of_yojson : 
  Yojson.Safe.t ->
  exec_input Ppx_deriving_yojson_runtime.error_or

Execution results

type exec_result = {

exres_count : int;
exres_data : Yojson.Safe.t;
exres_metadata : Yojson.Safe.t;

}

val exec_result_to_yojson : exec_result -> Yojson.Safe.t

val exec_result_of_yojson : 
  Yojson.Safe.t ->
  exec_result Ppx_deriving_yojson_runtime.error_or

Kernel status

type exec_status =

| IOPUB_BUSY
| IOPUB_IDLE
| IOPUB_STARTING

val exec_status_to_yojson : exec_status -> Yojson.Safe.t

val exec_status_of_yojson : 
  Yojson.Safe.t ->
  exec_status Ppx_deriving_yojson_runtime.error_or

type status = {

kernel_state : exec_status Json.enum;

}

val status_to_yojson : status -> Yojson.Safe.t

val status_of_yojson : 
  Yojson.Safe.t ->
  status Ppx_deriving_yojson_runtime.error_or

Execution errors

type error = {

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

}

val error_to_yojson : error -> Yojson.Safe.t

val error_of_yojson : 
  Yojson.Safe.t ->
  error Ppx_deriving_yojson_runtime.error_or

Clear output

type clear_output = {

clear_wait : bool;

}

val clear_output_to_yojson : clear_output -> Yojson.Safe.t

val clear_output_of_yojson : 
  Yojson.Safe.t ->
  clear_output Ppx_deriving_yojson_runtime.error_or

IOPUB Request

type request = unit

val request_to_yojson : request -> Yojson.Safe.t

val request_of_yojson : 
  Yojson.Safe.t ->
  request Ppx_deriving_yojson_runtime.error_or

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_to_yojson : reply -> Yojson.Safe.t

val reply_of_yojson : 
  Yojson.Safe.t ->
  reply Ppx_deriving_yojson_runtime.error_or

val _ : Yojson.Safe.t -> reply Ppx_deriving_yojson_runtime.error_or

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

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

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

package jupyter