fasthx下載 - fasthx源代碼下載

fasthx

網站數據

v2.1.1

下載

源代碼：https：//github.com/volfpeter/fasthx

文檔和示例：https：//volfpeter.github.io/fasthx

fasthx

FastAPI服務器端渲染具有內置的HTMX支持。

關鍵功能：

與FastApi一起使用的Decorator語法，不需要路由中未使用或魔術依賴性。
為HTMX製造，但可以不用它使用。
使用任何模板引擎或服務器端渲染庫，例如htmy ， jinja2或dominate 。
使渲染引擎可以訪問裝飾路線的所有依賴關係。
如果HTMX收到非HTMX請求，則HTMX路線可以按預期工作，因此相同的路線可以同時提供數據並渲染HTML。
正如您在FastApi中所期望的那樣，您在路線中設置的響應標頭將保留在渲染後。
正確的鍵入使得可以在路線上應用其他（打字的）裝飾器。
使用同步路由和異步路線。

安裝

該包在PYPI上可用，可以安裝：

$ pip install fasthx

該軟件包具有以下官方集成的可選依賴性：

HTMY： pip install fasthx[htmy] 。
Jinja： pip install fasthx[jinja] 。

例子

有關完整但簡單的示例，顯示了FastHX的基本用途，請參閱示例文件夾。

htmy模板

要求： pip install fasthx[htmy] 。

使用HTMY服務HTML和HTMX請求就像創建fasthx.htmy.HTMY實例以及在路由上使用hx()和page()裝飾方法一樣容易。

下面的示例假定存在不IndexPage UserList htmy組件。與htmy組件的完整示例可以在此處找到。

 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模板

要求： pip install fasthx[jinja] 。

要開始服務HTML和HTMX請求，您需要做的就是創建一個fasthx.Jinja的實例，然後將其hx()或page()方法用作路由上的裝飾器。 hx()僅觸發HTML渲染HTMX請求，而page()無條件地呈現HTML。請參閱下面的示例代碼：

 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" )]

請參閱此處的完整工作示例。

自定義模板

要求： pip install fasthx 。

如果您想在沒有FASTHX集成的情況下使用渲染引擎，則可以輕鬆地在hx()和page()裝飾器上構建，從而為您提供所需的所有功能。您需要做的就是實現HTMLRenderer協議。

與Jinja情況類似， hx()僅觸發HTML請求的HTML渲染，而page()無條件地呈現HTML。請參閱下面的示例代碼：

 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" }]