tornado.locale — Internationalization support¶

Translation methods for generating localized strings.

To load a locale and generate a translated string:

  1. user_locale = tornado.locale.get("es_LA")
  2. print user_locale.translate("Sign out")

tornado.locale.get() returns the closest matching locale, not necessarily thespecific locale you requested. You can support pluralization withadditional arguments to translate(), e.g.:

  1. people = [...]
  2. message = user_locale.translate(
  3.     "%(list)s is online", "%(list)s are online", len(people))
  4. print message % {"list": user_locale.list(people)}

The first string is chosen if len(people) == 1, otherwise the secondstring is chosen.

Applications should call one of load_translations (which uses a simpleCSV format) or load_gettext_translations (which uses the .mo formatsupported by gettext and related tools). If neither method is called,the Locale.translate method will simply return the original string.

tornado.locale.get(*locale_codes)[源代码]

Returns the closest match for the given locale codes.

We iterate over all given locale codes in order. If we have a tightor a loose match for the code (e.g., “en” for “enUS”), we returnthe locale. Otherwise we move to the next code in the list.

By default we return en_US if no translations are found for any ofthe specified locales. You can change the default locale withset_default_locale().
tornado.locale.set_default_locale(_code)[源代码]

Sets the default locale.

The default locale is assumed to be the language used for all stringsin the system. The translations loaded from disk are mappings fromthe default locale to the destination locale. Consequently, you don’tneed to create a translation file for the default locale.
tornado.locale.loadtranslations(_directory, encoding=None)[源代码]

Loads translations from CSV files in a directory.

Translations are strings with optional Python-style named placeholders(e.g., My name is %(name)s) and their associated translations.

The directory should have translation files of the form LOCALE.csv,e.g. esGT.csv. The CSV files should have two or three columns: string,translation, and an optional plural indicator. Plural indicators shouldbe one of “plural” or “singular”. A given string can have both singularand plural forms. For example %(name)s liked this may have adifferent verb conjugation depending on whether %(name)s is onename or a list of names. There should be two rows in the CSV file forthat string, one with plural indicator “singular”, and one “plural”.For strings with no verbs that would change on translation, simplyuse “unknown” or the empty string (or don’t include the column at all).

The file is read using the csv module in the default “excel” dialect.In this format there should not be spaces after the commas.

If no encoding parameter is given, the encoding will bedetected automatically (among UTF-8 and UTF-16) if the filecontains a byte-order marker (BOM), defaulting to UTF-8 if no BOMis present.

Example translation es_LA.csv:



  1. "I love you","Te amo"
    "%(name)s liked this","A %(name)s les gustó esto","plural"
    "%(name)s liked this","A %(name)s le gustó esto","singular"





在 4.3 版更改: Added encoding parameter. Added support for BOM-based encodingdetection, UTF-16, and UTF-8-with-BOM.

tornado.locale.load_gettext_translations(_directory, domain)[源代码]

Loads translations from gettext‘s locale tree

Locale tree is similar to system’s /usr/share/locale, like:



  1. {directory}/{lang}/LCMESSAGES/{domain}.mo




Three steps are required to have you app translated:

    -
    Generate POT translation file:



    xgettext —language=Python —keyword=    :1,2 -d mydomain file1.py file2.html etc




    -
    Merge against existing POT file:



    msgmerge old.po mydomain.po > new.po




    -
    Compile:



    msgfmt mydomain.po -o {directory}/ptBR/LC_MESSAGES/mydomain.mo



tornado.locale.get_supported_locales()[源代码]

Returns a list of all the supported locale codes.
_class tornado.locale.Locale(code, translations)[源代码]

Object representing a locale.

After calling one of load_translations or load_gettext_translations,call get or get_closest to get a Locale object.
classmethod getclosest(*localecodes)[源代码]

Returns the closest match for the given locale code.
classmethod get(code)[源代码]

Returns the Locale for the given locale code.

If it is not supported, we raise an exception.
translate(message, plural_message=None, count=None)[源代码]

Returns the translation for the given message for this locale.

If pluralmessage is given, you must also providecount. We return plural_message when count != 1,and we return the singular form for the given message whencount == 1.
format_date(_date, gmt_offset=0, relative=True, shorter=False, full_format=False)[源代码]

Formats the given date (which should be GMT).

By default, we return a relative time (e.g., “2 minutes ago”). Youcan return an absolute date string with relative=False.

You can force a full format date (“July 10, 1980”) withfullformat=True.

This method is primarily intended for dates in the past.For dates in the future, we fall back to full format.
format_day(_date, gmt_offset=0, dow=True)[源代码]

Formats the given date as a day of week.

Example: “Monday, January 22”. You can remove the day of week withdow=False.
list(parts)[源代码]

Returns a comma-separated list for the given list of parts.

The format is, e.g., “A, B and C”, “A and B” or just “A” for listsof size 1.
friendlynumber(_value)[源代码]

Returns a comma-separated number for the given integer.
class tornado.locale.CSVLocale(code, translations)[源代码]

Locale implementation using tornado’s CSV translation format.
class tornado.locale.GettextLocale(code, translations)[源代码]

Locale implementation using the gettext module.
pgettext(context, message, plural_message=None, count=None)[源代码]

Allows to set context for translation, accepts plural forms.

Usage example:



  1. pgettext("law", "right")
    pgettext("good", "right")




Plural message example:



  1. pgettext("organization", "club", "clubs", len(clubs))
    pgettext("stick", "club", "clubs", len(clubs))




To generate POT file with context, add following options to step 1of load_gettext_translations sequence:



  1. xgettext [basic options] —keyword=pgettext:1c,2 —keyword=pgettext:1c,2,3





4.2 新版功能.

原文:

https://tornado-zh-cn.readthedocs.io/zh_CN/latest/locale.html