v3

type Code ¶

type Code struct {
	Source        common.MultilineString `json:"input"`
	TimesExecuted int                    `json:"prompt_number"`
	Out           []Output               `json:"outputs"`
	Lang          string                 `json:"language"`
}

Code defines the schema for a "code" cell.

func (code *Code) ExecutionCount() int

func (code *Code) Language() string

func (code *Code) MimeType() string

func (code *Code) Outputs() (cells []schema.Cell)

func (code *Code) Text() []byte

func (code *Code) Type() schema.CellType

type DisplayDataOutput ¶

type DisplayDataOutput struct {
	MimeBundle
	Metadata map[string]interface{} `json:"metadata"`
}

DisplayDataOutput are rich-format outputs generated by running the code in the parent cell.

func (dd *DisplayDataOutput) Type() schema.CellType

type ErrorOutput ¶

type ErrorOutput struct {
	ExceptionName  string   `json:"ename"`
	ExceptionValue string   `json:"evalue"`
	Traceback      []string `json:"traceback"`
}

ErrorOutput stores the output of a failed code execution.

func (err *ErrorOutput) MimeType() string

func (err *ErrorOutput) Text() (txt []byte)

func (err *ErrorOutput) Type() schema.CellType

type ExecuteResultOutput ¶

type ExecuteResultOutput struct {
	DisplayDataOutput
	TimesExecuted int `json:"prompt_number"`
}

ExecuteResultOutput is the result of executing the code in the cell. Its contents are identical to those of DisplayDataOutput with the addition of the execution count.

func (ex *ExecuteResultOutput) ExecutionCount() int

func (ex *ExecuteResultOutput) Type() schema.CellType

type Heading ¶

type Heading struct {
	Markdown
	Level int `json:"level"`
}

Heading is a dedicated cell type which represent a heading in a Jupyter notebook. This type is deprecated in the later versions and the content is stored as markdown instead.

Heading cell behaves exactly like a markdown cell, decorating its source with the appropriate number of heading signs (#).

func (h *Heading) Text() []byte

type Markdown ¶

type Markdown = common.Markdown

type MimeBundle ¶

type MimeBundle struct {
	PNG        common.MultilineString `json:"png,omitempty"`
	JPEG       common.MultilineString `json:"jpeg,omitempty"`
	HTML       common.MultilineString `json:"html,omitempty"`
	SVG        common.MultilineString `json:"svg,omitempty"`
	Javascript common.MultilineString `json:"javascript,omitempty"`
	JSON       common.MultilineString `json:"json,omitempty"`
	PDF        common.MultilineString `json:"pdf,omitempty"`
	LaTeX      common.MultilineString `json:"latex,omitempty"`
	Txt        common.MultilineString `json:"text,omitempty"`
}

MimeBundle contains rich output data keyed by mime-type.

func (mb MimeBundle) Data(mime string) []byte

func (mb MimeBundle) MimeType() string

func (mb MimeBundle) PlainText() []byte

func (mb MimeBundle) Text() []byte

type Output ¶

type Output struct {
	// contains filtered or unexported fields
}

Outputs unmarshals cell outputs into schema.Cell based on their type.

func (out *Output) UnmarshalJSON(data []byte) error

type Raw ¶

type Raw = common.Raw

type StreamOutput ¶

type StreamOutput struct {
	// Target can be stdout or stderr.
	Target string                 `json:"stream"`
	Source common.MultilineString `json:"text"`
}

StreamOutput is a plain, text-based output of the executed code. Depending on the stream "target", Type() can report "text/plain" (stdout) or "error" (stderr). The output is often decorated with ANSI-color sequences, which should be handled separately.

func (stream *StreamOutput) MimeType() string

func (stream *StreamOutput) Text() []byte

func (stream *StreamOutput) Type() schema.CellType