Flask Babel
Implements i18n and l10n support for Flask. This is based on the Python babel module as well as pytz both of which are installed automatically for you if you install this library.
Documention
The latest documentation is available here.
It would be nice to be able to stash the current language somewhere and use another one for a while during a request execution.
The main use-case I see is sending out emails with Flask-Email. The email should be translated according to the recipient's language and not the current user's language.
Something like:
from flaskext.babel import stash, unstash
# do stuff with current user's language
print _('foo')
# Now switch to th recipient language
stash(new_lang=recipient.language)
send email with i18n tags
unstash()
# Now the language is back to the current user's lang
Well the API is terrible, but you get the idea..
This allows to specify in which folder the translations should be looked for instead of having it hardcoded (still defaults to "translations").
This is done either via a folder
param passed to the constructor or via the BABEL_TRANSLATIONS_FOLDER
configuration variable.
TypeError is being thrown:
$ pybabel update -i messages.pot -d translations/
updating catalog 'translations/en/LC_MESSAGES/messages.po' based on 'messages.pot'
Traceback (most recent call last):
File "/home/georg/env/main/bin/pybabel", line 9, in <module>
load_entry_point('Babel==1.3', 'console_scripts', 'pybabel')()
File "/home/georg/env/main/lib/python3.3/site-packages/babel/messages/frontend.py", line 1151, in main
return CommandLineInterface().run(sys.argv)
File "/home/georg/env/main/lib/python3.3/site-packages/babel/messages/frontend.py", line 665, in run
return getattr(self, cmdname)(args[1:])
File "/home/georg/env/main/lib/python3.3/site-packages/babel/messages/frontend.py", line 1130, in update
width=options.width)
File "/home/georg/env/main/lib/python3.3/site-packages/babel/messages/pofile.py", line 444, in write_po
_write(comment_header + u'\n')
File "/home/georg/env/main/lib/python3.3/site-packages/babel/messages/pofile.py", line 388, in _write
fileobj.write(text)
TypeError: must be str, not bytes
There should be a short introduction in how to use gettext, trans etc in Jinja the jkji2 templates - it's not obvious from the docs that the jinja2 i18n ext is used and that the user does not need to configure this separately.
This fixes issue #117 by setting babel_locale
in force_locale
context manager instead of replacing locale getter. Babel extension instance is shared across threads (through Flask.extensions
) which may cause wrong locale to be selected in request that is processed at the same time in one thread while another thread is using force_locale
. Setting locale to request context is thread-safe as Flask doesn't share request contexts between threads. I've added a test case to verify that this fix works, and it failed without changes to force_locale
.
Right now Flask breaks if you request content in a locale that is unknown by Babel even if the translation files actually exist.
This commit allows translations to be loaded even if the locale is unknown by Babel. Numbers and datetimes ~are returned directly~ use the default locale as a fallback.
I am getting a:
'Babel' object has no attribute 'translation_directories'
error after updating Flask-Babel from 0.9 to 0.11.1.
I found a similar reference at https://github.com/airbnb/superset/issues/847 which claims the issue was flask extension compatibility related.
I have been looking for any sort of documentation that indicates what flask extensions have compatibility with one another, is it just assumed that the minor version (major.minor.build) must match to be compatible?
Here are my current application versions that are having the issue:
Babel (2.3.4) Flask (0.11.1) Flask-Babel (0.11.1) Flask-BabelEx (0.9.3) Flask-Compress (1.3.2) Flask-Login (0.4.0) itsdangerous (0.24) Jinja2 (2.8) MarkupSafe (0.23) pytz (2016.7) setuptools (28.8.0) speaklater (1.3) Werkzeug (0.11.11)
Again, all works with version 0.9 of flask-babel, just trying to understand if compatibility is the root cause or is there a real issue lurking.
I use flask_script (and flask_migrate) to migrate my sql schema. Since version 0.10 i got this error. Everything works well with 0.9
File "/usr/local/lib/python2.7/dist-packages/flask_babel/__init__.py", line 215, in get_translations
babel = current_app.extensions['babel']
File "/usr/local/lib/python2.7/dist-packages/werkzeug/local.py", line 343, in __getattr__
return getattr(self._get_current_object(), name)
File "/usr/local/lib/python2.7/dist-packages/werkzeug/local.py", line 302, in _get_current_object
return self.__local()
File "/usr/local/lib/python2.7/dist-packages/flask/globals.py", line 34, in _find_app
raise RuntimeError('working outside of application context')
Hi, all. I have two subprocesses. one for flask web(called web.py), and one for some background tasks(called task.py). flask-babel works inside the web context, but also the task subprocess will need some translations. so, I import web app into the task.py and use the app.test_request_context in order to make translations work for me. it works at first but then I found task.py will also get the default language only. here is the web.py:
app.config['BABEL_DEFAULT_LOCALE'] = 'en'
babel = Babel(app)
@babel.localeselector
def get_locale():
return request.accept_languages.best_match(['zh', 'en'])
task.py
from web import app
def task():
try:
with app.test_request_context() as ctx:
sio.emit('loading', {'data': _("please wait a moment.")})
....
so how can I get the correct locale before I return the translation?? TIA :)
I have a base.html file and navbar.html file. The navbar.html is included in base.html and base extended in other templates. The problem is that babel does not extract strings from navbar.html even though i can see it read it.
extraction log
babel.cfg
[jinja2: **.htm*]
encoding = utf-8
extensions=jinja2.ext.autoescape,jinja2.ext.with_
What could be the problem?
I have some words in 3's f-Strings sql code. such as
s = f"""
SELECT * FROM aa
balabala ...
case bala...
{_("abc")}
WHERE b=1
"""
after I excute the order
$ pybabel extract -F babel.cfg -o messages.pot .
but I cannot find the words 'abc' from file messages.pot
If I have html file content like
<html>
{% cache 3600, request.url %}
<tag>{{ _('h1') }}</tag>
{% endcache %}
</html>
And run
pybabel extract -F babel.cfg -k _l -o translations/messages.pot .
Flask Babel cannot find new words in {% cache %} block
Hi there
I have a question So we all know that .mo will be cached in flask app I just want to know if when we run flask server it caches all .mo files at the beginning? Or is it just when we switch languages then it creates domain objects and caches that .mo file?
I thought caching all mo files at the beginning would minimize IO time
Now with Flask-Babel it is not possible to use gettext particular callables (pgettext, npgettext) in Jinja templates, but install_gettext_callables()
supports it. This PR fixes that.
Not a problem with the code itself, but it looks like someone needs to update pypi ... it's the first hit on google for the project, and is still linking to https://flask-babel.tkte.ch/ for the documentation, which doesn't exist.
There is a small typo in flask_babel/init.py.
Should read translations
rather than tranlations
.
Semi-automated pull request generated by https://github.com/timgates42/meticulous/blob/master/docs/NOTE.md
Starting with version 2, flask-babel drops official support for Python2. Python versions 3.5 through 3.9-beta1 are tested and supported, as well as pypy3.
Starting with version 1, flask-babel has changed to Semantic Versioning.
flask-apispec flask-apispec is a lightweight tool for building REST APIs in Flask. flask-apispec uses webargs for request parsing, marshmallow for res
Flask-SQLAlchemy Flask-SQLAlchemy is an extension for Flask that adds support for SQLAlchemy to your application. It aims to simplify using SQLAlchemy
Flask-CORS A Flask extension for handling Cross Origin Resource Sharing (CORS), making cross-origin AJAX possible. This package has a simple philosoph
Flask-MongoEngine Info: MongoEngine for Flask web applications. Repository: https://github.com/MongoEngine/flask-mongoengine About Flask-MongoEngine i
flask-paginate Pagination support for flask framework (study from will_paginate). It supports several css frameworks. It requires Python2.6+ as string
Flask-Injector Adds Injector support to Flask, this way there's no need to use global Flask objects, which makes testing simpler. Injector is a depend
Flask-GraphQL Adds GraphQL support to your Flask application. Usage Just use the GraphQLView view from flask_graphql from flask import Flask from flas
flask-paginate Pagination support for flask framework (study from will_paginate). It supports several css frameworks. It requires Python2.6+ as string
Flask-GraphQL Adds GraphQL support to your Flask application. Usage Just use the GraphQLView view from flask_graphql from flask import Flask from flas
flask-sock WebSocket support for Flask Installation pip install flask-sock Example from flask import Flask, render_template from flask_sock import Soc
An extension to add support of Plugin in Flask.
Flask-Rebar Flask-Rebar combines flask, marshmallow, and swagger for robust REST services. Features Request and Response Validation - Flask-Rebar reli
Brandnew-flask is still in the initial stage and needs to be updated and improved continuously. Everyone is welcome to maintain and improve this CLI.
Flask pre-setup architecture. This can be used in any flask project for a faster and better project code structure. All the required libraries are already installed easily to use in any big project.
Flask-Bcrypt Flask-Bcrypt is a Flask extension that provides bcrypt hashing utilities for your application. Due to the recent increased prevelance of
Flask-Bcrypt Flask-Bcrypt is a Flask extension that provides bcrypt hashing utilities for your application. Due to the recent increased prevelance of
Flask-Starter Flask-Starter is a boilerplate starter template designed to help you quickstart your Flask web application development. It has all the r
Flask Project Template A full feature Flask project template. See also Python-Project-Template for a lean, low dependency Python app. HOW TO USE THIS
Flask-app scaffold, generate flask restful backend