FastAPI Babel is integrated within FastAPI framework and gives you support of i18n, l10n, date and time locales, and all other pybabel functionalities.
Python: 3.6 and later (tested on Python 3.6, 3.12) FastAPI: 0.45.0 + PyBabel: All
pip install fastapi-babel
pip install fastapi
and
pip install fastapi_babel
babel.py
file:from fastapi_babel import Babel, BabelConfigs
configs = BabelConfigs(
ROOT_DIR=__file__,
BABEL_DEFAULT_LOCALE="en",
BABEL_TRANSLATION_DIRECTORY="lang",
)
babel = Babel(configs=configs)
if __name__ == "__main__":
babel.run_cli()
babel.cfg
filebabel.cfg
[python: **.py]
from fastapi_babel import Babel, BabelConfigs, _
configs = BabelConfigs(
ROOT_DIR=__file__,
BABEL_DEFAULT_LOCALE="en",
BABEL_TRANSLATION_DIRECTORY="lang",
)
babel = Babel(configs=configs)
def main():
babel.locale = "en"
en_text = _("Hello World")
print(en_text)
babel.locale = "fa"
fa_text = _("Hello World")
print(fa_text)
if __name__ == "__main__":
main()
pybabel extract -F babel.cfg -o messages.pot .
pybabel init -i messages.pot -d lang -l fa
Goto lang/YOUR_LANGUAGE_CODE/LC_MESSAGES/messages.po and add your translation to your messages.
Go back to the root folder and Compile
pybabel compile -d lang
main.py
python3 main.py
Install click at first:
pip install click
...
babel.run_cli()
...
For more information just take a look at help flag of main.py
python main.py --help
FastAPI Babel CLI will eliminate the need of concering the directories and paths, so you can concentrate on the project and spend less time on going forward and backward. You only need to specify domain name, babel.cfg and localization directory.
NOTICE: Do not use FastAPI Babel
beside fastapi runner files (main.py
or run.py
), as uvicorn cli will not work.
[========]
babel.py
and write the code below.from fastapi_babel import Babel, BabelConfigs, BabelMiddleware
configs = BabelConfigs(
ROOT_DIR=__file__,
BABEL_DEFAULT_LOCALE="en",
BABEL_TRANSLATION_DIRECTORY="lang",
)
app.add_middleware(BabelMiddleware, babel_configs=configs)
if __name__ == "__main__":
Babel(configs).run_cli()
python3 babel.py extract -d/--dir {watch_dir}
Notice: watch_dir is your project root directory, where the messages will be extracted.
fa
.python3 babel.py init -l fa
Go to ./lang/Fa/.po and add your translations.
compile all locale directories.
python3 babel.py compile
from fastapi import FastAPI, Request
from fastapi_babel import _
from .babel import babel
app = FastAPI()
app.add_middleware(BabelMiddleware, babel_configs=BabelConfigs(
ROOT_DIR=__file__,
BABEL_DEFAULT_LOCALE="en",
BABEL_TRANSLATION_DIRECTORY="lang",
))
@app.get("/items/{id}", response_class=HTMLResponse)
async def read_item(request: Request, id: str):
return id + _("Hello World")
Accept-Language
.[python: **.py]
[jinja2: **/templates/**.html]
extensions=jinja2.ext.autoescape,jinja2.ext.with_
main.py
should look like.main.py
from fastapi_babel import Babel, BabelConfigs, BabelMiddleware, _
from fastapi.responses import HTMLResponse
from fastapi.staticfiles import StaticFiles
from fastapi.templating import Jinja2Templates
from fastapi import FastAPI, Request
app = FastAPI()
babel_configs = BabelConfigs(
ROOT_DIR=__file__,
BABEL_DEFAULT_LOCALE="en",
BABEL_TRANSLATION_DIRECTORY="lang",
)
templates = Jinja2Templates(directory="templates")
app.add_middleware(BabelMiddleware, babel_configs=babel_configs, jinja2_templates=templates)
app.mount("/static", StaticFiles(directory="static"), name="static")
@app.get("/items/{id}", response_class=HTMLResponse)
async def read_item(request: Request, id: str):
return templates.TemplateResponse("item.html", {"request": request, "id": id})
index.html
fileindex.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<h1>{{_("Hello World")}}</h1>
</body>
</html>
Now just follow the documentation from step 5.
More features like lazy gettext, please check the Wtform Example
Contributions are always welcome!
Please read contributing.md
to get familiar how to get started.
Please adhere to the project's code of conduct
.
Please open an issue and follow the template, so the community can help you.