Home / Python / Learning Tutorial

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
Information
Category: Python / Learning Tutorial
Watchers: 15
Star: 401
Fork: 151
Last update: Jan 31, 2023
Resource links
http://www.pythondoc.com/flask-babel/index.html
https://github.com/python-babel/flask-babel

Flask Babel - 1.0.0

Build Status PyPI license PyPI - Python Version

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

Translations not happening in production on Heroku/gunicorn

I have flask-babel running correctly on my development localhost (on Windows), but the translations do not happen on the production app (gunicorn on Heroku).

I've detailed the issue more fully in this unresolved StackOverflow post.

opened Apr 11, 2021 by robcowen 10
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 9
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
Open

Change in unit test behavior when using test_client breaks makes tests less realistic

As of flask_babel 3.0.0, flask babel locale context is no longer reset between flask test_client requests. Consider the following unit test and config:

Test app has this locale_selector:

from flask import has_request_context, request

def locale_selector():
    if has_request_context():
        return request.accept_languages.best_match(LanguageType)
    return None

and then the test (assuming some basic flask app):

from flask_babel import get_locale

def test_get_locale(app):
    app.test_client.get(url_for("some_blueprint.some_route"), headers={"Accept-Language": "en"})
    assert str(get_locale()) == "en"

    app.test_client.get(url_for("some_blueprint.some_route"), headers={"Accept-Language": "es"})
    assert str(get_locale()) == "es"

This test succeeded in 2.x because get_locale() would call locale_selector on each test. In 3.0.0, the locale remains cached after the first request is made, causing the second assertion to fail.

To make the second test succeed, we can use refresh:

from flask_babel import get_locale, refresh

def test_get_locale(app):
    app.test_client.get(url_for("some_blueprint.some_route"), headers={"Accept-Language": "en"})
    assert str(get_locale()) == "en"

    refresh()

    app.test_client.get(url_for("some_blueprint.some_route"), headers={"Accept-Language": "es"})
    assert str(get_locale()) == "es"

However, this makes the tests more poorly reflect reality.

opened Jan 23, 2023 by jdimmerman 0
Open

Support for timestamp in dateformat

I am integrating https://github.com/alisaifee/flask-limiter and a RequestLimit has a timestamp instead of a datetime object. Currently, it's not possible to format timestamp directly in the template, so I have to either add a custom filter or parse the timestamp before rendering.

Is it possible to add an optional parameter timestamp defaulted to False to parse dates?

opened Aug 28, 2022 by Glandos 0
Open

add command supprt so that user can use babel easily

hey,I add two click commands for flask-babel flask translate init <language> generate babel.cfg and message.pot flask translate update update message.pot

opened Jan 25, 2021 by johnson329 0
Open

Rewrite Documentation

Our documentation is....not great. We could use:

  • [ ] Installation
  • [x] Configuration
  • [ ] Examples
    • [x] Basic
    • [ ] Template usage
    • [ ] App factory
    • [ ] Integrating with tools like Accent and Transifex
  • [ ] API
enhancement documentation 
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

v3.0.1(Jan 29, 2023)

Small bugfix for the get_locale() behaviour when the default locale is returned.

v3.0.0(Jan 15, 2023)

