Скачать fasthx - скачать исходный код fasthx

fasthx

Данные веб-сайта

v2.1.1

Скачать

Исходный код : https://github.com/volfpeter/fasthx

Документация и примеры : https://volfpeter.github.io/fasthx

FASTHX

Рендеринг на стороне сервера FASTAPI со встроенной поддержкой HTMX.

Ключевые функции:

Синтаксис декоратора , который работает с Fastapi, как и следовало ожидать, нет необходимости в неиспользованных или магических зависимостях на маршрутах.
Построен для HTMX , но может быть использован без него.
Работает с любым шаблонным двигателем или библиотекой рендеринга на стороне сервера, например, htmy , jinja2 или dominate .
Дает доступ по рендерингу доступа ко всем зависимостям украшенного маршрута.
Маршруты HTMX работают так же, как и ожидалось, если они получают запросы без HTMX, поэтому тот же маршрут может обслуживать данные и отображать HTML одновременно.
Заголовки ответов, которые вы устанавливаете на своих маршрутах, сохраняются после рендеринга, как и следовало ожидать в Fastapi.
Правильное печатание позволяет применять другие (напечатанные) декораторы к вашим маршрутам.
Работает как с синхронизацией , так и с асинхронными маршрутами .

Установка

Пакет доступен на PYPI и может быть установлен с:

$ pip install fasthx

Пакет имеет дополнительные зависимости для следующих официальных интеграций :

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

Примеры

Для полного, но простых примеров, которые демонстрируют основное использование FastHX , см. Папку «Примеры».

Htmy templation

Требуется: pip install fasthx[htmy] .

Обслуживание запросов HTML и HTMX с помощью HTMY так же просто, как и создание экземпляра fasthx.htmy.HTMY и использование его методов декоратора hx() и page() на ваших маршрутах.

Приведенный ниже пример предполагает существование IndexPage и компонента htmy UserList . Полный рабочий пример с htmy Components можно найти здесь.

 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 : ...

Джинджа2 шаблон

Требуется: 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 для запросов HTMX, в то время как 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" }]

Смотрите полный рабочий пример здесь.

Внешние примеры

Пример FASTAPI-HTMX-TAILWIND: сложный пример Jinja2 с такими функциями, как активный поиск, ленивая загрузка, серверные события, индивидуальные серверные триггеры HTMX, диалоги и TailWindcss и интеграция Daisyui.