Spaces:
Sleeping
Sleeping
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> | |
| <meta charset="utf-8"> | |
| <meta name="generator" content="quarto-1.6.40"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> | |
| <meta name="description" content="Use FastHTML in Jupyter notebooks"> | |
| <title>Jupyter compatibility – fasthtml</title> | |
| <style> | |
| code{white-space: pre-wrap;} | |
| span.smallcaps{font-variant: small-caps;} | |
| div.columns{display: flex; gap: min(4vw, 1.5em);} | |
| div.column{flex: auto; overflow-x: auto;} | |
| div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;} | |
| ul.task-list{list-style: none;} | |
| ul.task-list li input[type="checkbox"] { | |
| width: 0.8em; | |
| margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */ | |
| vertical-align: middle; | |
| } | |
| /* CSS for syntax highlighting */ | |
| pre > code.sourceCode { white-space: pre; position: relative; } | |
| pre > code.sourceCode > span { line-height: 1.25; } | |
| pre > code.sourceCode > span:empty { height: 1.2em; } | |
| .sourceCode { overflow: visible; } | |
| code.sourceCode > span { color: inherit; text-decoration: inherit; } | |
| div.sourceCode { margin: 1em 0; } | |
| pre.sourceCode { margin: 0; } | |
| @media screen { | |
| div.sourceCode { overflow: auto; } | |
| } | |
| @media print { | |
| pre > code.sourceCode { white-space: pre-wrap; } | |
| pre > code.sourceCode > span { display: inline-block; text-indent: -5em; padding-left: 5em; } | |
| } | |
| pre.numberSource code | |
| { counter-reset: source-line 0; } | |
| pre.numberSource code > span | |
| { position: relative; left: -4em; counter-increment: source-line; } | |
| pre.numberSource code > span > a:first-child::before | |
| { content: counter(source-line); | |
| position: relative; left: -1em; text-align: right; vertical-align: baseline; | |
| border: none; display: inline-block; | |
| -webkit-touch-callout: none; -webkit-user-select: none; | |
| -khtml-user-select: none; -moz-user-select: none; | |
| -ms-user-select: none; user-select: none; | |
| padding: 0 4px; width: 4em; | |
| } | |
| pre.numberSource { margin-left: 3em; padding-left: 4px; } | |
| div.sourceCode | |
| { } | |
| @media screen { | |
| pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; } | |
| } | |
| </style> | |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.min.js" integrity="sha512-bLT0Qm9VnAYZDflyKcBaQ2gg0hSYNQrJ8RilYldYQ1FxQYoCLtUjuuRuZo+fjqhx/qtq/1itJ0C2ejDxltZVFg==" crossorigin="anonymous"></script><script src="../site_libs/quarto-nav/quarto-nav.js"></script> | |
| <script src="../site_libs/quarto-nav/headroom.min.js"></script> | |
| <script src="../site_libs/clipboard/clipboard.min.js"></script> | |
| <script src="../site_libs/quarto-search/autocomplete.umd.js"></script> | |
| <script src="../site_libs/quarto-search/fuse.min.js"></script> | |
| <script src="../site_libs/quarto-search/quarto-search.js"></script> | |
| <meta name="quarto:offset" content="../"> | |
| <link href="../favicon.ico" rel="icon"> | |
| <script src="../site_libs/quarto-html/quarto.js"></script> | |
| <script src="../site_libs/quarto-html/popper.min.js"></script> | |
| <script src="../site_libs/quarto-html/tippy.umd.min.js"></script> | |
| <script src="../site_libs/quarto-html/anchor.min.js"></script> | |
| <link href="../site_libs/quarto-html/tippy.css" rel="stylesheet"> | |
| <link href="../site_libs/quarto-html/quarto-syntax-highlighting-549806ee2085284f45b00abea8c6df48.css" rel="stylesheet" id="quarto-text-highlighting-styles"> | |
| <script src="../site_libs/bootstrap/bootstrap.min.js"></script> | |
| <link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet"> | |
| <link href="../site_libs/bootstrap/bootstrap-e463c5e664eae906a5c2eb38a07ecc3d.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light"> | |
| <script id="quarto-search-options" type="application/json">{ | |
| "location": "navbar", | |
| "copy-button": false, | |
| "collapse-after": 3, | |
| "panel-placement": "end", | |
| "type": "overlay", | |
| "limit": 50, | |
| "keyboard-shortcut": [ | |
| "f", | |
| "/", | |
| "s" | |
| ], | |
| "show-item-context": false, | |
| "language": { | |
| "search-no-results-text": "No results", | |
| "search-matching-documents-text": "matching documents", | |
| "search-copy-link-title": "Copy link to search", | |
| "search-hide-matches-text": "Hide additional matches", | |
| "search-more-match-text": "more match in this document", | |
| "search-more-matches-text": "more matches in this document", | |
| "search-clear-button-title": "Clear", | |
| "search-text-placeholder": "", | |
| "search-detached-cancel-button-title": "Cancel", | |
| "search-submit-button-title": "Submit", | |
| "search-label": "Search" | |
| } | |
| }</script> | |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" integrity="sha512-c3Nl8+7g4LMSTdrm621y7kf9v3SDPnhxLNhcjFJbKECVnmZHTdo+IRO05sNLTH/D3vA6u1X32ehoLC7WFVdheg==" crossorigin="anonymous"></script> | |
| <script type="application/javascript">define('jquery', [],function() {return window.jQuery;})</script> | |
| <link rel="stylesheet" href="../styles.css"> | |
| <meta property="og:title" content="Jupyter compatibility – fasthtml"> | |
| <meta property="og:description" content="Use FastHTML in Jupyter notebooks"> | |
| <meta property="og:site_name" content="fasthtml"> | |
| <meta name="twitter:title" content="Jupyter compatibility – fasthtml"> | |
| <meta name="twitter:description" content="Use FastHTML in Jupyter notebooks"> | |
| <meta name="twitter:image" content="https://www.fastht.ml/docs/og-image.png"> | |
| <meta name="twitter:creator" content="@jeremyphoward"> | |
| <meta name="twitter:site" content="@answerdotai"> | |
| <meta name="twitter:card" content="summary_large_image"> | |
| <link rel="canonical" href="https://www.fastht.ml/docs/api/jupyter.html"> | |
| </head> | |
| <body class="nav-sidebar floating nav-fixed"> | |
| <div id="quarto-search-results"></div> | |
| <header id="quarto-header" class="headroom fixed-top"> | |
| <nav class="navbar navbar-expand-lg " data-bs-theme="dark"> | |
| <div class="navbar-container container-fluid"> | |
| <div class="navbar-brand-container mx-auto"> | |
| <a href="../index.html" class="navbar-brand navbar-brand-logo"> | |
| <img src="../logo.svg" alt="" class="navbar-logo"> | |
| </a> | |
| </div> | |
| <div id="quarto-search" class="" title="Search"></div> | |
| <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarCollapse" aria-controls="navbarCollapse" role="menu" aria-expanded="false" aria-label="Toggle navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }"> | |
| <span class="navbar-toggler-icon"></span> | |
| </button> | |
| <div class="collapse navbar-collapse" id="navbarCollapse"> | |
| <ul class="navbar-nav navbar-nav-scroll me-auto"> | |
| <li class="nav-item"> | |
| <a class="nav-link" href="https://fastht.ml"> | |
| <span class="menu-text">Home</span></a> | |
| </li> | |
| <li class="nav-item"> | |
| <a class="nav-link" href="https://fastht.ml/about"> | |
| <span class="menu-text">Learn</span></a> | |
| </li> | |
| </ul> | |
| <ul class="navbar-nav navbar-nav-scroll ms-auto"> | |
| <li class="nav-item compact"> | |
| <a class="nav-link" href="https://github.com/answerdotai/fasthtml"> <i class="bi bi-github" role="img"> | |
| </i> | |
| <span class="menu-text"></span></a> | |
| </li> | |
| <li class="nav-item compact"> | |
| <a class="nav-link" href="https://x.com/answerdotai"> <i class="bi bi-twitter" role="img" aria-label="Fast.ai Twitter"> | |
| </i> | |
| <span class="menu-text"></span></a> | |
| </li> | |
| </ul> | |
| </div> <!-- /navcollapse --> | |
| <div class="quarto-navbar-tools"> | |
| </div> | |
| </div> <!-- /container-fluid --> | |
| </nav> | |
| <nav class="quarto-secondary-nav"> | |
| <div class="container-fluid d-flex"> | |
| <button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }"> | |
| <i class="bi bi-layout-text-sidebar-reverse"></i> | |
| </button> | |
| <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../api/core.html">Source</a></li><li class="breadcrumb-item"><a href="../api/jupyter.html">Jupyter compatibility</a></li></ol></nav> | |
| <a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }"> | |
| </a> | |
| </div> | |
| </nav> | |
| </header> | |
| <!-- content --> | |
| <div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar"> | |
| <!-- sidebar --> | |
| <nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal quarto-sidebar-collapse-item sidebar-navigation floating overflow-auto"> | |
| <div class="sidebar-menu-container"> | |
| <ul class="list-unstyled mt-1"> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../index.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Get Started</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item sidebar-item-section"> | |
| <div class="sidebar-item-container"> | |
| <a href="../tutorials/index.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Tutorials</span></a> | |
| <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section"> | |
| <i class="bi bi-chevron-right ms-2"></i> | |
| </a> | |
| </div> | |
| <ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show"> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../tutorials/by_example.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">FastHTML By Example</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../tutorials/quickstart_for_web_devs.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Web Devs Quickstart</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../tutorials/e2e.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">JS App Walkthrough</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../tutorials/best_practice.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">FastHTML Best Practices</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../tutorials/jupyter_and_fasthtml.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Using Jupyter to write FastHTML</span></a> | |
| </div> | |
| </li> | |
| </ul> | |
| </li> | |
| <li class="sidebar-item sidebar-item-section"> | |
| <div class="sidebar-item-container"> | |
| <a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true"> | |
| <span class="menu-text">Explanations</span></a> | |
| <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section"> | |
| <i class="bi bi-chevron-right ms-2"></i> | |
| </a> | |
| </div> | |
| <ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show"> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../explains/background_tasks.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Background Tasks</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../explains/explaining_xt_components.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text"><strong>FT</strong> Components</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../explains/faq.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">FAQ</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../explains/minidataapi.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">MiniDataAPI Spec</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../explains/oauth.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">OAuth</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../explains/routes.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Routes</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../explains/stripe.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Stripe</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../explains/websockets.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">WebSockets</span></a> | |
| </div> | |
| </li> | |
| </ul> | |
| </li> | |
| <li class="sidebar-item sidebar-item-section"> | |
| <div class="sidebar-item-container"> | |
| <a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-3" role="navigation" aria-expanded="true"> | |
| <span class="menu-text">Reference</span></a> | |
| <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-3" role="navigation" aria-expanded="true" aria-label="Toggle section"> | |
| <i class="bi bi-chevron-right ms-2"></i> | |
| </a> | |
| </div> | |
| <ul id="quarto-sidebar-section-3" class="collapse list-unstyled sidebar-section depth1 show"> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../ref/concise_guide.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Concise reference</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../ref/best_practice.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">FastHTML Best Practices</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../ref/defining_xt_component.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Custom Components</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../ref/handlers.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Handling handlers</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../ref/live_reload.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Live Reloading</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../ref/response_types.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Response Types</span></a> | |
| </div> | |
| </li> | |
| </ul> | |
| </li> | |
| <li class="sidebar-item sidebar-item-section"> | |
| <div class="sidebar-item-container"> | |
| <a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" role="navigation" aria-expanded="true"> | |
| <span class="menu-text">Source</span></a> | |
| <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" role="navigation" aria-expanded="true" aria-label="Toggle section"> | |
| <i class="bi bi-chevron-right ms-2"></i> | |
| </a> | |
| </div> | |
| <ul id="quarto-sidebar-section-4" class="collapse list-unstyled sidebar-section depth1 show"> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../api/core.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Core</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../api/components.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Components</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../api/xtend.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Component extensions</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../api/js.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Javascript examples</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../api/pico.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Pico.css components</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../api/svg.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">SVG</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../api/jupyter.html" class="sidebar-item-text sidebar-link active"> | |
| <span class="menu-text">Jupyter compatibility</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../api/oauth.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">OAuth</span></a> | |
| </div> | |
| </li> | |
| <li class="sidebar-item"> | |
| <div class="sidebar-item-container"> | |
| <a href="../api/cli.html" class="sidebar-item-text sidebar-link"> | |
| <span class="menu-text">Command Line Tools</span></a> | |
| </div> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| </nav> | |
| <div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div> | |
| <!-- margin-sidebar --> | |
| <div id="quarto-margin-sidebar" class="sidebar margin-sidebar"> | |
| <nav id="TOC" role="doc-toc" class="toc-active"> | |
| <h2 id="toc-title">On this page</h2> | |
| <ul> | |
| <li><a href="#helper-functions" id="toc-helper-functions" class="nav-link active" data-scroll-target="#helper-functions">Helper functions</a> | |
| <ul class="collapse"> | |
| <li><a href="#nb_serve" id="toc-nb_serve" class="nav-link" data-scroll-target="#nb_serve">nb_serve</a></li> | |
| <li><a href="#nb_serve_async" id="toc-nb_serve_async" class="nav-link" data-scroll-target="#nb_serve_async">nb_serve_async</a></li> | |
| <li><a href="#is_port_free" id="toc-is_port_free" class="nav-link" data-scroll-target="#is_port_free">is_port_free</a></li> | |
| <li><a href="#wait_port_free" id="toc-wait_port_free" class="nav-link" data-scroll-target="#wait_port_free">wait_port_free</a></li> | |
| </ul></li> | |
| <li><a href="#using-fasthtml-in-jupyter" id="toc-using-fasthtml-in-jupyter" class="nav-link" data-scroll-target="#using-fasthtml-in-jupyter">Using FastHTML in Jupyter</a> | |
| <ul class="collapse"> | |
| <li><a href="#show" id="toc-show" class="nav-link" data-scroll-target="#show">show</a></li> | |
| <li><a href="#render_ft" id="toc-render_ft" class="nav-link" data-scroll-target="#render_ft">render_ft</a></li> | |
| <li><a href="#htmx_config_port" id="toc-htmx_config_port" class="nav-link" data-scroll-target="#htmx_config_port">htmx_config_port</a></li> | |
| <li><a href="#jupyuvi" id="toc-jupyuvi" class="nav-link" data-scroll-target="#jupyuvi">JupyUvi</a></li> | |
| <li><a href="#jupyuviasync" id="toc-jupyuviasync" class="nav-link" data-scroll-target="#jupyuviasync">JupyUviAsync</a></li> | |
| <li><a href="#using-a-notebook-as-a-web-app" id="toc-using-a-notebook-as-a-web-app" class="nav-link" data-scroll-target="#using-a-notebook-as-a-web-app">Using a notebook as a web app</a></li> | |
| <li><a href="#running-apps-in-an-iframe" id="toc-running-apps-in-an-iframe" class="nav-link" data-scroll-target="#running-apps-in-an-iframe">Running apps in an IFrame</a></li> | |
| <li><a href="#htmx" id="toc-htmx" class="nav-link" data-scroll-target="#htmx">HTMX</a></li> | |
| <li><a href="#ws_client" id="toc-ws_client" class="nav-link" data-scroll-target="#ws_client">ws_client</a></li> | |
| </ul></li> | |
| </ul> | |
| <div class="toc-actions"><ul><li><a href="https://github.com/AnswerDotAI/fasthtml/issues/new" class="toc-action"><i class="bi bi-github"></i>Report an issue</a></li></ul></div><div class="quarto-alternate-formats"><h2>Other Formats</h2><ul><li><a href="jupyter.html.md"><i class="bi bi-file-code"></i>CommonMark</a></li></ul></div></nav> | |
| </div> | |
| <!-- main --> | |
| <main class="content" id="quarto-document-content"> | |
| <header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../api/core.html">Source</a></li><li class="breadcrumb-item"><a href="../api/jupyter.html">Jupyter compatibility</a></li></ol></nav> | |
| <div class="quarto-title"> | |
| <h1 class="title">Jupyter compatibility</h1> | |
| </div> | |
| <div> | |
| <div class="description"> | |
| Use FastHTML in Jupyter notebooks | |
| </div> | |
| </div> | |
| <div class="quarto-title-meta"> | |
| </div> | |
| </header> | |
| <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! --> | |
| <div id="a1c7b207" class="cell"> | |
| <div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> httpx <span class="im">import</span> get, AsyncClient</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| <section id="helper-functions" class="level2"> | |
| <h2 class="anchored" data-anchor-id="helper-functions">Helper functions</h2> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/jupyter.py#L21" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| <section id="nb_serve" class="level3"> | |
| <h3 class="anchored" data-anchor-id="nb_serve">nb_serve</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> nb_serve (app, log_level='error', port=8000, host='0.0.0.0', **kwargs)</code></pre> | |
| </blockquote> | |
| <p><em>Start a Jupyter compatible uvicorn server with ASGI <code>app</code> on <code>port</code> with <code>log_level</code></em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/jupyter.py#L31" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="nb_serve_async" class="level3"> | |
| <h3 class="anchored" data-anchor-id="nb_serve_async">nb_serve_async</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> nb_serve_async (app, log_level='error', port=8000, host='0.0.0.0', | |
| **kwargs)</code></pre> | |
| </blockquote> | |
| <p><em>Async version of <a href="https://www.fastht.ml/docs/api/jupyter.html#nb_serve"><code>nb_serve</code></a></em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/jupyter.py#L39" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="is_port_free" class="level3"> | |
| <h3 class="anchored" data-anchor-id="is_port_free">is_port_free</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> is_port_free (port, host='localhost')</code></pre> | |
| </blockquote> | |
| <p><em>Check if <code>port</code> is free on <code>host</code></em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/jupyter.py#L50" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="wait_port_free" class="level3"> | |
| <h3 class="anchored" data-anchor-id="wait_port_free">wait_port_free</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> wait_port_free (port, host='localhost', max_wait=3)</code></pre> | |
| </blockquote> | |
| <p><em>Wait for <code>port</code> to be free on <code>host</code></em></p> | |
| </section> | |
| </section> | |
| <section id="using-fasthtml-in-jupyter" class="level2"> | |
| <h2 class="anchored" data-anchor-id="using-fasthtml-in-jupyter">Using FastHTML in Jupyter</h2> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/components.py#L128" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| <section id="show" class="level3"> | |
| <h3 class="anchored" data-anchor-id="show">show</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> show (*s, iframe=False, height='auto', style=None)</code></pre> | |
| </blockquote> | |
| <p><em>Same as fasthtml.components.show, but also adds <code>htmx.process()</code></em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/jupyter.py#L65" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="render_ft" class="level3"> | |
| <h3 class="anchored" data-anchor-id="render_ft">render_ft</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> render_ft ()</code></pre> | |
| </blockquote> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/jupyter.py#L70" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="htmx_config_port" class="level3"> | |
| <h3 class="anchored" data-anchor-id="htmx_config_port">htmx_config_port</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> htmx_config_port (port=8000)</code></pre> | |
| </blockquote> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/jupyter.py#L81" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="jupyuvi" class="level3"> | |
| <h3 class="anchored" data-anchor-id="jupyuvi">JupyUvi</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> JupyUvi (app, log_level='error', host='0.0.0.0', port=8000, start=True, | |
| **kwargs)</code></pre> | |
| </blockquote> | |
| <p><em>Start and stop a Jupyter compatible uvicorn server with ASGI <code>app</code> on <code>port</code> with <code>log_level</code></em></p> | |
| <p>Creating an object of this class also starts the Uvicorn server. It runs in a separate thread, so you can use normal HTTP client functions in a notebook.</p> | |
| <div id="0f4b31e9" class="cell"> | |
| <div class="sourceCode cell-code" id="cb10"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a>app <span class="op">=</span> FastHTML()</span> | |
| <span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a>rt <span class="op">=</span> app.route</span> | |
| <span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a></span> | |
| <span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a><span class="at">@app.route</span></span> | |
| <span id="cb10-5"><a href="#cb10-5" aria-hidden="true" tabindex="-1"></a><span class="kw">def</span> index(): <span class="cf">return</span> <span class="st">'hi'</span></span> | |
| <span id="cb10-6"><a href="#cb10-6" aria-hidden="true" tabindex="-1"></a></span> | |
| <span id="cb10-7"><a href="#cb10-7" aria-hidden="true" tabindex="-1"></a>port <span class="op">=</span> <span class="dv">8000</span></span> | |
| <span id="cb10-8"><a href="#cb10-8" aria-hidden="true" tabindex="-1"></a>server <span class="op">=</span> JupyUvi(app, port<span class="op">=</span>port)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-display"> | |
| <script> | |
| document.body.addEventListener('htmx:configRequest', (event) => { | |
| if(event.detail.path.includes('://')) return; | |
| htmx.config.selfRequestsOnly=false; | |
| event.detail.path = `${location.protocol}//${location.hostname}:8000${event.detail.path}`; | |
| }); | |
| </script> | |
| </div> | |
| </div> | |
| <div id="9e57a6a1" class="cell"> | |
| <div class="sourceCode cell-code" id="cb11"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a>get(<span class="ss">f'http://localhost:</span><span class="sc">{</span>port<span class="sc">}</span><span class="ss">'</span>).text</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-display"> | |
| <pre><code>'hi'</code></pre> | |
| </div> | |
| </div> | |
| <p>You can stop the server, modify routes, and start the server again without restarting the notebook or recreating the server or application.</p> | |
| <div id="8ea9128a" class="cell"> | |
| <div class="sourceCode cell-code" id="cb13"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a>server.stop()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| <div id="97bfb966" class="cell"> | |
| <div class="sourceCode cell-code" id="cb14"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a>app <span class="op">=</span> FastHTML()</span> | |
| <span id="cb14-2"><a href="#cb14-2" aria-hidden="true" tabindex="-1"></a>rt <span class="op">=</span> app.route</span> | |
| <span id="cb14-3"><a href="#cb14-3" aria-hidden="true" tabindex="-1"></a></span> | |
| <span id="cb14-4"><a href="#cb14-4" aria-hidden="true" tabindex="-1"></a><span class="at">@app.route</span></span> | |
| <span id="cb14-5"><a href="#cb14-5" aria-hidden="true" tabindex="-1"></a><span class="cf">async</span> <span class="kw">def</span> index(): <span class="cf">return</span> <span class="st">'hi'</span></span> | |
| <span id="cb14-6"><a href="#cb14-6" aria-hidden="true" tabindex="-1"></a></span> | |
| <span id="cb14-7"><a href="#cb14-7" aria-hidden="true" tabindex="-1"></a>server <span class="op">=</span> JupyUvi(app, port<span class="op">=</span>port, start<span class="op">=</span><span class="va">False</span>)</span> | |
| <span id="cb14-8"><a href="#cb14-8" aria-hidden="true" tabindex="-1"></a><span class="cf">await</span> server.start_async()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-display"> | |
| <script> | |
| document.body.addEventListener('htmx:configRequest', (event) => { | |
| if(event.detail.path.includes('://')) return; | |
| htmx.config.selfRequestsOnly=false; | |
| event.detail.path = `${location.protocol}//${location.hostname}:8000${event.detail.path}`; | |
| }); | |
| </script> | |
| </div> | |
| </div> | |
| <div id="8945d436" class="cell"> | |
| <div class="sourceCode cell-code" id="cb15"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>((<span class="cf">await</span> AsyncClient().get(<span class="ss">f'http://localhost:</span><span class="sc">{</span>port<span class="sc">}</span><span class="ss">'</span>)).text)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-stdout"> | |
| <pre><code>hi</code></pre> | |
| </div> | |
| </div> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/jupyter.py#L101" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="jupyuviasync" class="level3"> | |
| <h3 class="anchored" data-anchor-id="jupyuviasync">JupyUviAsync</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> JupyUviAsync (app, log_level='error', host='0.0.0.0', port=8000, | |
| **kwargs)</code></pre> | |
| </blockquote> | |
| <p><em>Start and stop an async Jupyter compatible uvicorn server with ASGI <code>app</code> on <code>port</code> with <code>log_level</code></em></p> | |
| <div id="959eb254" class="cell"> | |
| <div class="sourceCode cell-code" id="cb18"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a>server <span class="op">=</span> JupyUviAsync(app, port<span class="op">=</span>port)</span> | |
| <span id="cb18-2"><a href="#cb18-2" aria-hidden="true" tabindex="-1"></a><span class="cf">await</span> server.start()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-display"> | |
| <script> | |
| document.body.addEventListener('htmx:configRequest', (event) => { | |
| if(event.detail.path.includes('://')) return; | |
| htmx.config.selfRequestsOnly=false; | |
| event.detail.path = `${location.protocol}//${location.hostname}:8000${event.detail.path}`; | |
| }); | |
| </script> | |
| </div> | |
| </div> | |
| <div id="e4550d23" class="cell"> | |
| <div class="sourceCode cell-code" id="cb19"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a><span class="cf">async</span> <span class="cf">with</span> AsyncClient() <span class="im">as</span> client:</span> | |
| <span id="cb19-2"><a href="#cb19-2" aria-hidden="true" tabindex="-1"></a> r <span class="op">=</span> <span class="cf">await</span> client.get(<span class="ss">f'http://localhost:</span><span class="sc">{</span>port<span class="sc">}</span><span class="ss">'</span>)</span> | |
| <span id="cb19-3"><a href="#cb19-3" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(r.text)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-stdout"> | |
| <pre><code>hi</code></pre> | |
| </div> | |
| </div> | |
| <div id="7869af78" class="cell"> | |
| <div class="sourceCode cell-code" id="cb21"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a>server.stop()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| </section> | |
| <section id="using-a-notebook-as-a-web-app" class="level3"> | |
| <h3 class="anchored" data-anchor-id="using-a-notebook-as-a-web-app">Using a notebook as a web app</h3> | |
| <p>You can also run an HTMX web app directly in a notebook. To make this work, you have to add the default FastHTML headers to the DOM of the notebook with <code>show(*def_hdrs())</code>. Additionally, you might find it convenient to use <em>auto_id</em> mode, in which the ID of an <code>FT</code> object is automatically generated if not provided.</p> | |
| <div id="9c2a85b6" class="cell"> | |
| <div class="sourceCode cell-code" id="cb22"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb22-1"><a href="#cb22-1" aria-hidden="true" tabindex="-1"></a>fh_cfg[<span class="st">'auto_id'</span> ]<span class="op">=</span><span class="va">True</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| <p>After importing <code>fasthtml.jupyter</code> and calling <a href="https://www.fastht.ml/docs/api/jupyter.html#render_ft"><code>render_ft()</code></a>, FT components render directly in the notebook.</p> | |
| <div id="694cdab5" class="cell"> | |
| <div class="sourceCode cell-code" id="cb23"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb23-1"><a href="#cb23-1" aria-hidden="true" tabindex="-1"></a>show(<span class="op">*</span>def_hdrs())</span> | |
| <span id="cb23-2"><a href="#cb23-2" aria-hidden="true" tabindex="-1"></a>render_ft()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-display"> | |
| <meta charset="utf-8"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover"> | |
| <script src="https://unpkg.com/[email protected]/dist/htmx.min.js"></script><script src="https://cdn.jsdelivr.net/gh/answerdotai/[email protected]/fasthtml.js"></script><script src="https://cdn.jsdelivr.net/gh/answerdotai/surreal@main/surreal.js"></script><script src="https://cdn.jsdelivr.net/gh/gnat/css-scope-inline@main/script.js"></script><script id="_7KKmEIAnRE_-M4c4Lf5dJg">if (window.htmx) htmx.process(document.body)</script> | |
| </div> | |
| </div> | |
| <div id="cc1800a8" class="cell"> | |
| <div class="sourceCode cell-code" id="cb24"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb24-1"><a href="#cb24-1" aria-hidden="true" tabindex="-1"></a>(c <span class="op">:=</span> Div(<span class="st">'Cogito ergo sum'</span>))</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-display cell-output-markdown"> | |
| <div id="_NNvXojeGS-eH1SZLG-pE4Q"> | |
| <div id="_vzHRxQNEQiaSQnLdUFq2Mg"> | |
| Cogito ergo sum | |
| </div> | |
| <script id="_SN7to4-bQ5O09J6vs2UvNA">if (window.htmx) htmx.process(document.body)</script> | |
| </div> | |
| </div> | |
| </div> | |
| <p>Handlers are written just like a regular web app:</p> | |
| <div id="78d40711" class="cell"> | |
| <div class="sourceCode cell-code" id="cb25"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb25-1"><a href="#cb25-1" aria-hidden="true" tabindex="-1"></a>server <span class="op">=</span> JupyUvi(app, port<span class="op">=</span>port)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-display"> | |
| <script> | |
| document.body.addEventListener('htmx:configRequest', (event) => { | |
| if(event.detail.path.includes('://')) return; | |
| htmx.config.selfRequestsOnly=false; | |
| event.detail.path = `${location.protocol}//${location.hostname}:8000${event.detail.path}`; | |
| }); | |
| </script> | |
| </div> | |
| </div> | |
| <div id="17b96ef1" class="cell"> | |
| <div class="sourceCode cell-code" id="cb26"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb26-1"><a href="#cb26-1" aria-hidden="true" tabindex="-1"></a><span class="at">@rt</span></span> | |
| <span id="cb26-2"><a href="#cb26-2" aria-hidden="true" tabindex="-1"></a><span class="kw">def</span> hoho(): <span class="cf">return</span> P(<span class="st">'loaded!'</span>), Div(<span class="st">'hee hee'</span>, <span class="bu">id</span><span class="op">=</span>c, hx_swap_oob<span class="op">=</span><span class="st">'true'</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| <p>All the usual <code>hx_*</code> attributes can be used:</p> | |
| <div id="a694a095" class="cell"> | |
| <div class="sourceCode cell-code" id="cb27"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb27-1"><a href="#cb27-1" aria-hidden="true" tabindex="-1"></a>P(<span class="st">'not loaded'</span>, hx_get<span class="op">=</span>hoho, hx_trigger<span class="op">=</span><span class="st">'load'</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-display cell-output-markdown"> | |
| <div id="_l0IdURqdSRu46RNQQPmMvA"> | |
| <p hx-get="/hoho" hx-trigger="load" id="_WUPc1vlnQUStT30OWNXAHQ"> | |
| not loaded | |
| </p> | |
| <script id="_o4Z4wNOxQXum9LI9N-YhRw">if (window.htmx) htmx.process(document.body)</script> | |
| </div> | |
| </div> | |
| </div> | |
| <p>FT components can be used directly both as <code>id</code> values and as <code>hx_target</code> values.</p> | |
| <div id="d1116727" class="cell"> | |
| <div class="sourceCode cell-code" id="cb28"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb28-1"><a href="#cb28-1" aria-hidden="true" tabindex="-1"></a>(c <span class="op">:=</span> Div(<span class="st">''</span>))</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-display cell-output-markdown"> | |
| <div id="_C4mtvDiLQPyjFBL_N9guOQ"> | |
| <div id="_dazDkLiNRi_5IRjKxnDApQ"> | |
| </div> | |
| <script id="_wBaWxkrPTeyFjAjoTOAjaw">if (window.htmx) htmx.process(document.body)</script> | |
| </div> | |
| </div> | |
| </div> | |
| <div id="9a79b3e5" class="cell"> | |
| <div class="sourceCode cell-code" id="cb29"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb29-1"><a href="#cb29-1" aria-hidden="true" tabindex="-1"></a><span class="at">@rt</span></span> | |
| <span id="cb29-2"><a href="#cb29-2" aria-hidden="true" tabindex="-1"></a><span class="kw">def</span> foo(): <span class="cf">return</span> Div(<span class="st">'foo bar'</span>)</span> | |
| <span id="cb29-3"><a href="#cb29-3" aria-hidden="true" tabindex="-1"></a>P(<span class="st">'hi'</span>, hx_get<span class="op">=</span>foo, hx_trigger<span class="op">=</span><span class="st">'load'</span>, hx_target<span class="op">=</span>c)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-display cell-output-markdown"> | |
| <div id="_mmZ8zN0IQRWcwaaJuPD17g"> | |
| <p hx-get="/foo" hx-trigger="load" hx-target="#_dazDkLiNRi_5IRjKxnDApQ" id="_21sjPwFeSPKp3vncj4YJrQ"> | |
| hi | |
| </p> | |
| <script id="_iy4Ov4wQRsuuB6ekh8semw">if (window.htmx) htmx.process(document.body)</script> | |
| </div> | |
| </div> | |
| </div> | |
| <div id="c5b33bfd" class="cell"> | |
| <div class="sourceCode cell-code" id="cb30"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb30-1"><a href="#cb30-1" aria-hidden="true" tabindex="-1"></a>server.stop()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| </section> | |
| <section id="running-apps-in-an-iframe" class="level3"> | |
| <h3 class="anchored" data-anchor-id="running-apps-in-an-iframe">Running apps in an IFrame</h3> | |
| <p>Using an IFrame can be a good idea to get complete isolation of the styles and scripts in an app. The <a href="https://www.fastht.ml/docs/api/jupyter.html#htmx"><code>HTMX</code></a> function creates an auto-sizing IFrame for a web app.</p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/jupyter.py#L114" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="htmx" class="level3"> | |
| <h3 class="anchored" data-anchor-id="htmx">HTMX</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> HTMX (path='', app=None, host='localhost', port=8000, height='auto', | |
| link=False, iframe=True)</code></pre> | |
| </blockquote> | |
| <p><em>An iframe which displays the HTMX application in a notebook.</em></p> | |
| <div id="cf152565" class="cell"> | |
| <div class="sourceCode cell-code" id="cb32"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb32-1"><a href="#cb32-1" aria-hidden="true" tabindex="-1"></a><span class="at">@rt</span></span> | |
| <span id="cb32-2"><a href="#cb32-2" aria-hidden="true" tabindex="-1"></a><span class="kw">def</span> index():</span> | |
| <span id="cb32-3"><a href="#cb32-3" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> Div(</span> | |
| <span id="cb32-4"><a href="#cb32-4" aria-hidden="true" tabindex="-1"></a> P(A(<span class="st">'Click me'</span>, hx_get<span class="op">=</span>update, hx_target<span class="op">=</span><span class="st">'#result'</span>)),</span> | |
| <span id="cb32-5"><a href="#cb32-5" aria-hidden="true" tabindex="-1"></a> P(A(<span class="st">'No me!'</span>, hx_get<span class="op">=</span>update, hx_target<span class="op">=</span><span class="st">'#result'</span>)),</span> | |
| <span id="cb32-6"><a href="#cb32-6" aria-hidden="true" tabindex="-1"></a> Div(<span class="bu">id</span><span class="op">=</span><span class="st">'result'</span>))</span> | |
| <span id="cb32-7"><a href="#cb32-7" aria-hidden="true" tabindex="-1"></a></span> | |
| <span id="cb32-8"><a href="#cb32-8" aria-hidden="true" tabindex="-1"></a><span class="at">@rt</span></span> | |
| <span id="cb32-9"><a href="#cb32-9" aria-hidden="true" tabindex="-1"></a><span class="kw">def</span> update(): <span class="cf">return</span> Div(P(<span class="st">'Hi!'</span>),P(<span class="st">'There!'</span>))</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| <div id="21cb0c40" class="cell"> | |
| <div class="sourceCode cell-code" id="cb33"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb33-1"><a href="#cb33-1" aria-hidden="true" tabindex="-1"></a>server.start()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| <div id="0063bb43" class="cell"> | |
| <div class="sourceCode cell-code" id="cb34"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb34-1"><a href="#cb34-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Run the notebook locally to see the HTMX iframe in action</span></span> | |
| <span id="cb34-2"><a href="#cb34-2" aria-hidden="true" tabindex="-1"></a>HTMX()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| <div class="cell-output cell-output-display"> | |
| <iframe src="http://localhost:8000" style="width: 100%; height: auto; border: none;" onload="{ | |
| let frame = this; | |
| window.addEventListener('message', function(e) { | |
| if (e.source !== frame.contentWindow) return; // Only proceed if the message is from this iframe | |
| if (e.data.height) frame.style.height = (e.data.height+1) + 'px'; | |
| }, false); | |
| }" allow="accelerometer; autoplay; camera; clipboard-read; clipboard-write; display-capture; encrypted-media; fullscreen; gamepad; geolocation; gyroscope; hid; identity-credentials-get; idle-detection; magnetometer; microphone; midi; payment; picture-in-picture; publickey-credentials-get; screen-wake-lock; serial; usb; web-share; xr-spatial-tracking"></iframe> | |
| </div> | |
| </div> | |
| <div id="dfc3271d" class="cell"> | |
| <div class="sourceCode cell-code" id="cb35"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb35-1"><a href="#cb35-1" aria-hidden="true" tabindex="-1"></a>server.stop()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/jupyter.py#L135" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="ws_client" class="level3"> | |
| <h3 class="anchored" data-anchor-id="ws_client">ws_client</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> ws_client (app, nm='', host='localhost', port=8000, ws_connect='/ws', | |
| frame=True, link=True, **kwargs)</code></pre> | |
| </blockquote> | |
| </section> | |
| </section> | |
| </main> <!-- /main --> | |
| <script id="quarto-html-after-body" type="application/javascript"> | |
| window.document.addEventListener("DOMContentLoaded", function (event) { | |
| const toggleBodyColorMode = (bsSheetEl) => { | |
| const mode = bsSheetEl.getAttribute("data-mode"); | |
| const bodyEl = window.document.querySelector("body"); | |
| if (mode === "dark") { | |
| bodyEl.classList.add("quarto-dark"); | |
| bodyEl.classList.remove("quarto-light"); | |
| } else { | |
| bodyEl.classList.add("quarto-light"); | |
| bodyEl.classList.remove("quarto-dark"); | |
| } | |
| } | |
| const toggleBodyColorPrimary = () => { | |
| const bsSheetEl = window.document.querySelector("link#quarto-bootstrap"); | |
| if (bsSheetEl) { | |
| toggleBodyColorMode(bsSheetEl); | |
| } | |
| } | |
| toggleBodyColorPrimary(); | |
| const icon = ""; | |
| const anchorJS = new window.AnchorJS(); | |
| anchorJS.options = { | |
| placement: 'right', | |
| icon: icon | |
| }; | |
| anchorJS.add('.anchored'); | |
| const isCodeAnnotation = (el) => { | |
| for (const clz of el.classList) { | |
| if (clz.startsWith('code-annotation-')) { | |
| return true; | |
| } | |
| } | |
| return false; | |
| } | |
| const onCopySuccess = function(e) { | |
| // button target | |
| const button = e.trigger; | |
| // don't keep focus | |
| button.blur(); | |
| // flash "checked" | |
| button.classList.add('code-copy-button-checked'); | |
| var currentTitle = button.getAttribute("title"); | |
| button.setAttribute("title", "Copied!"); | |
| let tooltip; | |
| if (window.bootstrap) { | |
| button.setAttribute("data-bs-toggle", "tooltip"); | |
| button.setAttribute("data-bs-placement", "left"); | |
| button.setAttribute("data-bs-title", "Copied!"); | |
| tooltip = new bootstrap.Tooltip(button, | |
| { trigger: "manual", | |
| customClass: "code-copy-button-tooltip", | |
| offset: [0, -8]}); | |
| tooltip.show(); | |
| } | |
| setTimeout(function() { | |
| if (tooltip) { | |
| tooltip.hide(); | |
| button.removeAttribute("data-bs-title"); | |
| button.removeAttribute("data-bs-toggle"); | |
| button.removeAttribute("data-bs-placement"); | |
| } | |
| button.setAttribute("title", currentTitle); | |
| button.classList.remove('code-copy-button-checked'); | |
| }, 1000); | |
| // clear code selection | |
| e.clearSelection(); | |
| } | |
| const getTextToCopy = function(trigger) { | |
| const codeEl = trigger.previousElementSibling.cloneNode(true); | |
| for (const childEl of codeEl.children) { | |
| if (isCodeAnnotation(childEl)) { | |
| childEl.remove(); | |
| } | |
| } | |
| return codeEl.innerText; | |
| } | |
| const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', { | |
| text: getTextToCopy | |
| }); | |
| clipboard.on('success', onCopySuccess); | |
| if (window.document.getElementById('quarto-embedded-source-code-modal')) { | |
| const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', { | |
| text: getTextToCopy, | |
| container: window.document.getElementById('quarto-embedded-source-code-modal') | |
| }); | |
| clipboardModal.on('success', onCopySuccess); | |
| } | |
| var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//); | |
| var mailtoRegex = new RegExp(/^mailto:/); | |
| var filterRegex = new RegExp("https:\/\/www\.fastht\.ml\/docs\/"); | |
| var isInternal = (href) => { | |
| return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href); | |
| } | |
| // Inspect non-navigation links and adorn them if external | |
| var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)'); | |
| for (var i=0; i<links.length; i++) { | |
| const link = links[i]; | |
| if (!isInternal(link.href)) { | |
| // undo the damage that might have been done by quarto-nav.js in the case of | |
| // links that we want to consider external | |
| if (link.dataset.originalHref !== undefined) { | |
| link.href = link.dataset.originalHref; | |
| } | |
| } | |
| } | |
| function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) { | |
| const config = { | |
| allowHTML: true, | |
| maxWidth: 500, | |
| delay: 100, | |
| arrow: false, | |
| appendTo: function(el) { | |
| return el.parentElement; | |
| }, | |
| interactive: true, | |
| interactiveBorder: 10, | |
| theme: 'quarto', | |
| placement: 'bottom-start', | |
| }; | |
| if (contentFn) { | |
| config.content = contentFn; | |
| } | |
| if (onTriggerFn) { | |
| config.onTrigger = onTriggerFn; | |
| } | |
| if (onUntriggerFn) { | |
| config.onUntrigger = onUntriggerFn; | |
| } | |
| window.tippy(el, config); | |
| } | |
| const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]'); | |
| for (var i=0; i<noterefs.length; i++) { | |
| const ref = noterefs[i]; | |
| tippyHover(ref, function() { | |
| // use id or data attribute instead here | |
| let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href'); | |
| try { href = new URL(href).hash; } catch {} | |
| const id = href.replace(/^#\/?/, ""); | |
| const note = window.document.getElementById(id); | |
| if (note) { | |
| return note.innerHTML; | |
| } else { | |
| return ""; | |
| } | |
| }); | |
| } | |
| const xrefs = window.document.querySelectorAll('a.quarto-xref'); | |
| const processXRef = (id, note) => { | |
| // Strip column container classes | |
| const stripColumnClz = (el) => { | |
| el.classList.remove("page-full", "page-columns"); | |
| if (el.children) { | |
| for (const child of el.children) { | |
| stripColumnClz(child); | |
| } | |
| } | |
| } | |
| stripColumnClz(note) | |
| if (id === null || id.startsWith('sec-')) { | |
| // Special case sections, only their first couple elements | |
| const container = document.createElement("div"); | |
| if (note.children && note.children.length > 2) { | |
| container.appendChild(note.children[0].cloneNode(true)); | |
| for (let i = 1; i < note.children.length; i++) { | |
| const child = note.children[i]; | |
| if (child.tagName === "P" && child.innerText === "") { | |
| continue; | |
| } else { | |
| container.appendChild(child.cloneNode(true)); | |
| break; | |
| } | |
| } | |
| if (window.Quarto?.typesetMath) { | |
| window.Quarto.typesetMath(container); | |
| } | |
| return container.innerHTML | |
| } else { | |
| if (window.Quarto?.typesetMath) { | |
| window.Quarto.typesetMath(note); | |
| } | |
| return note.innerHTML; | |
| } | |
| } else { | |
| // Remove any anchor links if they are present | |
| const anchorLink = note.querySelector('a.anchorjs-link'); | |
| if (anchorLink) { | |
| anchorLink.remove(); | |
| } | |
| if (window.Quarto?.typesetMath) { | |
| window.Quarto.typesetMath(note); | |
| } | |
| if (note.classList.contains("callout")) { | |
| return note.outerHTML; | |
| } else { | |
| return note.innerHTML; | |
| } | |
| } | |
| } | |
| for (var i=0; i<xrefs.length; i++) { | |
| const xref = xrefs[i]; | |
| tippyHover(xref, undefined, function(instance) { | |
| instance.disable(); | |
| let url = xref.getAttribute('href'); | |
| let hash = undefined; | |
| if (url.startsWith('#')) { | |
| hash = url; | |
| } else { | |
| try { hash = new URL(url).hash; } catch {} | |
| } | |
| if (hash) { | |
| const id = hash.replace(/^#\/?/, ""); | |
| const note = window.document.getElementById(id); | |
| if (note !== null) { | |
| try { | |
| const html = processXRef(id, note.cloneNode(true)); | |
| instance.setContent(html); | |
| } finally { | |
| instance.enable(); | |
| instance.show(); | |
| } | |
| } else { | |
| // See if we can fetch this | |
| fetch(url.split('#')[0]) | |
| .then(res => res.text()) | |
| .then(html => { | |
| const parser = new DOMParser(); | |
| const htmlDoc = parser.parseFromString(html, "text/html"); | |
| const note = htmlDoc.getElementById(id); | |
| if (note !== null) { | |
| const html = processXRef(id, note); | |
| instance.setContent(html); | |
| } | |
| }).finally(() => { | |
| instance.enable(); | |
| instance.show(); | |
| }); | |
| } | |
| } else { | |
| // See if we can fetch a full url (with no hash to target) | |
| // This is a special case and we should probably do some content thinning / targeting | |
| fetch(url) | |
| .then(res => res.text()) | |
| .then(html => { | |
| const parser = new DOMParser(); | |
| const htmlDoc = parser.parseFromString(html, "text/html"); | |
| const note = htmlDoc.querySelector('main.content'); | |
| if (note !== null) { | |
| // This should only happen for chapter cross references | |
| // (since there is no id in the URL) | |
| // remove the first header | |
| if (note.children.length > 0 && note.children[0].tagName === "HEADER") { | |
| note.children[0].remove(); | |
| } | |
| const html = processXRef(null, note); | |
| instance.setContent(html); | |
| } | |
| }).finally(() => { | |
| instance.enable(); | |
| instance.show(); | |
| }); | |
| } | |
| }, function(instance) { | |
| }); | |
| } | |
| let selectedAnnoteEl; | |
| const selectorForAnnotation = ( cell, annotation) => { | |
| let cellAttr = 'data-code-cell="' + cell + '"'; | |
| let lineAttr = 'data-code-annotation="' + annotation + '"'; | |
| const selector = 'span[' + cellAttr + '][' + lineAttr + ']'; | |
| return selector; | |
| } | |
| const selectCodeLines = (annoteEl) => { | |
| const doc = window.document; | |
| const targetCell = annoteEl.getAttribute("data-target-cell"); | |
| const targetAnnotation = annoteEl.getAttribute("data-target-annotation"); | |
| const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation)); | |
| const lines = annoteSpan.getAttribute("data-code-lines").split(","); | |
| const lineIds = lines.map((line) => { | |
| return targetCell + "-" + line; | |
| }) | |
| let top = null; | |
| let height = null; | |
| let parent = null; | |
| if (lineIds.length > 0) { | |
| //compute the position of the single el (top and bottom and make a div) | |
| const el = window.document.getElementById(lineIds[0]); | |
| top = el.offsetTop; | |
| height = el.offsetHeight; | |
| parent = el.parentElement.parentElement; | |
| if (lineIds.length > 1) { | |
| const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]); | |
| const bottom = lastEl.offsetTop + lastEl.offsetHeight; | |
| height = bottom - top; | |
| } | |
| if (top !== null && height !== null && parent !== null) { | |
| // cook up a div (if necessary) and position it | |
| let div = window.document.getElementById("code-annotation-line-highlight"); | |
| if (div === null) { | |
| div = window.document.createElement("div"); | |
| div.setAttribute("id", "code-annotation-line-highlight"); | |
| div.style.position = 'absolute'; | |
| parent.appendChild(div); | |
| } | |
| div.style.top = top - 2 + "px"; | |
| div.style.height = height + 4 + "px"; | |
| div.style.left = 0; | |
| let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter"); | |
| if (gutterDiv === null) { | |
| gutterDiv = window.document.createElement("div"); | |
| gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter"); | |
| gutterDiv.style.position = 'absolute'; | |
| const codeCell = window.document.getElementById(targetCell); | |
| const gutter = codeCell.querySelector('.code-annotation-gutter'); | |
| gutter.appendChild(gutterDiv); | |
| } | |
| gutterDiv.style.top = top - 2 + "px"; | |
| gutterDiv.style.height = height + 4 + "px"; | |
| } | |
| selectedAnnoteEl = annoteEl; | |
| } | |
| }; | |
| const unselectCodeLines = () => { | |
| const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"]; | |
| elementsIds.forEach((elId) => { | |
| const div = window.document.getElementById(elId); | |
| if (div) { | |
| div.remove(); | |
| } | |
| }); | |
| selectedAnnoteEl = undefined; | |
| }; | |
| // Handle positioning of the toggle | |
| window.addEventListener( | |
| "resize", | |
| throttle(() => { | |
| elRect = undefined; | |
| if (selectedAnnoteEl) { | |
| selectCodeLines(selectedAnnoteEl); | |
| } | |
| }, 10) | |
| ); | |
| function throttle(fn, ms) { | |
| let throttle = false; | |
| let timer; | |
| return (...args) => { | |
| if(!throttle) { // first call gets through | |
| fn.apply(this, args); | |
| throttle = true; | |
| } else { // all the others get throttled | |
| if(timer) clearTimeout(timer); // cancel #2 | |
| timer = setTimeout(() => { | |
| fn.apply(this, args); | |
| timer = throttle = false; | |
| }, ms); | |
| } | |
| }; | |
| } | |
| // Attach click handler to the DT | |
| const annoteDls = window.document.querySelectorAll('dt[data-target-cell]'); | |
| for (const annoteDlNode of annoteDls) { | |
| annoteDlNode.addEventListener('click', (event) => { | |
| const clickedEl = event.target; | |
| if (clickedEl !== selectedAnnoteEl) { | |
| unselectCodeLines(); | |
| const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active'); | |
| if (activeEl) { | |
| activeEl.classList.remove('code-annotation-active'); | |
| } | |
| selectCodeLines(clickedEl); | |
| clickedEl.classList.add('code-annotation-active'); | |
| } else { | |
| // Unselect the line | |
| unselectCodeLines(); | |
| clickedEl.classList.remove('code-annotation-active'); | |
| } | |
| }); | |
| } | |
| const findCites = (el) => { | |
| const parentEl = el.parentElement; | |
| if (parentEl) { | |
| const cites = parentEl.dataset.cites; | |
| if (cites) { | |
| return { | |
| el, | |
| cites: cites.split(' ') | |
| }; | |
| } else { | |
| return findCites(el.parentElement) | |
| } | |
| } else { | |
| return undefined; | |
| } | |
| }; | |
| var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]'); | |
| for (var i=0; i<bibliorefs.length; i++) { | |
| const ref = bibliorefs[i]; | |
| const citeInfo = findCites(ref); | |
| if (citeInfo) { | |
| tippyHover(citeInfo.el, function() { | |
| var popup = window.document.createElement('div'); | |
| citeInfo.cites.forEach(function(cite) { | |
| var citeDiv = window.document.createElement('div'); | |
| citeDiv.classList.add('hanging-indent'); | |
| citeDiv.classList.add('csl-entry'); | |
| var biblioDiv = window.document.getElementById('ref-' + cite); | |
| if (biblioDiv) { | |
| citeDiv.innerHTML = biblioDiv.innerHTML; | |
| } | |
| popup.appendChild(citeDiv); | |
| }); | |
| return popup.innerHTML; | |
| }); | |
| } | |
| } | |
| }); | |
| </script> | |
| </div> <!-- /content --> | |
| <footer class="footer"><div class="nav-footer"><div class="nav-footer-center"><div class="toc-actions d-sm-block d-md-none"><ul><li><a href="https://github.com/AnswerDotAI/fasthtml/issues/new" class="toc-action"><i class="bi bi-github"></i>Report an issue</a></li></ul></div></div></div></footer></body></html> |