2018-02-27T18:13:23Z

The Flask Mega-Tutorial Part XIII: I18n and L10n

This is the thirteenth installment of the Flask Mega-Tutorial series, in which I'm going to tell you how to expand Microblog to support multiple languages. As part of that effort you will also learn about creating your own CLI extensions to the flask command.

For your reference, below is a list of the articles in this series.

Note 1: If you are looking for the legacy version of this tutorial, it's here.

Note 2: If you would like to support my work on this blog, or just don't have patience to wait for weekly articles, I am offering the complete version of this tutorial packaged as an ebook or a set of videos. For more information, visit courses.miguelgrinberg.com.

The topics of this chapter are Internationalization and Localization, commonly abbreviated I18n and L10n. To make my application friendly to people who do not speak English, I'm going to implement a translation workflow that, with the help of language translators, will allow me to offer the application to users in a choice of languages.

The GitHub links for this chapter are: Browse, Zip, Diff.

Introduction to Flask-Babel

As you can probably guess, there is a Flask extension that makes working with translations very easy. The extension is called Flask-Babel and is installed with pip:

(venv) $ pip install flask-babel

Flask-Babel is initialized like most other Flask extensions:

app/__init__.py: Flask-Babel instance.

# ...
from flask_babel import Babel

app = Flask(__name__)
# ...
babel = Babel(app)

As part of this chapter, I'm going to show you how to translate the application into Spanish, as I happen to speak that language. I could also work with translators that know other languages and support those as well. To keep track of the list of supported languages, I'm going to add a configuration variable:

config.py: Supported languages list.

class Config(object):
    # ...
    LANGUAGES = ['en', 'es']

I'm using two-letter language codes for this application, but if you need to be more specific, a country code can be added as well. For example, you could use en-US, en-GB and en-CA to support American, British and Canadian English as different languages.

The Babel instance provides a localeselector decorator. The decorated function is invoked for each request to select a language translation to use for that request:

app/__init__.py: Select best language.

from flask import request

# ...

@babel.localeselector
def get_locale():
    return request.accept_languages.best_match(app.config['LANGUAGES'])

Here I'm using an attribute of Flask's request object called accept_languages. This object provides a high-level interface to work with the Accept-Language header that clients send with a request. This header specifies the client language and locale preferences as a weighted list. The contents of this header can be configured in the browser's preferences page, with the default being usually imported from the language settings in the computer's operating system. Most people don't even know such a setting exists, but this is useful as users can provide a list of preferred languages, each with a weight. In case you are curious, here is an example of a complex Accept-Languages header:

Accept-Language: da, en-gb;q=0.8, en;q=0.7

This says that Danish (da) is the preferred language (with default weight = 1.0), followed by British English (en-GB) with a 0.8 weight, and as a last option generic English (en) with a 0.7 weight.

To select the best language, you need to compare the list of languages requested by the client against the languages the application supports, and using the client provided weights, find the best language. The logic to do this is somewhat complicated, but it is all encapsulated in the best_match() method, which takes the list of languages offered by the application as an argument and returns the best choice.

Marking Texts to Translate In Python Source Code

Okay, so now comes the bad news. The normal workflow when making an application available in multiple languages is to mark all the texts that need translations in the source code. After the texts are marked, Flask-Babel will scan all the files and extract those texts into a separate translation file using the gettext tool. Unfortunately this is a tedious task that needs to be done to enable translations.

I'm going to show you a few examples of this marking here, but you can get the complete set of changes from the download package for this chapter or the GitHub repository.

The way texts are marked for translation is by wrapping them in a function call that as a convention is called _(), just an underscore. The simplest cases are those where literal strings appear in the source code. Here is an example flash() statement:

from flask_babel import _
# ...
flash(_('Your post is now live!'))

The idea is that the _() function wraps the text in the base language (English in this case). This function will use the best language selected by the function decorated with the localeselector function to find the correct translation for a given client. The _() function then returns the translated text, which in this case will become the argument to flash().

Unfortunately not all cases are that simple. Consider this other flash() call from the application:

flash('User {} not found.'.format(username))

This text has a dynamic component that is inserted in the middle of the static text. The _() function has a syntax that supports this type of texts, but it is based on the older string substitution syntax:

flash(_('User %(username)s not found.', username=username))

There is an even harder case to handle. Some string literals are assigned outside of a request, usually when the application is starting up, so at the time these texts are evaluated there is no way to know what language to use. An example of this is the labels associated with form fields. The only solution to handle those texts is to find a way to delay the evaluation of the string until it is used, which is going to be under an actual request. Flask-Babel provides a lazy evaluation version of _() that is called lazy_gettext():

from flask_babel import lazy_gettext as _l

class LoginForm(FlaskForm):
    username = StringField(_l('Username'), validators=[DataRequired()])
    # ...

Here I'm importing this alternative translation function and renaming to to _l() so that it looks similar to the original _(). This new function wraps the text in a special object that triggers the translation to be performed later, when the string is used.

