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="Frequently Asked Questions"> | |
<title>FAQ – 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="../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> | |
<link rel="stylesheet" href="../styles.css"> | |
<meta property="og:title" content="FAQ – fasthtml"> | |
<meta property="og:description" content="Frequently Asked Questions"> | |
<meta property="og:site_name" content="fasthtml"> | |
<meta name="twitter:title" content="FAQ – fasthtml"> | |
<meta name="twitter:description" content="Frequently Asked Questions"> | |
<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/explains/faq.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="../explains/background_tasks.html">Explanations</a></li><li class="breadcrumb-item"><a href="../explains/faq.html">FAQ</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 active"> | |
<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"> | |
<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="#why-does-my-editor-say-that-i-have-errors-in-my-fasthtml-code" id="toc-why-does-my-editor-say-that-i-have-errors-in-my-fasthtml-code" class="nav-link active" data-scroll-target="#why-does-my-editor-say-that-i-have-errors-in-my-fasthtml-code">Why does my editor say that I have errors in my FastHTML code?</a></li> | |
<li><a href="#why-the-distinctive-coding-style" id="toc-why-the-distinctive-coding-style" class="nav-link" data-scroll-target="#why-the-distinctive-coding-style">Why the distinctive coding style?</a></li> | |
<li><a href="#why-not-jsx" id="toc-why-not-jsx" class="nav-link" data-scroll-target="#why-not-jsx">Why not JSX?</a></li> | |
<li><a href="#why-use-import" id="toc-why-use-import" class="nav-link" data-scroll-target="#why-use-import">Why use <code>import *</code></a></li> | |
<li><a href="#can-fasthtml-be-used-for-dashboards" id="toc-can-fasthtml-be-used-for-dashboards" class="nav-link" data-scroll-target="#can-fasthtml-be-used-for-dashboards">Can FastHTML be used for dashboards?</a></li> | |
<li><a href="#why-is-fasthtml-developed-using-notebooks" id="toc-why-is-fasthtml-developed-using-notebooks" class="nav-link" data-scroll-target="#why-is-fasthtml-developed-using-notebooks">Why is FastHTML developed using notebooks?</a></li> | |
<li><a href="#why-not-pyproject.toml-for-packaging" id="toc-why-not-pyproject.toml-for-packaging" class="nav-link" data-scroll-target="#why-not-pyproject.toml-for-packaging">Why not pyproject.toml for packaging?</a></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="faq.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="../explains/background_tasks.html">Explanations</a></li><li class="breadcrumb-item"><a href="../explains/faq.html">FAQ</a></li></ol></nav> | |
<div class="quarto-title"> | |
<h1 class="title">FAQ</h1> | |
</div> | |
<div> | |
<div class="description"> | |
Frequently Asked Questions | |
</div> | |
</div> | |
<div class="quarto-title-meta"> | |
</div> | |
</header> | |
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! --> | |
<section id="why-does-my-editor-say-that-i-have-errors-in-my-fasthtml-code" class="level2"> | |
<h2 class="anchored" data-anchor-id="why-does-my-editor-say-that-i-have-errors-in-my-fasthtml-code">Why does my editor say that I have errors in my FastHTML code?</h2> | |
<p>Many editors, including Visual Studio Code, use PyLance to provide error checking for Python. However, PyLance’s error checking is just a guess – it can’t actually know whether your code is correct or not. PyLance particularly struggles with FastHTML’s syntax, which leads to it often reporting false error messages in FastHTML projects.</p> | |
<p>To avoid these misleading error messages, it’s best to disable some PyLance error checking in your FastHTML projects. Here’s how to do it in Visual Studio Code (the same approach should also work in other editors based on vscode, such as Cursor and GitHub Codespaces):</p> | |
<ol type="1"> | |
<li>Open your FastHTML project</li> | |
<li>Press <code>Ctrl+Shift+P</code> (or <code>Cmd+Shift+P</code> on Mac) to open the Command Palette</li> | |
<li>Type “Preferences: Open Workspace Settings (JSON)” and select it</li> | |
<li>In the JSON file that opens, add the following lines:</li> | |
</ol> | |
<div class="sourceCode" id="cb1"><pre class="sourceCode json code-with-copy"><code class="sourceCode json"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span> | |
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">"python.analysis.diagnosticSeverityOverrides"</span><span class="fu">:</span> <span class="fu">{</span></span> | |
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">"reportGeneralTypeIssues"</span><span class="fu">:</span> <span class="st">"none"</span><span class="fu">,</span></span> | |
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">"reportOptionalMemberAccess"</span><span class="fu">:</span> <span class="st">"none"</span><span class="fu">,</span></span> | |
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">"reportWildcardImportFromLibrary"</span><span class="fu">:</span> <span class="st">"none"</span><span class="fu">,</span></span> | |
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">"reportRedeclaration"</span><span class="fu">:</span> <span class="st">"none"</span><span class="fu">,</span></span> | |
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">"reportAttributeAccessIssue"</span><span class="fu">:</span> <span class="st">"none"</span><span class="fu">,</span></span> | |
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">"reportInvalidTypeForm"</span><span class="fu">:</span> <span class="st">"none"</span><span class="fu">,</span></span> | |
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">"reportAssignmentType"</span><span class="fu">:</span> <span class="st">"none"</span><span class="fu">,</span></span> | |
<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span> | |
<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
<ol start="5" type="1"> | |
<li>Save the file</li> | |
</ol> | |
<p>Even with PyLance diagnostics turned off, your FastHTML code will still run correctly. If you’re still seeing some false errors from PyLance, you can disable it entirely by adding this to your settings:</p> | |
<div class="sourceCode" id="cb2"><pre class="sourceCode json code-with-copy"><code class="sourceCode json"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span> | |
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">"python.analysis.ignore"</span><span class="fu">:</span> <span class="ot">[</span> <span class="st">"*"</span> <span class="ot">]</span></span> | |
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
</section> | |
<section id="why-the-distinctive-coding-style" class="level2"> | |
<h2 class="anchored" data-anchor-id="why-the-distinctive-coding-style">Why the distinctive coding style?</h2> | |
<p>FastHTML coding style is the <a href="https://fast.ai/docs/dev/style.html">fastai coding style</a>.</p> | |
<p>If you are coming from a data science background the <strong>fastai coding style</strong> may already be your preferred style.</p> | |
<p>If you are coming from a PEP-8 background where the use of ruff is encouraged, there is a learning curve. However, once you get used to the <strong>fastai coding style</strong> you may discover yourself appreciating the concise nature of this style. It also encourages using more functional programming tooling, which is both productive and fun. Having said that, it’s entirely optional!</p> | |
</section> | |
<section id="why-not-jsx" class="level2"> | |
<h2 class="anchored" data-anchor-id="why-not-jsx">Why not JSX?</h2> | |
<p>Many have asked! We think there’s no benefit… Python’s positional and kw args precisely 1:1 map already to html/xml children and attrs, so there’s no need for a new syntax.</p> | |
<p>We wrote some more thoughts on Why Python HTML components over Jinja2, Mako, or JSX <a href="https://www.answer.ai/posts/2024-08-03-fasthtml.html#why">here</a>.</p> | |
</section> | |
<section id="why-use-import" class="level2"> | |
<h2 class="anchored" data-anchor-id="why-use-import">Why use <code>import *</code></h2> | |
<p>First, through the use of the <a href="https://docs.python.org/3/tutorial/modules.html#importing-from-a-package"><code>__all__</code></a> attribute in our Python modules we control what actually gets imported. So there’s no risk of namespace pollution.</p> | |
<p>Second, our style lends itself to working in rather compact Jupyter notebooks and small Python modules. Hence we know about the source code whose libraries we <code>import *</code> from. This terseness means we can develop faster. We’re a small team, and any edge we can gain is important to us.</p> | |
<p>Third, for external libraries, be it core Python, SQLAlchemy, or other things we do tend to use explicit imports. In part to avoid namespace collisions, and also as reference to know where things are coming from.</p> | |
<p>We’ll finish by saying a lot of our users employ explicit imports. If that’s the path you want to take, we encourage the use of <code>from fasthtml import common as fh</code>. The acronym of <code>fh</code> makes it easy to recognize that a symbol is from the FastHTML library.</p> | |
</section> | |
<section id="can-fasthtml-be-used-for-dashboards" class="level2"> | |
<h2 class="anchored" data-anchor-id="can-fasthtml-be-used-for-dashboards">Can FastHTML be used for dashboards?</h2> | |
<p>Yes it can. In fact, it excels at building dashboards. In addition to being great for building static dashboards, because of its <a href="https://fastht.ml/about/foundation">foundation</a> in ASGI and <a href="https://fastht.ml/about/tech">tech stack</a>, FastHTML natively supports Websockets. That means using FastHTML we can create dashboards that autoupdate.</p> | |
</section> | |
<section id="why-is-fasthtml-developed-using-notebooks" class="level2"> | |
<h2 class="anchored" data-anchor-id="why-is-fasthtml-developed-using-notebooks">Why is FastHTML developed using notebooks?</h2> | |
<p>Some people are under the impression that writing software in notebooks is bad.</p> | |
<p><a href="https://www.youtube.com/watch?v=9Q6sLbz37gk&ab_channel=JeremyHoward">Watch this video</a>. We’ve used Jupyter notebooks exported via <code>nbdev</code> to write a wide range of “very serious” software projects over the last three years. This includes deep learning libraries, API clients, Python language extensions, terminal user interfaces, web frameworks, and more!</p> | |
<p><a href="https://nbdev.fast.ai/">nbdev</a> is a Jupyter-powered tool for writing software. Traditional programming environments throw away the result of your exploration in REPLs or notebooks. <code>nbdev</code> makes exploration an integral part of your workflow, all while promoting software engineering best practices.</p> | |
</section> | |
<section id="why-not-pyproject.toml-for-packaging" class="level2"> | |
<h2 class="anchored" data-anchor-id="why-not-pyproject.toml-for-packaging">Why not pyproject.toml for packaging?</h2> | |
<p>FastHTML uses a <code>setup.py</code> module instead of a <code>pyproject.toml</code> file to configure itself for installation. The reason for this is <code>pyproject.toml</code> is not compatible with <a href="https://nbdev.fast.ai/">nbdev</a>, which is what is used to write and build FastHTML.</p> | |
<p>The nbdev project spent around a year trying to move to pyproject.toml but there was insufficient functionality in the toml-based approach to complete the transition.</p> | |
</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> |