fasthxダウンロードfasthxソースコードのダウンロード

fasthx

ウェブサイトデータ

v2.1.1

ダウンロード

ソースコード：https：//github.com/volfpeter/fasthx

ドキュメントと例：https：//volfpeter.github.io/fasthx

fastthx

内蔵のHTMXサポートを備えたFastAPIサーバー側のレンダリング。

主な機能：

Hastapiで動作するデコレーターの構文は、予想されるように、ルート内の未使用または魔法の依存関係を必要としません。
HTMX用に構築されていますが、それなしで使用できます。
任意のテンプレートエンジンまたはサーバー側のレンダリングライブラリ（ htmy 、 jinja2などdominateで動作します。
装飾されたルートのすべての依存関係へのレンダリングエンジンアクセスを提供します。
HTMXルートは、非HTMXリクエストを受信すると予想どおりに機能するため、同じルートでデータを提供してHTMLを同時にレンダリングできます。
Fastapiで予想されるように、ルートに設定した応答ヘッダーは、レンダリング後に保持されます。
正しいタイピングを使用すると、他の（タイプされた）デコレータをルートに適用できます。
同期ルートと非同期ルートの両方で動作します。

インストール

パッケージはPYPIで利用でき、以下でインストールできます。

$ pip install fasthx

パッケージには、次の公式統合のオプションの依存関係があります。

htmy： pip install fasthx[htmy] 。
ジンジャ： pip install fasthx[jinja] 。

例

FastHXの基本的な使用を紹介する完全な、しかし簡単な例については、例フォルダーを参照してください。

HTMYテンプレート

要求： pip install fasthx[htmy] 。

HTMLとHTMXリクエストをHTMYで提供するのは、 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() HTMX要求のHTMLレンダリングのみをトリガーし、 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() HTMX要求の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" }]