The Flask-Login extension flashes a message any time it redirects the user to the login page. This message is in English and comes from the extension itself. To make sure this message also gets translated, I'm going to override the default message and provide my own, wrapper with the _l() function for lazy processing:

login = LoginManager(app)
login.login_view = 'login'
login.login_message = _l('Please log in to access this page.')

Marking Texts to Translate In Templates

In the previous section you've seen how to mark translatable texts in Python source code, but that is only a part of this process, as template files also have text. The _() function is also available in templates, so the process is fairly similar. For example, consider this snippet of HTML from 404.html:

<h1>File Not Found</h1>

The translation enabled version becomes:

<h1>{{ _('File Not Found') }}</h1>

Note that here in addition to wrapping the text with _(), the {{ ... }} needs to be added, to force the _() to be evaluated instead of being considered a literal in the template.

For more complex phrases that have dynamic components, arguments can also be used:

<h1>{{ _('Hi, %(username)s!', username=current_user.username) }}</h1>

There is a particularly tricky case in _post.html that took me a while to figure out:

        {% set user_link %}
            <a href="{{ url_for('user', username=post.author.username) }}">
                {{ post.author.username }}
            </a>
        {% endset %}
        {{ _('%(username)s said %(when)s',
            username=user_link, when=moment(post.timestamp).fromNow()) }}

The problem here is that I wanted the username to be a link that points to the profile page of the user, not just the name, so I had to create an intermediate variable called user_link using the set and endset template directives, and then pass that as an argument to the translation function.

As I mentioned above, you can download a version of the application with all the translatable texts in Python source code and templates marked.

Extracting Text to Translate

Once you have the application with all the _() and _l() in place, you can use the pybabel command to extract them to a .pot file, which stands for portable object template. This is a text file that includes all the texts that were marked as needing translation. The purpose of this file is to serve as a template to create translation files for each language.

The extraction process needs a small configuration file that tells pybabel what files should be scanned for translatable texts. Below you can see the babel.cfg that I created for this application:

babel.cfg: PyBabel configuration file.

