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="Basic scaffolding for handling OAuth"> | |
| <title>OAuth – 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="OAuth – fasthtml"> | |
| <meta property="og:description" content="Basic scaffolding for handling OAuth"> | |
| <meta property="og:site_name" content="fasthtml"> | |
| <meta name="twitter:title" content="OAuth – fasthtml"> | |
| <meta name="twitter:description" content="Basic scaffolding for handling OAuth"> | |
| <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/oauth.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/oauth.html">OAuth</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"> | |
| <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 active"> | |
| <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="#googleappclient" id="toc-googleappclient" class="nav-link active" data-scroll-target="#googleappclient">GoogleAppClient</a></li> | |
| <li><a href="#githubappclient" id="toc-githubappclient" class="nav-link" data-scroll-target="#githubappclient">GitHubAppClient</a></li> | |
| <li><a href="#huggingfaceclient" id="toc-huggingfaceclient" class="nav-link" data-scroll-target="#huggingfaceclient">HuggingFaceClient</a></li> | |
| <li><a href="#discordappclient" id="toc-discordappclient" class="nav-link" data-scroll-target="#discordappclient">DiscordAppClient</a></li> | |
| <li><a href="#auth0appclient" id="toc-auth0appclient" class="nav-link" data-scroll-target="#auth0appclient">Auth0AppClient</a></li> | |
| <li><a href="#webapplicationclient.login_link" id="toc-webapplicationclient.login_link" class="nav-link" data-scroll-target="#webapplicationclient.login_link">WebApplicationClient.login_link</a></li> | |
| <li><a href="#redir_url" id="toc-redir_url" class="nav-link" data-scroll-target="#redir_url">redir_url</a></li> | |
| <li><a href="#appclient.parse_response" id="toc-appclient.parse_response" class="nav-link" data-scroll-target="#appclient.parse_response">_AppClient.parse_response</a></li> | |
| <li><a href="#appclient.get_info" id="toc-appclient.get_info" class="nav-link" data-scroll-target="#appclient.get_info">_AppClient.get_info</a></li> | |
| <li><a href="#appclient.retr_info" id="toc-appclient.retr_info" class="nav-link" data-scroll-target="#appclient.retr_info">_AppClient.retr_info</a></li> | |
| <li><a href="#appclient.retr_id" id="toc-appclient.retr_id" class="nav-link" data-scroll-target="#appclient.retr_id">_AppClient.retr_id</a></li> | |
| <li><a href="#url_match" id="toc-url_match" class="nav-link" data-scroll-target="#url_match">url_match</a></li> | |
| <li><a href="#oauth" id="toc-oauth" class="nav-link" data-scroll-target="#oauth">OAuth</a></li> | |
| <li><a href="#google-helpers" id="toc-google-helpers" class="nav-link" data-scroll-target="#google-helpers">Google helpers</a></li> | |
| <li><a href="#googleappclient.consent_url" id="toc-googleappclient.consent_url" class="nav-link" data-scroll-target="#googleappclient.consent_url">GoogleAppClient.consent_url</a></li> | |
| <li><a href="#googleappclient.consent_url-1" id="toc-googleappclient.consent_url-1" class="nav-link" data-scroll-target="#googleappclient.consent_url-1">GoogleAppClient.consent_url</a></li> | |
| <li><a href="#credentials.update" id="toc-credentials.update" class="nav-link" data-scroll-target="#credentials.update">Credentials.update</a></li> | |
| <li><a href="#credentials.update-1" id="toc-credentials.update-1" class="nav-link" data-scroll-target="#credentials.update-1">Credentials.update</a></li> | |
| <li><a href="#credentials.save" id="toc-credentials.save" class="nav-link" data-scroll-target="#credentials.save">Credentials.save</a></li> | |
| <li><a href="#credentials.save-1" id="toc-credentials.save-1" class="nav-link" data-scroll-target="#credentials.save-1">Credentials.save</a></li> | |
| <li><a href="#load_creds" id="toc-load_creds" class="nav-link" data-scroll-target="#load_creds">load_creds</a></li> | |
| <li><a href="#googleappclient.creds" id="toc-googleappclient.creds" class="nav-link" data-scroll-target="#googleappclient.creds">GoogleAppClient.creds</a></li> | |
| <li><a href="#googleappclient.creds-1" id="toc-googleappclient.creds-1" class="nav-link" data-scroll-target="#googleappclient.creds-1">GoogleAppClient.creds</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="oauth.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/oauth.html">OAuth</a></li></ol></nav> | |
| <div class="quarto-title"> | |
| <h1 class="title">OAuth</h1> | |
| </div> | |
| <div> | |
| <div class="description"> | |
| Basic scaffolding for handling OAuth | |
| </div> | |
| </div> | |
| <div class="quarto-title-meta"> | |
| </div> | |
| </header> | |
| <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! --> | |
| <p>See the <a href="https://www.fastht.ml/docs/explains/oauth.html">docs page</a> for an explanation of how to use this.</p> | |
| <div id="526a5ac8" 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> IPython.display <span class="im">import</span> Markdown</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/oauth.py#L23" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| <section id="googleappclient" class="level3"> | |
| <h3 class="anchored" data-anchor-id="googleappclient">GoogleAppClient</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> GoogleAppClient (client_id, client_secret, code=None, scope=None, | |
| project_id=None, **kwargs)</code></pre> | |
| </blockquote> | |
| <p><em>A <code>WebApplicationClient</code> for Google oauth2</em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L42" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="githubappclient" class="level3"> | |
| <h3 class="anchored" data-anchor-id="githubappclient">GitHubAppClient</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> GitHubAppClient (client_id, client_secret, code=None, scope=None, | |
| **kwargs)</code></pre> | |
| </blockquote> | |
| <p><em>A <code>WebApplicationClient</code> for GitHub oauth2</em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L54" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="huggingfaceclient" class="level3"> | |
| <h3 class="anchored" data-anchor-id="huggingfaceclient">HuggingFaceClient</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> HuggingFaceClient (client_id, client_secret, code=None, scope=None, | |
| state=None, **kwargs)</code></pre> | |
| </blockquote> | |
| <p><em>A <code>WebApplicationClient</code> for HuggingFace oauth2</em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L67" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="discordappclient" class="level3"> | |
| <h3 class="anchored" data-anchor-id="discordappclient">DiscordAppClient</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> DiscordAppClient (client_id, client_secret, is_user=False, perms=0, | |
| scope=None, **kwargs)</code></pre> | |
| </blockquote> | |
| <p><em>A <code>WebApplicationClient</code> for Discord oauth2</em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L98" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="auth0appclient" class="level3"> | |
| <h3 class="anchored" data-anchor-id="auth0appclient">Auth0AppClient</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> Auth0AppClient (domain, client_id, client_secret, code=None, scope=None, | |
| redirect_uri='', **kwargs)</code></pre> | |
| </blockquote> | |
| <p><em>A <code>WebApplicationClient</code> for Auth0 OAuth2</em></p> | |
| <div id="109bc501" class="cell"> | |
| <div class="sourceCode cell-code" id="cb7"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="co"># cli = GoogleAppClient.from_file('client_secret.json')</span></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/oauth.py#L117" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="webapplicationclient.login_link" class="level3"> | |
| <h3 class="anchored" data-anchor-id="webapplicationclient.login_link">WebApplicationClient.login_link</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> WebApplicationClient.login_link (redirect_uri, scope=None, state=None, | |
| **kwargs)</code></pre> | |
| </blockquote> | |
| <p><em>Get a login link for this client</em></p> | |
| <p>Generating a login link that sends the user to the OAuth provider is done with <code>client.login_link()</code>.</p> | |
| <p>It can sometimes be useful to pass state to the OAuth provider, so that when the user returns you can pick up where they left off. This can be done by passing the <code>state</code> parameter.</p> | |
| <div id="f4dff5df" class="cell"> | |
| <div class="sourceCode cell-code" id="cb9"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> fasthtml.jupyter <span class="im">import</span> <span class="op">*</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| <div id="bc9ce02a" 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>redir_path <span class="op">=</span> <span class="st">'/redirect'</span></span> | |
| <span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a>port <span class="op">=</span> <span class="dv">8000</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| <div id="b4dd67a9" 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>app,rt <span class="op">=</span> fast_app()</span> | |
| <span id="cb11-2"><a href="#cb11-2" 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> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L124" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="redir_url" class="level3"> | |
| <h3 class="anchored" data-anchor-id="redir_url">redir_url</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> redir_url (request, redir_path, scheme=None)</code></pre> | |
| </blockquote> | |
| <p><em>Get the redir url for the host in <code>request</code></em></p> | |
| <div id="7b86cd0c" 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><span class="at">@rt</span></span> | |
| <span id="cb13-2"><a href="#cb13-2" aria-hidden="true" tabindex="-1"></a><span class="kw">def</span> index(request):</span> | |
| <span id="cb13-3"><a href="#cb13-3" aria-hidden="true" tabindex="-1"></a> redir <span class="op">=</span> redir_url(request, redir_path)</span> | |
| <span id="cb13-4"><a href="#cb13-4" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> A(<span class="st">'login'</span>, href<span class="op">=</span>cli.login_link(redir), target<span class="op">=</span><span class="st">'_blank'</span>)</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/oauth.py#L131" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="appclient.parse_response" class="level3"> | |
| <h3 class="anchored" data-anchor-id="appclient.parse_response">_AppClient.parse_response</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> _AppClient.parse_response (code, redirect_uri)</code></pre> | |
| </blockquote> | |
| <p><em>Get the token from the oauth2 server response</em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L141" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="appclient.get_info" class="level3"> | |
| <h3 class="anchored" data-anchor-id="appclient.get_info">_AppClient.get_info</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> _AppClient.get_info (token=None)</code></pre> | |
| </blockquote> | |
| <p><em>Get the info for authenticated user</em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L149" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="appclient.retr_info" class="level3"> | |
| <h3 class="anchored" data-anchor-id="appclient.retr_info">_AppClient.retr_info</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> _AppClient.retr_info (code, redirect_uri)</code></pre> | |
| </blockquote> | |
| <p><em>Combines <code>parse_response</code> and <code>get_info</code></em></p> | |
| <div id="c705ea8d" class="cell"> | |
| <div class="sourceCode cell-code" id="cb17"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a><span class="at">@rt</span>(redir_path)</span> | |
| <span id="cb17-2"><a href="#cb17-2" aria-hidden="true" tabindex="-1"></a><span class="kw">def</span> get(request, code:<span class="bu">str</span>):</span> | |
| <span id="cb17-3"><a href="#cb17-3" aria-hidden="true" tabindex="-1"></a> redir <span class="op">=</span> redir_url(request, redir_path)</span> | |
| <span id="cb17-4"><a href="#cb17-4" aria-hidden="true" tabindex="-1"></a> info <span class="op">=</span> cli.retr_info(code, redir)</span> | |
| <span id="cb17-5"><a href="#cb17-5" aria-hidden="true" tabindex="-1"></a> <span class="cf">return</span> P(<span class="ss">f'Login successful for </span><span class="sc">{</span>info[<span class="st">"name"</span>]<span class="sc">}</span><span class="ss">!'</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| <div id="ce6f838d" 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><span class="co"># HTMX()</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div> | |
| </div> | |
| <div id="8c2d2261" 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>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/oauth.py#L156" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="appclient.retr_id" class="level3"> | |
| <h3 class="anchored" data-anchor-id="appclient.retr_id">_AppClient.retr_id</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> _AppClient.retr_id (code, redirect_uri)</code></pre> | |
| </blockquote> | |
| <p><em>Call <code>retr_info</code> and then return id/subscriber value</em></p> | |
| <p>After logging in via the provider, the user will be redirected back to the supplied redirect URL. The request to this URL will contain a <code>code</code> parameter, which is used to get an access token and fetch the user’s profile information. See <a href="https://www.fastht.ml/docs/explains/oauth.html">the explanation here</a> for a worked example. You can either:</p> | |
| <ul> | |
| <li>Use client.retr_info(code) to get all the profile information, or</li> | |
| <li>Use client.retr_id(code) to get just the user’s ID.</li> | |
| </ul> | |
| <p>After either of these calls, you can also access the access token (used to revoke access, for example) with <code>client.token["access_token"]</code>.</p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L162" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="url_match" class="level3"> | |
| <h3 class="anchored" data-anchor-id="url_match">url_match</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> url_match (url, patterns=('^(localhost|127\\.0\\.0\\.1)(:\\d+)?$',))</code></pre> | |
| </blockquote> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L166" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="oauth" class="level3"> | |
| <h3 class="anchored" data-anchor-id="oauth">OAuth</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> OAuth (app, cli, skip=None, redir_path='/redirect', error_path='/error', | |
| logout_path='/logout', login_path='/login', https=True, | |
| http_patterns=('^(localhost|127\\.0\\.0\\.1)(:\\d+)?$',))</code></pre> | |
| </blockquote> | |
| <p><em>Initialize self. See help(type(self)) for accurate signature.</em></p> | |
| </section> | |
| <section id="google-helpers" class="level3"> | |
| <h3 class="anchored" data-anchor-id="google-helpers">Google helpers</h3> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L216" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="googleappclient.consent_url" class="level3"> | |
| <h3 class="anchored" data-anchor-id="googleappclient.consent_url">GoogleAppClient.consent_url</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> GoogleAppClient.consent_url (proj=None)</code></pre> | |
| </blockquote> | |
| <p><em>Get Google OAuth consent screen URL</em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L216" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="googleappclient.consent_url-1" class="level3"> | |
| <h3 class="anchored" data-anchor-id="googleappclient.consent_url-1">GoogleAppClient.consent_url</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> GoogleAppClient.consent_url (proj=None)</code></pre> | |
| </blockquote> | |
| <p><em>Get Google OAuth consent screen URL</em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L224" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="credentials.update" class="level3"> | |
| <h3 class="anchored" data-anchor-id="credentials.update">Credentials.update</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> Credentials.update ()</code></pre> | |
| </blockquote> | |
| <p><em>Refresh the credentials if they are expired, and return them</em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L224" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="credentials.update-1" class="level3"> | |
| <h3 class="anchored" data-anchor-id="credentials.update-1">Credentials.update</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> Credentials.update ()</code></pre> | |
| </blockquote> | |
| <p><em>Refresh the credentials if they are expired, and return them</em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L231" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="credentials.save" class="level3"> | |
| <h3 class="anchored" data-anchor-id="credentials.save">Credentials.save</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> Credentials.save (fname)</code></pre> | |
| </blockquote> | |
| <p><em>Save credentials to <code>fname</code></em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L231" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="credentials.save-1" class="level3"> | |
| <h3 class="anchored" data-anchor-id="credentials.save-1">Credentials.save</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> Credentials.save (fname)</code></pre> | |
| </blockquote> | |
| <p><em>Save credentials to <code>fname</code></em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L236" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="load_creds" class="level3"> | |
| <h3 class="anchored" data-anchor-id="load_creds">load_creds</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> load_creds (fname)</code></pre> | |
| </blockquote> | |
| <p><em>Load credentials from <code>fname</code></em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L242" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="googleappclient.creds" class="level3"> | |
| <h3 class="anchored" data-anchor-id="googleappclient.creds">GoogleAppClient.creds</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> GoogleAppClient.creds ()</code></pre> | |
| </blockquote> | |
| <p><em>Create <code>Credentials</code> from the client, refreshing if needed</em></p> | |
| <hr> | |
| <p><a href="https://github.com/AnswerDotAI/fasthtml/blob/main/fasthtml/oauth.py#L242" target="_blank" style="float:right; font-size:smaller">source</a></p> | |
| </section> | |
| <section id="googleappclient.creds-1" class="level3"> | |
| <h3 class="anchored" data-anchor-id="googleappclient.creds-1">GoogleAppClient.creds</h3> | |
| <blockquote class="blockquote"> | |
| <pre><code> GoogleAppClient.creds ()</code></pre> | |
| </blockquote> | |
| <p><em>Create <code>Credentials</code> from the client, refreshing if needed</em></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> |