Skip to main content

Flask extension to add Flask-Babel translations in JS

Project description

Flask-Babel-JS

Flask extension to add Flask-Babel translations in JS.

Installation

Install via pip: pip install flask-babel-js Keep in mind that this extension expects you to have flask_babel set-up correctly beforehand.

Usage

You can initialize this extension both directly and using the application factory pattern:

from flask import Flask
from flask_babel import Babel
from flask_babel_js import BabelJS

# Initializing directly:
app = Flask(__name__)
babel = Babel(app)
babel_js = BabelJS(app)

# Initializing via application factory pattern:
babel = Babel()
babel_js = BabelJS()


def create_app():
    app = Flask(__name__)

    babel.init_app(app)
    babel_js.init_app(app)

    return app

When the extension is initialized, a new route with the name of babel_catalog is added to the list of routes. This is a JavaScript file which contains all translations in your current locale. It also includes a very basic gettext-like API which you can use. It is compatible with the javascript extraction method of Babel.

Add this to your babel.cfg to extract Javascript translation strings:

[javascript:app/static/*.js]
encoding = utf-8
extract_messages=_,gettext,ngettext

To include the translation catalog and functions, insert the following inside your Jinja templates:

<script src="{{ url_for("babel_catalog") }}"></script>

Afterwards, you can use all the functions available in the Javascript API.

Example usage in Javascript:

// Translate a string
var s = _("Some untranslated text");
// Translate a string with format values
var s2 = _("Hello, %(name)s!", { name: "John" });
// Translate a string with plural forms
var s3 = ngettext("%(n)d item was deleted.", "%(n)d items were deleted.", n, { n: n });
// You can access all these functions through the babel object:
// babel.gettext, babel.ngettext

Python API

flask_babel_js.BabelJS(app=None, view_path="/_jstrans.js")

Initializes the extension object.

Parameters:

  • app: The Flask application. Can be None if you are using the application factory pattern.
  • view_path: The path for the catalog URL. Defaults to "/_jstrans.js".

init_app(app)

Initialize an application with the extension object.

Parameters:

  • app: The Flask application.

catalog_view()

The catalog view which provides the JavaScript code for the catalog. You don't need to use this directly.

Javascript API

window.babel

The main BabelJS object.

catalog

All gettext messages for the current locale are in this object. The keys are the original arguments passed to gettext and the value is the translated version. If the translated text has a plural form, the value is an array of the plural forms.

format(text, variables)

Formats text using Python percent-formatting. Currently only supports s, d, and f as format types. Also expects a format name. For extensions, only left padding is supported.

Parameters:

  • text: A Python-format string.
  • variables: An object containing values for the format specifiers.

gettext(text, variables)

Translates a string.

This function is available globally as gettext and _.

Parameters:

  • text: The untranslated string.
  • variables: An object containing values for the format specifiers.

ngettext(text, plural_text, n, variables)

Translates a string with plural forms based on a value.

This function is available globally as ngettext.

Parameters:

  • text: The untranslated string.
  • plural_text: The untranslated string in plural form.
  • n: The amount of items by which the form is selected.
  • variables: An object containing values for the format specifiers.

plural(n)

Gets the plural form ID corresponding to the number of items for this locale.

Parameters:

  • n: The number of items.

NOTE: This function may not exist if Plural-Forms is not specified in the gettext metadata in the locale.

License

© 2020 Efe Mert Demir. This software is licensed under the 3-Clause BSD License, a copy of which can be found in LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask_babel_js-1.0.3.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

flask_babel_js-1.0.3-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file flask_babel_js-1.0.3.tar.gz.

File metadata

  • Download URL: flask_babel_js-1.0.3.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.11

File hashes

Hashes for flask_babel_js-1.0.3.tar.gz
Algorithm Hash digest
SHA256 75d56ff4c1f053f423ff788eaf9e2fab8f3da109418ad045550c337afb2a40c9
MD5 e8e21c6a861fd1f1b1f3e3cbed7e2d68
BLAKE2b-256 965522b9ccc3959f47c33f045ec630be7aa9098610101868312c35fa575b8f46

See more details on using hashes here.

File details

Details for the file flask_babel_js-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for flask_babel_js-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 47c643f58d377ffc735f861930d843d97277b7bec361335b1fbf96679b34935e
MD5 b1759920e1bbea691dcf3a19c42a4e77
BLAKE2b-256 5670f120bc46fa9933267516e276c5d5740b760d043802c8a0803a709a8cc1a0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page