[python: app/**.py]
[jinja2: app/templates/**.html]
extensions=jinja2.ext.autoescape,jinja2.ext.with_

The first two lines define the filename patterns for Python and Jinja2 template files respectively. The third line defines two extensions provided by the Jinja2 template engine that help Flask-Babel properly parse template files.

To extract all the texts to the .pot file, you can use the following command:

(venv) $ pybabel extract -F babel.cfg -k _l -o messages.pot .

The pybabel extract command reads the configuration file given in the -F option, then scans all the code and template files in the directories that match the configured sources, starting from the directory given in the command (the current directory or . in this case). By default, pybabel will look for _() as a text marker, but I have also used the lazy version, which I imported as _l(), so I need to tell the tool to look for those too with the -k _l. The -o option provides the name of the output file.

I should note that the messages.pot file is not a file that needs to be incorporated into the project. This is a file that can be easily regenerated any time it is needed, simply by running the command above again. So there is no need to commit this file to source control.

Generating a Language Catalog

The next step in the process is to create a translation for each language that will be supported in addition to the base one, which in this case is English. I said I was going to start by adding Spanish (language code es), so this is the command that does that:

(venv) $ pybabel init -i messages.pot -d app/translations -l es
creating catalog app/translations/es/LC_MESSAGES/messages.po based on messages.pot

The pybabel init command takes the messages.pot file as input and writes a new language catalog to the directory given in the -d option for the language specified in the -l option. I'm going to be installing all the translations in the app/translations directory, because that is where Flask-Babel will expect translation files to be by default. The command will create a es subdirectory inside this directory for the Spanish data files. In particular, there will be a new file named app/translations/es/LC_MESSAGES/messages.po, that is where the translations need to be made.

If you want to support other languages, just repeat the above command with each of the language codes you want, so that each language gets its own repository with a messages.po file.

This messages.po file that created in each language repository uses a format that is the de facto standard for language translations, the format used by the gettext utility. Here are a few lines from the beginning of the Spanish messages.po:

# Spanish translations for PROJECT.
# Copyright (C) 2017 ORGANIZATION
# This file is distributed under the same license as the PROJECT project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2017.
#
msgid ""
msgstr ""
"Project-Id-Version: PROJECT VERSION\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2017-09-29 23:23-0700\n"
"PO-Revision-Date: 2017-09-29 23:25-0700\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: es\n"
"Language-Team: es <LL@li.org>\n"
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.5.1\n"

#: app/email.py:21
msgid "[Microblog] Reset Your Password"
msgstr ""

#: app/forms.py:12 app/forms.py:19 app/forms.py:50
msgid "Username"
msgstr ""

#: app/forms.py:13 app/forms.py:21 app/forms.py:43
msgid "Password"
msgstr ""

If you skip the header, you can see that what follows is a list of strings that were extracted from the _() and _l() calls. For each text, you get a reference to the location of the text in your application. Then the msgid line contains the text in the base language, and the msgstr line that follows contains an empty string. Those empty strings need to be edited to have the version of the text in the target language.

There are many translation applications that work with .po files. If you feel comfortable editing the text file, then that's sufficient, but if you are working with a large project it may be recommended to work with a specialized editor. The most popular translation application is the open-source poedit, which is available for all major operating systems. If you are familiar with vim, then the po.vim plugin gives some key mappings that make working with these files easier.

Below you can see a portion of the Spanish messages.po after I added the translations:

#: app/email.py:21
msgid "[Microblog] Reset Your Password"
msgstr "[Microblog] Nueva Contraseña"

#: app/forms.py:12 app/forms.py:19 app/forms.py:50
msgid "Username"
msgstr "Nombre de usuario"

#: app/forms.py:13 app/forms.py:21 app/forms.py:43
msgid "Password"
msgstr "Contraseña"

The download package for this chapter also contains this file with all the translations in place, so that you don't have to worry about that part for this application.

The messages.po file is a sort of source file for translations. When you want to start using these translated texts, this file needs to be compiled into a format that is efficient to be used by the application at run-time. To compile all the translations for the application, you can use the pybabel compile command as follows:

(venv) $ pybabel compile -d app/translations
compiling catalog app/translations/es/LC_MESSAGES/messages.po to
app/translations/es/LC_MESSAGES/messages.mo

This operation adds a messages.mo file next to messages.po in each language repository. The .mo file is the file that Flask-Babel will use to load translations for the application.

After you create the messages.mo file for Spanish or any other languages you added to the project, these languages are ready to be used in the application. If you want to see how the application looks in Spanish, you can edit the language configuration in your web browser to have Spanish as the preferred language. For Chrome, this is the Advanced part of the Settings page:

Chrome Language Options

If you prefer not to change your browser settings, the other alternative is to force a language by making the localeselector function always return it. For Spanish, this would be how you would do it:

app/__init__.py: Select best language.

@babel.localeselector
def get_locale():
    # return request.accept_languages.best_match(app.config['LANGUAGES'])
    return 'es'

Running the application with the browser configured for Spanish, or the localeselector function returning es will make all the texts appear in Spanish when you use the application.

Updating the Translations

One common situation when working with translations is that you may want to start using a translation file even if it is incomplete. That is totally fine, you can compile an incomplete messages.po file and any translations that are available will be used, while any missing ones will use the base language. You can then continue working on the translations and compile again to update the messages.mo file as you make progress.

Another common scenario occurs if you missed some texts when you added the _() wrappers. In this case you are going to see that those texts that you missed are going to remain in English, because Flask-Babel knows nothing about them. In this situation you'll want to add the _() or _l() wrappers when you detect texts that don't have them, and then do an update procedure, which involves two steps:

(venv) $ pybabel extract -F babel.cfg -k _l -o messages.pot .
(venv) $ pybabel update -i messages.pot -d app/translations

The extract command is identical to the one I issued earlier, but now it will generate a new version of messages.pot with all the previous texts plus anything new that you recently wrapped with _() or _l(). The update call takes the new messages.pot file and merges it into all the messages.po files associated with the project. This is going to be an intelligent merge, in which any existing texts will be left alone, while only entries that were added or removed in messages.pot will be affected.

After the messages.po are updated, you can go ahead and translate any new tests, then compile the messages one more time to make them available to the application.

Translating Dates and Times

Now I have a complete Spanish translation for all the texts in Python code and templates, but if you run the application in Spanish and are a good observer, you will notice that there are still a few things that appear in English. I'm referring to the timestamps generated by Flask-Moment and moment.js, which obviously have not been included in the translation effort because none of the texts generated by these packages are part of the source code or templates of the application.

The moment.js library does support localization and internationalization, so all I need to do is configure the proper language. Flask-Babel returns the selected language and locale for a given request via the get_locale() function, so what I'm going to do is add the locale to the g object, so that I can then access it from the base template:

app/routes.py: Store selected language in flask.g.

# ...
from flask import g
from flask_babel import get_locale

# ...

@app.before_request
def before_request():
    # ...
    g.locale = str(get_locale())

The get_locale() function from Flask-Babel returns a locale object, but I just want to have the language code, which can be obtained by converting the object to a string. Now that I have g.locale, I can access it from the base template to configure moment.js with the correct language:

app/templates/base.html: Set locale for moment.js.

...
{% block scripts %}
    {{ super() }}
    {{ moment.include_moment() }}
    {{ moment.lang(g.locale) }}
{% endblock %}

And now all dates and times should appear in the same language as the text. Below you can see how the application looks in Spanish:

Microblog in Español

At this point, all texts except those that were provided by the user in blog posts or profile descriptions should be translatable into other languages.

Command-Line Enhancements

You will probably agree with me that the pybabel commands are a bit long and difficult to remember. I'm going to use this opportunity to show you how you can create custom commands that are integrated with the flask command. So far, you've seen me use flask run, flask shell, and several flask db sub-commands provided by the Flask-Migrate extension. It is actually easy to add application-specific commands to flask as well. So what I'm going to do now is create a few simple commands that trigger the pybabel commands with all the arguments that are specific to this application. The commands that I'm going to add are:

  • flask translate init LANG to add a new language
  • flask translate update to update all language repositories
  • flask translate compile to compile all language repositories

The babel extract step is not going to be a command, because generating the messages.pot file is always a pre-requisite to running either the init or the update commands, so the implementation of these commands will generate the translation template file as a temporary file.

Flask relies on Click for all its command-line operations. Commands like translate, which are a root for several sub-commands are created via the app.cli.group() decorator. I'm going to put these commands in a new module called app/cli.py:

app/cli.py: Translate command group.

from app import app

@app.cli.group()
def translate():
    """Translation and localization commands."""
    pass

The name of the command comes from the name of the decorated function, and the help message comes from the docstring. Since this is a parent command that only exists to provide a base for the sub-commands, the function itself does not need to do anything.

The update and compile are easy to implement, because they do not take any arguments:

app/cli.py: Update and compile sub-commands.

import os

# ...

@translate.command()
def update():
    """Update all languages."""
    if os.system('pybabel extract -F babel.cfg -k _l -o messages.pot .'):
        raise RuntimeError('extract command failed')
    if os.system('pybabel update -i messages.pot -d app/translations'):
        raise RuntimeError('update command failed')
    os.remove('messages.pot')

@translate.command()
def compile():
    """Compile all languages."""
    if os.system('pybabel compile -d app/translations'):
        raise RuntimeError('compile command failed')

Note how the decorator from these functions is derived from the translate parent function. This may seem confusing, since translate() is a function, but it is the standard way in which Click builds groups of commands. Same as with the translate() function, the docstrings for these functions are used as help message in the --help output.

You can see that for all commands, I run them and make sure that the return value is zero, which implies that the command did not return any error. If the command errors, then I raise a RuntimeError, which will cause the script to stop. The update() function combines the extract and update steps in the same command, and if everything is successful, it deletes the messages.pot file after the update is complete, since this file can be easily regenerated when needed again.

The init command takes the new language code as an argument. Here is the implementation:

app/cli.py: Init sub-command.

import click

@translate.command()
@click.argument('lang')
def init(lang):
    """Initialize a new language."""
    if os.system('pybabel extract -F babel.cfg -k _l -o messages.pot .'):
        raise RuntimeError('extract command failed')
    if os.system(
            'pybabel init -i messages.pot -d app/translations -l ' + lang):
        raise RuntimeError('init command failed')
    os.remove('messages.pot')

This command uses the @click.argument decorator to define the language code. Click passes the value provided in the command to the handler function as an argument, and then I incorporate the argument into the init command.

The final step to enable these commands to work is to import them, so that the commands get registered. I decided to do this in the microblog.py file in the top-level directory:

microblog.py: Register command-line commands.

from app import cli

Here the only thing I need to do is import the new cli.py module, there is no need to do anything with it, as the import causes the command decorators to run and register the command.

At this point, running flask --help will list the translate command as an option. And flask translate --help will show the three sub-commands that I defined:

(venv) $ flask translate --help
Usage: flask translate [OPTIONS] COMMAND [ARGS]...

  Translation and localization commands.

Options:
  --help  Show this message and exit.

Commands:
  compile  Compile all languages.
  init     Initialize a new language.
  update   Update all languages.

So now, the workflow is much simpler and there is no need to remember long and complicated commands. To add a new language, you use:

(venv) $ flask translate init <language-code>

To update all the languages after making changes to the _() and _l() language markers:

(venv) $ flask translate update

And to compile all languages after updating the translation files:

(venv) $ flask translate compile

94 comments

  • #26 Avrohom Goldstein said 2018-06-04T18:16:32Z

    Thanks for tour tutorial! It's wonderful! I also did the "Command-Line Enhancements" part exactly as you explained but when I run "flask translate --help" command it throws following error: Error: No such command "translate". I copied your code form goithub, and on pycharm in the microblog.py file, it has a warning unused import statement on "import cli"

  • #27 Miguel Grinberg said 2018-06-04T18:24:37Z

    @Avrohom: does the application start if you run "flask run"? If that also fails, then the problem is that you have not set FLASK_APP correctly.

  • #28 Edgar Sánchez Hurtado said 2018-06-09T08:27:00Z

    Hi Miguel! Great tutorial, I'm really enjoying it. I write because I had the same issue as @Sujay and your suggestions at the comment #23 were right. I was missing to set the FLASK_APP variable before running the flask command. So, for avoiding this to happen again, I edited the "venv/bin/activate" file, adding to the top: ``` export FLASK_APP=microblog.py ``` This way, from now on, any time the virtualenv is activated I'll have already the variable set. Hope it can be helpful to someone. Cheers

  • #29 Guy Turner said 2018-06-18T09:17:47Z

    Hi Miguel! Great tutorial - I am having issues with the CLI commands. I am on Windows, I have tried running the commands from standard CMD and administrator elevated CMD and I get this error for every command: extracting messages from app\__init__.py extracting messages from app\_mail.py extracting messages from app\cli.py extracting messages from app\email.py extracting messages from app\errors.py extracting messages from app\forms.py extracting messages from app\models.py extracting messages from app\routes.py extracting messages from app\templates\404.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\500.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\_pager.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\_post.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\base.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\edit_post.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\edit_profile.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\index.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\login.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\register.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\reset_password.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\reset_password_request.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\user.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") extracting messages from app\templates\email\reset_password.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_") writing PO template file to messages.pot updating catalog app/translations\es\LC_MESSAGES\messages.po based on messages.pot updating catalog app/translations\fr\LC_MESSAGES\messages.po based on messages.pot Traceback (most recent call last): File "c:\users\userxx\appdata\local\programs\python\python36\lib\runpy.py", line 193, in _run_module_as_main "__main__", mod_spec) File "c:\users\userxx\appdata\local\programs\python\python36\lib\runpy.py", line 85, in _run_code exec(code, run_globals) File "C:\Users\userxx\AppData\Local\Programs\Python\Python36\Scripts\pybabel.exe\__main__.py", line 9, in <module> File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\babel\messages\frontend.py", line 911, in main return CommandLineInterface().run(sys.argv) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\babel\messages\frontend.py", line 835, in run return cmdinst.run() File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\babel\messages\frontend.py", line 728, in run with open(filename, 'rb') as infile: PermissionError: [Errno 13] Permission denied: 'app/translations\\fr\\LC_MESSAGES\\messages.po' Traceback (most recent call last): File "c:\users\userxx\appdata\local\programs\python\python36\lib\runpy.py", line 193, in _run_module_as_main "__main__", mod_spec) File "c:\users\userxx\appdata\local\programs\python\python36\lib\runpy.py", line 85, in _run_code exec(code, run_globals) File "C:\Users\userxx\AppData\Local\Programs\Python\Python36\Scripts\flask.exe\__main__.py", line 9, in <module> File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\flask\cli.py", line 513, in main cli.main(args=args, prog_name=name) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\flask\cli.py", line 380, in main return AppGroup.main(self, *args, **kwargs) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 697, in main rv = self.invoke(ctx) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 1066, in invoke return _process_result(sub_ctx.command.invoke(sub_ctx)) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 1066, in invoke return _process_result(sub_ctx.command.invoke(sub_ctx)) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 895, in invoke return ctx.invoke(self.callback, **ctx.params) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 535, in invoke return callback(*args, **kwargs) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\decorators.py", line 17, in new_func return f(get_current_context(), *args, **kwargs) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\flask\cli.py", line 257, in decorator return __ctx.invoke(f, *args, **kwargs) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 535, in invoke return callback(*args, **kwargs) File "B:\directoryxx\app\cli.py", line 15, in update raise RuntimeError('update failed') RuntimeError: update failed B:\directoryxx>flask translate compile compiling catalog app/translations\es\LC_MESSAGES\messages.po to app/translations\es\LC_MESSAGES\messages.mo Traceback (most recent call last): File "c:\users\userxx\appdata\local\programs\python\python36\lib\runpy.py", line 193, in _run_module_as_main "__main__", mod_spec) File "c:\users\userxx\appdata\local\programs\python\python36\lib\runpy.py", line 85, in _run_code exec(code, run_globals) File "C:\Users\userxx\AppData\Local\Programs\Python\Python36\Scripts\pybabel.exe\__main__.py", line 9, in <module> File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\babel\messages\frontend.py", line 911, in main return CommandLineInterface().run(sys.argv) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\babel\messages\frontend.py", line 835, in run return cmdinst.run() File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\babel\messages\frontend.py", line 185, in run self._run_domain(domain) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\babel\messages\frontend.py", line 223, in _run_domain with open(po_file, 'rb') as infile: PermissionError: [Errno 13] Permission denied: 'app/translations\\fr\\LC_MESSAGES\\messages.po' Traceback (most recent call last): File "c:\users\userxx\appdata\local\programs\python\python36\lib\runpy.py", line 193, in _run_module_as_main "__main__", mod_spec) File "c:\users\userxx\appdata\local\programs\python\python36\lib\runpy.py", line 85, in _run_code exec(code, run_globals) File "C:\Users\userxx\AppData\Local\Programs\Python\Python36\Scripts\flask.exe\__main__.py", line 9, in <module> File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\flask\cli.py", line 513, in main cli.main(args=args, prog_name=name) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\flask\cli.py", line 380, in main return AppGroup.main(self, *args, **kwargs) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 697, in main rv = self.invoke(ctx) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 1066, in invoke return _process_result(sub_ctx.command.invoke(sub_ctx)) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 1066, in invoke return _process_result(sub_ctx.command.invoke(sub_ctx)) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 895, in invoke return ctx.invoke(self.callback, **ctx.params) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 535, in invoke return callback(*args, **kwargs) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\decorators.py", line 17, in new_func return f(get_current_context(), *args, **kwargs) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\flask\cli.py", line 257, in decorator return __ctx.invoke(f, *args, **kwargs) File "c:\users\userxx\appdata\local\programs\python\python36\lib\site-packages\click\core.py", line 535, in invoke return callback(*args, **kwargs) File "B:\directoryxx\app\cli.py", line 23, in compile raise RuntimeError('compile failed') RuntimeError: compile failed

  • #30 Miguel Grinberg said 2018-06-18T14:26:59Z

    @Guy: I'll test this on a Windows machine. The error that you get is a permissions error, pybabel claims it cannot write the French catalog file at app\translations\fr\LC_MESSAGES\messages.po. Can you access this path from the command prompt?

  • #31 Kungreye said 2018-06-21T07:10:45Z

    Hi, Miguel. Thank you for this great tutorial~ Everything works pretty well, except the dates & times. I cannot figure out the reason, since I configured as your instruction. After that, all related texts are translated to Chinese (zh) as expected, but the dates & times remain unchanged. # app/routes.py @app.before_request def before_request(): # ... g.locale = str(get_locale()) # app/templates/base.html {% block scripts %} {{ super() }} {{ moment.include_moment() }} {{ moment.lang(g.locale) }} {% endblock %}

  • #32 Miguel Grinberg said 2018-06-21T18:46:50Z

    @Kungreye: have you confirmed that "g.locale" is set to "zh"? Are there any error messages in the browser's console?

  • #33 Kungreye said 2018-06-22T05:50:47Z

    Really thanks for your reply, Miguel. The fact is that Moment.js locale support 3 Chinese formats (i.e. zh-cn for China mainland, zh-hk for HongKong, zh-tw for Taiwan). Since I use simplified Chinese, I will go with zh-cn. I tested moment.js and found that 'zh-cn', 'zh_cn', 'zh-CN' and 'zh_CN' are all acceptable. So, one of above four is expected from g.locale. Chrome preference setting provides Chinese(Simplified) , the language code being 'zh-CN'. So I just set chrome to be (checked by chrome dev tools): > Accept-Language: zh-CN,zh;q=0.9,en;q=0.8 (Remark: zh is automatically added by chrome, as second choice.) Accordingly, I set config.py like this : > LANGUAGES = ['en', 'zh_CN'] # also no hyphen for flask-babel. Like I said, starting the app, I get everything right, except the dates & times. As your advice, I checked the g.locale, and surprisingly found: > 'g.locale = zh_Hans_CN' Then, I checked the 'messages.po' in app/translations/zh_CN/LC_MESSAGES: # Chinese (Simplified, China) translations for PROJECT. # Copyright (C) 2018 ORGANIZATION # This file is distributed under the same license as the PROJECT project. # FIRST AUTHOR <EMAIL@ADDRESS>, 2018. # msgid "" msgstr "" "Project-Id-Version: PROJECT VERSION\n" "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" "POT-Creation-Date: 2018-06-21 17:53+0800\n" "PO-Revision-Date: 2018-06-21 17:03+0800\n" "Last-Translator: \n" "Language: zh_CN\n" "Language-Team: zh_Hans_CN <LL@li.org>\n" "Plural-Forms: nplurals=1; plural=0\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.6.0\n" I don't quite understand why the zh_Hans_CN (language team) was assigned to g.locale, instead of zh_CN (language). When I manually changed the g.locale to 'zh_CN' in routes.py: > g.locale = 'zh_CN' # or 'zh-CN' / 'zh-cn' / 'zh_cn' Then the dates & times are good.

  • #34 Miguel Grinberg said 2018-06-22T06:36:13Z

    @Kungreye: I did not know this, but it looks like the language code for simplified Chinese is zh-Hans-CN. Is there any chance that your web browser is reporting that language code? In that case, you should create your translation files under that language code and then I think everything should work.

  • #35 Kungreye said 2018-06-22T09:08:13Z

    You are right, Miguel. I just came to know Chinese languages involves numerous codes..... Everything goes well after I modified as this: > g.locale = 'zh-cn' if str(get_locale()).startswith('zh') else str(get_locale()) Really thank you for your patience & time, Miguel.

  • #36 Chet said 2018-06-26T01:22:37Z

    this happen to me too... Error: No such command "translate". and i don't know how to fix yet, i use Windows

  • #37 Miguel Grinberg said 2018-06-27T15:08:08Z

    @Chet: make sure your FLASK_APP variable is correctly set, as shown in Chapter 1.

  • #38 miss pie said 2018-08-25T12:45:33Z

    I followed another tutorial first and found your tutorial about translations (Chapter 13: I18n and L10n). I implemented your examples with another tutorial and everything works fine. When switching through browser settings i get text in another language. However, i miss a general translation button switch for users. You don't cover that in your tutorials? i quickly looked at the next chapter (ajax - live translation) and couldn't find that there either. Please advice. I am trying to make a multi lingual website with flask/python. (i am a newby) Thanks in advance!

  • #39 Miguel Grinberg said 2018-08-25T19:08:01Z

    @miss: what do you mean by "general translation button"? If you want the user to pick a language, you can implement that with a web form. This tutorial uses the language information provided by the browser to select a language, but you should be able to offer the selection to the user without having to make a lot of changes.

  • #40 Oleg Kovalenko said 2018-09-08T18:49:17Z

    Hi Miguel, Have you seen other solutions for language translations where the source and template strings don't have to be marked by _() and _l()? Perhaps something in your Flask O'Reilly book? It feels like littering the source with those functions isn't the way to go. If you know of any, could you point me in the direction of a more organized solution? Thanks, Oleg

  • #41 Miguel Grinberg said 2018-09-13T20:59:03Z

    @Oleg: marking text for translation is the standard way to do this in pretty much any programming language. I don't know of an automatic way of extracting texts, sorry.

  • #42 Jay Jethva said 2018-09-23T19:58:07Z

    Bienvenidos a esta plataforma de desarrollo web! Error: the translation service is not configured.

  • #43 Miguel Grinberg said 2018-09-25T18:04:19Z

    @Jay: You did not configure your translation service key.

  • #44 Jonas said 2018-09-26T18:00:59Z

    Hi Miguel, thank you for this nice article! I added support for english [en] to my page. If I set up the language setting in firefox like this: [en-us][de][en] Firefox will load the german version. When I exchange [en] and [de] it loads the english version. Is this intended or am I doing something wrong?

  • #45 Miguel Grinberg said 2018-09-27T10:07:13Z

    @Jonas: Basically with this configuration you are saying that your first preference is US English, followed by German, followed by generic English. Do you have a translation for US English? I suspect you only have generic English, so for that reason German is picked first.

  • #46 Krzysztof said 2018-10-07T01:36:12Z

    Hello Miguel, I managed to integrate the localisation support, but I seem to fail at integrating command-line enhancements. Due to the fact that I have the blog hosted on pythonanywhere there seem to be some extra steps that would be required to add these new commands to the command line. I tried importing cli to the wsgi file, but it didn't help ("imported but unused"). Do you happen to have an idea what needs to be done to solve the issue? Best Regards, Chris

  • #47 Miguel Grinberg said 2018-10-07T07:44:24Z

    @Krzysztof: I'm not very familiar with PythonAnywhere, but my understanding is that it gives you a terminal where you can run "flask shell", "flask run", etc. correct? If that is true, then I don't see how your own commands would not work.

  • #48 Sean said 2018-10-16T09:14:54Z

    Hi Miguel, Thanks for the excellent tutorial. I have a weird problem: everthing works well except that it's still in English. After I found this issue on my own version, I tried using yours. The steps were: 1. Download the zip file and unzip it. 2. Start a new terminal session and Go to the microblog-0.13 folder: cd Downloads/microblog-0.13/ 3. nano .flaskenv (insert "FLASK_APP=microblog.py" and save it) 4. Use the vitual enviroment set for microblog that includes flask and relative extensions: pyenv local venv 5. Upgrade database: flask db upgrade 6. open app/__init__.py modify the get_locale() function, force it to return 'es' @babel.localeselector def get_locale(): return 'es' # return request.accept_languages.best_match(app.config['LANGUAGES']) 7. Run the app: flask run 8. Go to Chrome: http://localhost:5000 play around, try different features 9. Only time become espanol. for example on the explore page I see: Hi, susan! Say something ------------------------------- - - ------------------------------- submit sean said hace 4 minutos It is a wonderful day! It feels like the app did not figure out it should've used the translation file. Hope you have some ideas about the possible cause of this problem. Sincerely, Sean(Zhiheng) Below are the commands I use in Terminal: ============================================= Last login: Tue Oct 16 16:51:01 on ttys002 Zhihengs-MBP:~ Zhiheng$ cd Downloads/microblog-0.13/ Zhihengs-MBP:microblog-0.13 Zhiheng$ nano .flaskenv Zhihengs-MBP:microblog-0.13 Zhiheng$ pyenv local venv Zhihengs-MBP:microblog-0.13 Zhiheng$ pyenv version venv (set by /Users/Zhiheng/Downloads/microblog-0.13/.python-version) Zhihengs-MBP:microblog-0.13 Zhiheng$ pip freeze alembic==1.0.0 appnope==0.1.0 Babel==2.6.0 backcall==0.1.0 bleach==3.0.2 blinker==1.4 certifi==2018.8.24 chardet==3.0.4 Click==7.0 decorator==4.3.0 defusedxml==0.5.0 dominate==2.3.4 entrypoints==0.2.3 Flask==1.0.2 Flask-Babel==0.11.2 Flask-Bootstrap==3.3.7.1 Flask-Login==0.4.1 Flask-Mail==0.9.1 Flask-Migrate==2.2.1 Flask-Moment==0.6.0 Flask-SQLAlchemy==2.3.2 Flask-WTF==0.14.2 idna==2.7 ipykernel==5.1.0 ipython==7.0.1 ipython-genutils==0.2.0 ipywidgets==7.4.2 itsdangerous==0.24 jedi==0.13.1 Jinja2==2.10 jsonschema==2.6.0 jupyter==1.0.0 jupyter-client==5.2.3 jupyter-console==6.0.0 jupyter-core==4.4.0 Mako==1.0.7 MarkupSafe==1.0 mistune==0.8.4 nbconvert==5.4.0 nbformat==4.4.0 notebook==5.7.0 pandocfilters==1.4.2 parso==0.3.1 pexpect==4.6.0 pickleshare==0.7.5 pkginfo==1.4.2 prometheus-client==0.4.1 prompt-toolkit==2.0.5 ptyprocess==0.6.0 Pygments==2.2.0 PyJWT==1.6.4 python-dateutil==2.7.3 python-dotenv==0.9.1 python-editor==1.0.3 pytz==2018.5 pyzmq==17.1.2 qtconsole==4.4.1 requests==2.19.1 requests-toolbelt==0.8.0 Send2Trash==1.5.0 simplegeneric==0.8.1 six==1.11.0 SQLAlchemy==1.2.12 terminado==0.8.1 testpath==0.4.2 tornado==5.1.1 tqdm==4.23.4 traitlets==4.3.2 twine==1.11.0 urllib3==1.23 visitor==0.1.3 wcwidth==0.1.7 webencodings==0.5.1 Werkzeug==0.14.1 widgetsnbextension==3.4.2 WTForms==2.2.1 Zhihengs-MBP:microblog-0.13 Zhiheng$ flask db upgrade [2018-10-16 16:53:36,576] INFO in __init__: Microblog startup INFO [alembic.runtime.migration] Context impl SQLiteImpl. INFO [alembic.runtime.migration] Will assume non-transactional DDL. INFO [alembic.runtime.migration] Running upgrade -> e517276bb1c2, users table INFO [alembic.runtime.migration] Running upgrade e517276bb1c2 -> 780739b227a7, posts table INFO [alembic.runtime.migration] Running upgrade 780739b227a7 -> 37f06a334dbf, new fields in user model INFO [alembic.runtime.migration] Running upgrade 37f06a334dbf -> ae346256b650, followers Zhihengs-MBP:microblog-0.13 Zhiheng$ flask run * Serving Flask app "microblog.py" * Environment: production WARNING: Do not use the development server in a production environment. Use a production WSGI server instead. * Debug mode: off [2018-10-16 16:57:42,023] INFO in __init__: Microblog startup * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit) 127.0.0.1 - - [16/Oct/2018 16:57:50] "GET / HTTP/1.1" 302 -

  • #49 Miguel Grinberg said 2018-10-16T22:27:06Z

    @Sean: did you compile the Spanish translation?

  • #50 Sean said 2018-10-17T13:12:25Z

    Thanks for the reply! Yeah, you are right. The espanol translation works well after I compile it! I just try someting else(following similar procedures): 1. Download the zip file and unzip it. 2. Start a new terminal session and Go to the microblog-0.13 folder: cd Downloads/microblog-0.13/ 3. nano .flaskenv (insert "FLASK_APP=microblog.py" and save it) 4. Use the vitual enviroment set for microblog that includes flask and relative extensions: pyenv local venv 5. Upgrade database: flask db upgrade 6. pybabel extract -F babel.cfg -k _l -o messages.pot . ======= Here is the weird part ====== 7. pybabel init -i messages.pot -d app/translations -l zh_CN 8. pybabel init -i messages.pot -d app/translations -l en_CA 9. Go and apply same modification to the following two files: app/translations/en_CA/LC_MESSAGES/messages.po app/translations/zh_CN/LC_MESSAGES/messages.po 11. pybabel compile -d app/translations 12. open app/__init__.py modify the get_locale() function, force it to return 'zh_CN' 13. flask run (Then I found no translation to Chinese) 14. repeat step 12, this time modify the get_locale() function, force it to return 'en_CA' 14. flask run (Then the texts are properly translated to Chinese) Then I figured out there might be something wrong with the Flask-Babel Chinese part. After that I tried 'zh', that worked fine! I guess open source package sometimes do suprise us with small bugs. :)

Leave a Comment