Major version bump as this version removes support for Python 3.5 and 3.6, along with multiple major breaking changes. Hope you've been following SemVer :)

  • Dropped support for end-of-life Python 3.5 and 3.6, added tests for 3.10 and 3.11.
  • Fixes to documentation to address outdated links and settings (#204, 201)
  • Jinja version 3 or greater is now required (released 2021)
  • Removed Babel._date_formats, use the public Babel.date_formats instead.
  • list_translations() always returns the default locale, even if it does not exist. (#75)
  • Add lazy_npgettext() (#68)
  • Babel.locale_selector and Babel.timezone_selector no longer exist. They must be provided either when the Babel() object is created or when init_app() is called. This is to support having a single Babel object for multiple Flask apps (#107) as well as to simplify settings and multi-threaded state.
  • Most configuration options can be passed directly through init_app().

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.

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

Contents

    python-restx Fork of Flask-RESTPlus: Fully featured framework for fast, easy and documented API development with Flask
    sloria An improved shell command for the Flask CLI
    babel A wrapper for Babel's parser used for ESLint
    chiaweilee vue-i18n-filter - Vue filter extend for Vue-i18n, simply using {{ hello world | t }}.
    Spittal vue-i18n-extract - Manage vue-i18n localization with static analysis. Make reports about missing and unused i18n entries.
    codemod-js codemod rewrites JavaScript and TypeScript using babel plugins.
    dcrosta PyMongo support for Flask applications
    viniciuschiele Adds APScheduler support to Flask
    andreruffert 🍦 A simple way to introduce internationalization to your JS
    miLibris Flask extension to build REST APIs around JSONAPI 1.0 specification.
    djohnkang Flask tutorial for beginners
    dwreeves Simple CLI for managing Postgres databases in Flask.
    AndersDJohnson Find dependencies to transpile with Babel.
    karec Flask cookiecutter template for builing APIs with flask-restful, including JWT auth, cli, tests, swagger, docker and more
    glebm Manage translation and localization with static analysis, for Ruby i18n
    go-macaron Package i18n provides an Internationalization and Localization middleware for Macaron applications
    ivantsov Package for simplifying work with i18n in WebExtensions
    maxcountryman Flask-Bcrypt is a Flask extension that provides bcrypt hashing utilities for your application.
    italomaia AZAP Flask boilerplate for creating API's with flask.
    kellpossible cargo-i18n - Cargo sub-command to extract and build localization resources to embed in your application/library
    flask-admin Simple and extensible administrative interface framework for Flask
    Share this repo

    Related Repos


    Learning Tutorial
    34
    Programa em Python - que fiz em algumas horas e que provavelmente tem bugs - para extrair ...
    NatanaelAntonioli O que esse programa faz? Eu simplesmente não consigo aproveitar aulas online (e nem a maioria das presenciais), portanto estudo com slides e livros. P
     
    Learning Tutorial
    10
    Programa de código abierto para probar el API de Bitso, el exchange más importante de Amér...
    fernandomireles Bitso Semiautomático Programa de código abierto para probar el API de Bitso, el exchange más importante de América Latina. Desarrollador Fernando Mire
     
    Learning Tutorial
    6
    Collection of Fall 2022 tech internships!
    bsovs Fall2022-Internships Collection of Fall 2022 tech internships! To contribute: Fork repository Edit README.md Open a pull request! 📈 For tips on the i
     
    Learning Tutorial
    20
    A curated list of projects, templates or anything interesting related to the Supernote tab...
    fharper Awesome Supernote A curated list of projects, templates or anything interesting related to the Supernote tablet. Contributions are welcome (contributi
     
    Learning Tutorial
    4
    I found this old project and I it is better to be in Github for Qt beginners.
    BlackIQ PyQt5-Download-Manager PyQt5 simple files , youtube videos and youtube playlist downloader Project Files : index.py : the main project file , use it t
     
    Learning Tutorial
    13
    Linkedin Skill Assessments
    serkanalc In this repository, I will be sharing the linkedin skill assessment questions and answers that have come up so far in related fields. Feel free to contribute what you see missing.
     
    Learning Tutorial
    31
    Nuclei Templates to reproduce Cracking the lens's Research
    0xAwali Nuclei Templates to reproduce Cracking the lens's Research Requirements 1 - Read and Watch ! Cracking the lens's Research 2 - Install Nuclei Nuclei 3
     
    Learning Tutorial
    20
    Sharing tips, resources and doses of motivation to help you start and finish the 100 Days ...
    ivybarley #100DaysChallenge for Techies I created this repo to share tips, resources and doses of motivation to help you start and finish the 100 Days Challenge
     
    Learning Tutorial
    41
    Collection of notes to prepare for the eLearnSecurity eJPT certification exam.
    grumpzsux eJPT Notes 2022 (eLearnSecurity Junior Penetration Tester) Twitter: @GRuMPzSux Collection of notes to prepare for the eLearnSecurity eJPT certificatio
     
    Learning Tutorial
    9
    Notes related to system design interviews, step by step.
    tigerabrodi System Design Interviews (SDIs) Engineers often struggle with SDIs primarily because of three reasons: Asked to work on an open-ded design problem tha
     
    Learning Tutorial
    4
    Answers to some "weird" statistics questions with R code
    rainfireliang Weird Statistics Questions Hai Liang [email protected] The Chinese University of Hong Kong Answers to some "weird" statistics questions with R code
     
    Learning Tutorial
    5
    Конфигурация для проведения игр "Что Если Тогда"
    KonstantinHeinrich Конфигурация для проведения игр "Что Если Тогда" Список вопросов вводится при переходе по ссылке Выберите вопрос на вкладке Картинки. Изменения на гла
     
    Learning Tutorial
    3
    Ferramenta para testes de intrusão
    Josh-Washington P3ntsT00L Uma ferramenta escrita em Python, feita para Teste de intrusão. Requisitos ter o python 3.9.8 instalado em sua máquina. ter a git instalada
     
    Learning Tutorial
    9
    Frontend tech guide and collection of highly recommended materials
    mjmaurya Frontend Leraning Kit Frontend tech guide and collection of highly recommended materials Show your support by giving a ⭐ to this repo Resources 2022 F
     
    Learning Tutorial
    3
    Дискорд бот который генерирует нитро
    InfiniteCore Discord Nitro Generator Bot RUS Лицензия : MIT(Почему?Потому что самопис!) Хей , вы хотели нитро? Тогда этот бот вам его сгенерирует P.S Есть чекер Ra