Download do fasthx - Download do código fonte do fasthx

fasthx

Dados do site

v2.1.1

Baixar

Código fonte : https://github.com/volfpeter/fasthx

Documentação e exemplos : https://volfpeter.github.io/fasthx

Fasthx

Renderização do lado do servidor FASTAPI com suporte HTMX interno.

Principais recursos:

Sintaxe do decorador que funciona com o FASTAPI como seria de esperar, não há necessidade de dependências não utilizadas ou mágicas nas rotas.
Construído para o HTMX , mas pode ser usado sem ele.
Funciona com qualquer mecanismo de modelos ou biblioteca de renderização do lado do servidor, por exemplo, htmy , jinja2 ou dominate .
Fornece o acesso ao motor de renderização a todas as dependências da rota decorada.
As rotas HTMX funcionam conforme o esperado se receber solicitações não-HTMX, para que a mesma rota possa servir dados e renderizar HTML ao mesmo tempo.
Os cabeçalhos de resposta que você define em suas rotas são mantidos após a renderização, como seria de esperar em FASTAPI.
A digitação correta permite aplicar outros decoradores (digitados) em suas rotas.
Funciona com rotas sincronizadas e assíncronas.

Instalação

O pacote está disponível no Pypi e pode ser instalado com:

$ pip install fasthx

O pacote possui dependências opcionais para as seguintes integrações oficiais :

htmy: pip install fasthx[htmy] .
Jinja: pip install fasthx[jinja] .

Exemplos

Para exemplos completos, mas simples que mostram o uso básico do FastHX , consulte a pasta Exemplos.

Modelagem HTMY

Requer: pip install fasthx[htmy] .

Servir solicitações HTML e HTMX com HTMY é tão fácil quanto criar uma instância fasthx.htmy.HTMY e usar seus métodos de decorador hx() e page() em suas rotas.

O exemplo abaixo assume a existência de um componente htmy IndexPage e UserList . O exemplo completo de trabalho com os componentes htmy pode ser encontrado aqui.

 from datetime import date

from fastapi import FastAPI
from pydantic import BaseModel

from fasthx . htmy import HTMY

# Pydantic model for the application
class User ( BaseModel ):
    name : str
    birthday : date

# Create the FastAPI application.
app = FastAPI ()

# Create the FastHX HTMY instance that renders all route results.
htmy = HTMY ()

@ app . get ( "/users" )
@ htmy . hx ( UserList )  # Render the result using the UserList component.
def get_users ( rerenders : int = 0 ) -> list [ User ]:
    return [
        User ( name = "John" , birthday = date ( 1940 , 10 , 9 )),
        User ( name = "Paul" , birthday = date ( 1942 , 6 , 18 )),
        User ( name = "George" , birthday = date ( 1943 , 2 , 25 )),
        User ( name = "Ringo" , birthday = date ( 1940 , 7 , 7 )),
    ]

@ app . get ( "/" )
@ htmy . page ( IndexPage )  # Render the index page.
def index () -> None : ...

JINJA2 MODELAÇÃO

Requer: pip install fasthx[jinja] .

Para começar a servir solicitações HTML e HTMX, tudo o que você precisa fazer é criar uma instância de fasthx.Jinja e usar seus métodos hx() ou page() como decoradores em suas rotas. hx() aciona apenas a renderização HTML para solicitações HTMX, enquanto page() renderiza incondicionalmente o HTML. Veja o código de exemplo abaixo:

 from fastapi import FastAPI
from fastapi . templating import Jinja2Templates
from fasthx import Jinja
from pydantic import BaseModel

# Pydantic model of the data the example API is using.
class User ( BaseModel ):
    first_name : str
    last_name : str

# Create the app.
app = FastAPI ()

# Create a FastAPI Jinja2Templates instance and use it to create a
# FastHX Jinja instance that will serve as your decorator.
jinja = Jinja ( Jinja2Templates ( "templates" ))

@ app . get ( "/" )
@ jinja . page ( "index.html" )
def index () -> None :
    ...

@ app . get ( "/user-list" )
@ jinja . hx ( "user-list.html" )
async def htmx_or_data () -> list [ User ]:
    return [
        User ( first_name = "John" , last_name = "Lennon" ),
        User ( first_name = "Paul" , last_name = "McCartney" ),
        User ( first_name = "George" , last_name = "Harrison" ),
        User ( first_name = "Ringo" , last_name = "Starr" ),
    ]

@ app . get ( "/admin-list" )
@ jinja . hx ( "user-list.html" , no_data = True )
def htmx_only () -> list [ User ]:
    return [ User ( first_name = "Billy" , last_name = "Shears" )]

Veja o exemplo completo de trabalho aqui.

Modelagem personalizada

Requer: pip install fasthx .

Se você deseja usar um mecanismo de renderização sem integração do FastHX, pode construir facilmente os decoradores hx() e page() que fornecem toda a funcionalidade necessária. Tudo o que você precisa fazer é implementar o protocolo HTMLRenderer .

Da mesma forma que o caso Jinja, hx() aciona apenas a renderização HTML para solicitações HTMX, enquanto page() renderiza incondicionalmente o HTML. Veja o código de exemplo abaixo:

 from typing import Annotated , Any

from fastapi import Depends , FastAPI , Request
from fasthx import hx , page

# Create the app.
app = FastAPI ()

# Create a dependecy to see that its return value is available in the render function.
def get_random_number () -> int :
    return 4  # Chosen by fair dice roll.

DependsRandomNumber = Annotated [ int , Depends ( get_random_number )]

# Create the render methods: they must always have these three arguments.
# If you're using static type checkers, the type hint of `result` must match
# the return type annotation of the route on which this render method is used.
def render_index ( result : list [ dict [ str , str ]], * , context : dict [ str , Any ], request : Request ) -> str :
    return "<h1>Hello FastHX</h1>"

def render_user_list ( result : list [ dict [ str , str ]], * , context : dict [ str , Any ], request : Request ) -> str :
    # The value of the `DependsRandomNumber` dependency is accessible with the same name as in the route.
    random_number = context [ "random_number" ]
    lucky_number = f"<h1> { random_number } </h1>"
    users = "" . join (( "<ul>" , * ( f"<li> { u [ 'name' ] } </li>" for u in result ), "</ul>" ))
    return f" { lucky_number } n { users } "

@ app . get ( "/" )
@ page ( render_index )
def index () -> None :
    ...

@ app . get ( "/htmx-or-data" )
@ hx ( render_user_list )
def htmx_or_data ( random_number : DependsRandomNumber ) -> list [ dict [ str , str ]]:
    return [{ "name" : "Joe" }]

@ app . get ( "/htmx-only" )
@ hx ( render_user_list , no_data = True )
async def htmx_only ( random_number : DependsRandomNumber ) -> list [ dict [ str , str ]]:
    return [{ "name" : "Joe" }]

Veja o exemplo completo de trabalho aqui.

Exemplos externos

Exemplo FASTAPI-HTMX-TAILWIND: Um exemplo complexo Jinja2 com recursos como pesquisa ativa, carregamento preguiçoso, eventos enviados por servidor, gatilhos HTMX do lado do servidor personalizados, diálogos e integração de TailWindcss e Daisyui.