Function translateDisplayDataOutput

src/kernels/execution/helpers.ts:242–284

* Converts a Jupyter display cell output into a VSCode cell output format. * Handles sizing, adding backgrounds to images and the like. * E.g. Jupyter cell output contains metadata to add backgrounds to images.

(
    output: nbformat.IDisplayData | nbformat.IDisplayUpdate | nbformat.IExecuteResult,
    cellIndex?: number,
    cellId?: string,
    cellMetadata?: Record<string, unknown>
)

 * E.g. Jupyter cell output contains metadata to add backgrounds to images.
 */
function translateDisplayDataOutput(
    output: nbformat.IDisplayData | nbformat.IDisplayUpdate | nbformat.IExecuteResult,
    cellIndex?: number,
    cellId?: string,
    cellMetadata?: Record<string, unknown>
): NotebookCellOutput {
    // Metadata could be as follows:
    // We'll have metadata specific to each mime type as well as generic metadata.
    /*
    IDisplayData = {
        output_type: 'display_data',
        data: {
            'image/jpg': '/////'
            'image/png': '/////'
            'text/plain': '/////'
        },
        metadata: {
            'image/png': '/////',
            'background': true,
            'xyz': '///
        }
    }
    */
    const deepnotePocket = cellMetadata?.__deepnotePocket as Pocket | undefined;
    const deepnoteBlockType = deepnotePocket?.type;

    const metadata = getOutputMetadata(output, cellIndex, cellId, cellMetadata);
    // If we have SVG or PNG, then add special metadata to indicate whether to display `open plot`
    if ('image/svg+xml' in output.data || 'image/png' in output.data) {
        metadata.__displayOpenPlotIcon = true;
    }
    const items: NotebookCellOutputItem[] = [];
    if (output.data) {
        // eslint-disable-next-line no-restricted-syntax
        for (const key in output.data) {
            // TODO - remove this once this is handled in the deepnote-toolkit
            let effectiveKey = deepnoteBlockType === 'big-number' ? CHART_BIG_NUMBER_MIME_TYPE : key;
            items.push(convertJupyterOutputToBuffer(effectiveKey, output.data[key] ?? output.data[effectiveKey]));
        }
    }

    return new NotebookCellOutput(sortOutputItemsBasedOnDisplayOrder(items), metadata);
}

function translateStreamOutput(
    output: nbformat.IStream,