i18n and l10n support for Flask based on Babel and pytz

Flask Babel - 0.11.1 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

Flask Babel - 1.0.0

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.

Changelog

v1.0.0 - 06/02/2020

Starting with version 1, flask-babel has changed to Semantic Versioning.

Changed

pytz is an explicit dependency. (#14)
pytz.gae, used for Google App Engine, is no longer necessary and has been removed. (#153)
Fixed a deprecated werkzeug import (#158).
Fix issues switching locales in threaded contexts (#125).

13 Open More issues

Closed

Support temporary language switch inside a request

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

opened Aug 26, 2010 by rslinckx 14

Closed

do not hardcode the translations folder path

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.

opened Feb 21, 2012 by mdeous 13

Closed

pybabel fails to update under python-3.3

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

opened Nov 23, 2013 by georgthegreat 12

Closed

Bug application context since v0.10

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')

opened May 8, 2016 by johaven 8

Closed

Fix locale selection in multi-threaded Flask app when force_locale is used

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.

opened Oct 8, 2017 by lautat 8

Closed

Documentation request - using templates

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.

opened Aug 4, 2010 by danjac 8

Open

Another difference between Flask-BabelEx - jinja initialization

Specifics: As part of init_app(): Flask-BabelEx:

app.jinja_env.install_gettext_callables(
                lambda x: get_domain().get_translations().ugettext(x),
                lambda s, p, n: get_domain().get_translations().ungettext(s, p, n),
                newstyle=True
            )

And Flask-Babel:

app.jinja_env.install_gettext_callables(
                lambda x: get_translations().ugettext(x),
                lambda s, p, n: get_translations().ungettext(s, p, n),
                newstyle=True
            )

So Flask-Babel doesn't take into account the 'default domain' as specified in the init function.

Dialogue: This was never clear to me and and seems like a missing link with Flask* an Babel - how applications could have translations and messages and domains but still utilize 3rd party library translations and messages - seems like Domains wasn't really thought through (or I don't understand it!).

For Flask-Security - I have already introduced a library specific jinja function (_fsdomain) that me tag my templates to be translated not with the default domain but with a specific domain.

Anyway - this change will break many things - so at a minimum I would suggest a release note/documentation...

bug

opened Sep 12, 2020 by jwag956 0

Open

Use w/o initialization

First and foremost - thank you thank you thank you for getting the Domain/BabelEx features backported into a supported package...

In PR #163 it was stated:

'we did not keep support flask-babelex had for using the flask extension without having initialized it. to me that looks very much like supporting something that's not expected to work anyway..'

Here is a use case for that - I am moving Flask-Security-Too to use Flask-Babel from Flask-BabelEx. Flask-Security has translations for all its messages, and requires Flask-Babel as a dependency.

However - not all application that USE Flask-Security care about i18n and therefore have no reason to initialize Babel. In the past - it just worked - Flask-Security initialized its Domain and since no locale changes were actually configured - it was fine.

But now of course it breaks if the application doesn't init Flask-Babel. This puts a burden on the application. If Flask-Security looks at whether Flask-Babel is registered as an extension - it then requires that different extensions have an implied order of initialization (and there isn't a way to tell the application writer that translations were ignored since we didn't find a Flask-Babel extension).

bug

opened Aug 30, 2020 by jwag956 1

Open

v3.0.0 - Removing all format_ wrappers, cleanups, and code quality.

We currently (v1, v2) duplicate all of the babel.dates and babel.numbers format_* methods in Flask-Babel. This is a lot of completely unnecessary duplication, including docstrings and test coverage. We're also often out of date with babel's methods, such as when new kwargs are added. Just like flask-wtf did way back, we should chuck this and become just the glue layer between Flask and Babel. In general, the only change in your code is to add format_decimal(..., locale=get_locale()).

Because this PR reduces our surface area significantly, lets make it a goal to get 100% test coverage.

[ ] Update documentation (#173)
[x] Remove format helpers (#164)
[ ] Remove all old-style formatters in __init__ and test code. (% vs format()). Or bump to py3.6+ and use fstrings.
[ ] Support new-style strings for translation (#170)
[ ] 100% test coverage, and make it part of the tests.
[ ] 100% flake8, and make it part of the tests.
[ ] Cleanup how we handle translation context. Verify we are thread safe.
[ ] Stop polluting app objects - always use current_app.
[ ] Support multiple apps with different configurations (#107)

The v3.* family aims to be the last breaking release for quite awhile.

opened Aug 27, 2020 by TkTech 0

Open

Rewrite Documentation

Our documentation is....not great. The aim is to complete a total rewrite this week and release as v2.1.0 (along with #170).

[ ] Installation
[x] Configuration
[ ] Examples
- [x] Basic
- [ ] Template usage
- [ ] App factory
- [ ] Integrating with tools like Accent and Transifex
[ ] API

documentation enhancement

opened Aug 26, 2020 by TkTech 0

Open

Add support for new-style Python formatting placeholders

This PR adds support for "new style" Python formatting placeholders based on str.format in addition to the existing support for % operator-based placeholders. Originally this was a Python 3 feature, but it has been backported to Python 2.6 and 2.7.

New-style Python formatting comes with many advantages in terms of placeholder syntax and flexibility. This PR allows Flask-Babel users to use both old-style and new-style placeholders side-by-side. For a comparison of the 2 styles, see: https://pyformat.info

New-style placeholders are now supported: gettext(u'Hello {name}!', name='World') –> "Hello World!"
Old-style placeholders also still work: gettext(u'Hello %(name)s!', name='World') –> "Hello World!"
You should even be able to use both styles side by side. (Not that you should…)

Docstrings have been updated to suggest new-style syntax, so new users are guided towards the current best-practice. PEP 3101 specifies new-style formatting is intended as a replacement for % operator-based formatting.

This PR also fixes #13 (translations automatically being considered "safe") by disabling Jinja's newstyle wrappers for gettext callables, which don't add anything useful on top of Flask-Babel's own gettext callables.

Note that while this behavior is safer, this is a potentially breaking change for any folks who may be relying on the current behavior where HTML in translations is not escaped by Jinja. If you want HTML in translations to be rendered instead of escaped, we propose explicitly using Jinja's |safe filter. This makes the current (potentially unsafe) behavior opt-in.

enhancement

opened Aug 6, 2020 by DriesOeyen 0

Open

Remove all format_* wrappers

Our API is never up to date with babel (ex: #142), and we do not cover the entire babel API. Our wrappers add no real value, and add a lot of surface area for test coverage. Just like flask-wtforms did way back in version 0.9, we should focus on just being the glue between flask and babel.

[x] format_datetime
[x] format_date
[x] format_time
[x] format_timedelta
[x] format_number
[x] format_decimal
[x] format_currency
[x] format_percent
[x] format_scientific

As part of this, we need to improve the documentation to show better examples of using get_locale and get_timezone.

enhancement

opened Feb 25, 2020 by TkTech 0

v2.0.0(Aug 26, 2020)

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.

Tests moved from unittest to pytest (#163)
Domain and caching support from Flask-BabelEx (#163)
Documentation moved from python-hosted to Github Pages.
CI moved from Travisci to Github Actions
Small documentation improvements.
Removed uncessary checks on get_translations() (#127, #126)
localeselector and timezoneselector can be changed after creation.

Source code(tar.gz)
Source code(zip)

v1.0.0(Feb 6, 2020)

v1.0.0 - 06/02/2020

Starting with version 1, flask-babel has changed to Semantic Versioning.

Changed

pytz is an explicit dependency. (#14)
pytz.gae, used for Google App Engine, is no longer necessary and has been removed. (#153)
Fixed a deprecated werkzeug import (#158).
Fix issues switching locales in threaded contexts (#125).

Source code(tar.gz)
Source code(zip)

Information

Category: Python / Learning Tutorial
Watchers: 13
Star: 358
Fork: 141
Last update: Jan 17, 2021

Resource links

http://www.pythondoc.com/flask-babel/index.html

https://github.com/python-babel/flask-babel

Share this repo

Related Repos

Learning Tutorial

267

A learning environment for Python suited for beginners and children, inspired by Logo.

Python Turtle An educational environment for learning Python, suitable for beginners and children. Inspired by LOGO. Homepage: http://pythonturtle.org An Appealing Environment to Learn Python PythonTurtle str

Learning Tutorial

1.2k

A curated list of games that can teach you how to learn a programming language.

Games of Coding A curated list of games that teach you a programming language Contribution guide Buy a sticker Follow me on Twitter. Table of Contents Language Independent Codingame Vindiniu

Learning Tutorial

308

Minimal tutorials for PyTorch

Minimal tutorials for PyTorch adapted from Alec Radford's Theano tutorials. Tensor multiplication Linear Regression Logistic Regression Neural Network Modern Neural Network Convolutional Neural Network Long Short-Term Memo

Learning Tutorial

557

Google SRE Book Generator (EPUB/MOBI/PDF).

Google SRE Book/s Generates a EPUB/MOBI/PDF for the Google SRE Book/s. Original sources are downloaded from https://landing.google.com/sre/books Visit the Releases page to download the latest release. Books

Learning Tutorial

4.1k

TensorFlow Basic Tutorial Labs

Lab code (WIP), but call for comments This is code for labs covered in TensorFlow basic tutorials (in Korean) at https://youtu.be/BS6O0zOGX4E. (We also have a plan to record videos in English.) This is work in progress, and ma

Learning Tutorial

4.3k

Python Koans - Learn Python through TDD

Python Koans Python Koans is a port of Edgecase's "Ruby Koans" which can be found at http://rubykoans.com/. Python Koans is an interactive tutorial for learning the Python programming language by making tests pass. Most tes

Learning Tutorial

Lectures on scientific computing with python, as IPython notebooks.

Lectures on scientific computing with Python A set of lectures on scientific computing with Python, using IPython notebooks. To open these notebooks in IPython, download the files to a directory on your computer and from that

Learning Tutorial

722

A simple tutorial about effectively using pdb

pdb Tutorial The purpose of this tutorial is to teach you the basics of pdb, the Python DeBugger for Python2 and Python3. It will also include some helpful tricks to make your debugging sessions a lot less stressful.