Warning

This document is for Red's development version, which can be significantly different from previous releases. If you're a regular user, you should read the Red documentation for the current stable release.

Internationalization Framework

Basic Usage

from redbot.core import commands
from redbot.core.i18n import Translator, cog_i18n

_ = Translator("ExampleCog", __file__)

@cog_i18n(_)
class ExampleCog:
    """description"""

    @commands.command()
    async def mycom(self, ctx):
        """command description"""
        await ctx.send(_("This is a test command"))

Tutorial

After making your cog, generate a messages.pot file

We recommend using redgettext - a modified version of pygettext for Red. You can install redgettext by running pip install redgettext in a command prompt.

To generate the messages.pot file, you will now need to run python -m redgettext -c [path_to_cog] This file will contain all strings to be translated, including docstrings. (For advanced usage check python -m redgettext -h)

You can now use a tool like poedit to translate the strings in your messages.pot file.

API Reference

class redbot.core.i18n.Translator(*args, **kwds)[source]

Bases: collections.abc.Callable, typing.Generic

Function to get translated strings at runtime.

__call__(untranslated)[source]

Translate the given string.

This will look for the string in the translator’s .pot file, with respect to the current locale.

load_translations()[source]

Loads the current translations.

redbot.core.i18n.cog_i18n(translator)[source]

Get a class decorator to link the translator to this cog.

redbot.core.i18n.get_babel_locale(locale=None)[source]

Function to convert a locale to a babel.core.Locale.

Parameters

locale (Optional[str]) – The locale to convert, if not specified it defaults to the bot’s locale.

Returns

The babel locale object.

Return type

babel.core.Locale

redbot.core.i18n.get_babel_regional_format(regional_format=None)[source]

Function to convert a regional format to a babel.core.Locale.

If regional_format parameter is passed, this behaves the same as get_babel_locale.

Parameters

regional_format (Optional[str]) – The regional format to convert, if not specified it defaults to the bot’s regional format.

Returns

The babel locale object.

Return type

babel.core.Locale