vscode-extension-samples/notebook-renderer-sample/sample/sample.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Directing notebook cell execution output to a custom VS Code notebook renderer\n",
    "\n",
    "Switch the cell output rendering by clicking on the [...] button next to the cell output and then _Change Presentation_. When you select the `x-application/github-issues`, the custom renderer will be invoked.\n",
    "\n",
    "If you are getting _Renderer not available_ message, you are not running/debugging this sample extension.\n",
    "\n",
    "## Using `IPython.display.display` function and mimetypes"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "application/json": [
       {
        "body": "Bug A description...",
        "title": "Bug A",
        "url": "https://github.com/project/repo/issue/123"
       },
       {
        "body": "Bug B description...",
        "title": "Bug B",
        "url": "https://github.com/project/repo/issue/456"
       }
      ],
      "text/html": [
       "<h1>[html] Bug A, Bug B</h1>"
      ],
      "text/plain": [
       "[plain] https://github.com/project/repo/issue/123, https://github.com/project/repo/issue/456"
      ],
      "x-application/github-issues": "[{\"url\": \"https://github.com/project/repo/issue/123\", \"title\": \"Bug A\", \"body\": \"Bug A description...\"}, {\"url\": \"https://github.com/project/repo/issue/456\", \"title\": \"Bug B\", \"body\": \"Bug B description...\"}]"
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "from IPython import display\n",
    "import json\n",
    "\n",
    "issues = [{\n",
    "        \"url\": \"https://github.com/project/repo/issue/123\",\n",
    "        \"title\": \"Bug A\",\n",
    "        \"body\": \"Bug A description...\"\n",
    "    },\n",
    "    {\n",
    "        \"url\": \"https://github.com/project/repo/issue/456\",\n",
    "        \"title\": \"Bug B\",\n",
    "        \"body\": \"Bug B description...\"\n",
    "    }]\n",
    "\n",
    "display.display({\n",
    "    \"x-application/github-issues\": json.dumps(issues),\n",
    "    \"application/json\": json.dumps(issues, indent=2),\n",
    "    \"text/html\": \"<h1>[html] \" + \", \".join([i[\"title\"] for i in issues]) + \"</h1>\",\n",
    "    \"text/plain\": \"[plain] \" + \", \".join([i[\"url\"] for i in issues]),\n",
    "}, raw=True)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Using the `IPython.display.display` function with an object"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from typing import List\n",
    "from dataclasses import dataclass, is_dataclass, asdict\n",
    "\n",
    "@dataclass\n",
    "class GitHubIssue:\n",
    "    url: str\n",
    "    title: str\n",
    "    body: str\n",
    "\n",
    "issues = [GitHubIssue(\"https://github.com/project/repo/issue/123\", \"Bug A\", \"Bug A description...\"),\n",
    "    GitHubIssue(\"https://github.com/project/repo/issue/456\", \"Bug B\", \"Bug B description...\")]\n",
    "\n",
    "class DataClassJSONEncoder(json.JSONEncoder):\n",
    "    \"\"\" Overrides the json serialization of dataclasses \"\"\"\n",
    "    def default(s, o):\n",
    "        if is_dataclass(o):\n",
    "            return asdict(o)\n",
    "        return super().default(o)\n",
    "\n",
    "class GitHubIssues(object):\n",
    "    def __init__(self, issues: List[GitHubIssue]):\n",
    "        self.issues = issues\n",
    "\n",
    "    def json_dump(self) -> str:\n",
    "        return json.dumps(self.issues, cls=DataClassJSONEncoder)\n",
    "\n",
    "    def _repr_mimebundle_(self, include, exclude):\n",
    "        return {\n",
    "            \"text/plain\": \"[plain]\\n\" + \"\\n\".join([i.url for i in self.issues]),\n",
    "            \"text/html\": \"<h1>[html]</h1>\" + \"\".join(['<li>' + i.title + '</li>' for i in self.issues]),\n",
    "            \"x-application/github-issues\": self.json_dump(),\n",
    "        }\n",
    "\n",
    "display.display(GitHubIssues(issues))"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3.10.8 64-bit",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.10.8"
  },
  "orig_nbformat": 4,
  "vscode": {
   "interpreter": {
    "hash": "768fe601637759c91db8ec17fe83492f1129ce8f3a2f541ec5a1b5d925da7477"
   }
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}