Last active
July 21, 2024 15:55
-
-
Save vrslev/6d0602bfa939a01844f645c608afb85a to your computer and use it in GitHub Desktop.
Automatic browser reloading in FastAPI
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import os | |
import arel | |
from fastapi import FastAPI, Request | |
from fastapi.templating import Jinja2Templates | |
app = FastAPI() | |
templates = Jinja2Templates("templates") | |
if _debug := os.getenv("DEBUG"): | |
hot_reload = arel.HotReload(paths=[arel.Path(".")]) | |
app.add_websocket_route("/hot-reload", route=hot_reload, name="hot-reload") | |
app.add_event_handler("startup", hot_reload.startup) | |
app.add_event_handler("shutdown", hot_reload.shutdown) | |
templates.env.globals["DEBUG"] = _debug | |
templates.env.globals["hot_reload"] = hot_reload | |
@app.get("/") | |
def index(request: Request): | |
return templates.TemplateResponse("index.html", context={"request": request}) | |
# run: | |
# DEBUG=true uvicorn main:app --reload |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fastapi | |
uvicorn[standard] | |
arel | |
jinja2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<body> | |
{% block content %}{% endblock %} | |
<!-- Hot reload script --> | |
{% if DEBUG %} {{ hot_reload.script(url_for('hot-reload')) | safe }} {% endif | |
%} | |
</body> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{% extends "base.html" %} {% block content %} Hello, world! {% endblock %} |
@dicolasi Please share your code 😊
@thisisthemurph I don't understand exactly your setup. Can you share a minimal reproducible example of what you're saying?
It works in Safari (Version 17.2 (19617.1.17.11.9)) just fine.
It works in Safari (Version 17.2 (19617.1.17.11.9)) just fine.
@yanky2000 Just tested it in Safari 17.1—it also works. Removed the comment, thanks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This works for me, but only on the routes defined within the main file where
app
is defined. Any ideas on how to get this to work on other routes? I have separate routes defined within arouters
directory and then apply them in the main file withapp.include_router(my_router)
.