betty.locale.localizable module¶
The localizable API allows objects to be localized at the point of use.
- class betty.locale.localizable.Localizable[source]¶
Bases:
object
A localizable object.
Objects of this type can convert themselves to localized strings at the point of use.
- localize(localizer: betty.locale.Localizer) str [source]¶
Localize
self
to a human-readable string.- Parameters:
localizer (
betty.locale.Localizer
)- Return type:
- betty.locale.localizable.call(call: collections.abc.Callable[[betty.locale.Localizer], str]) betty.locale.localizable.Localizable [source]¶
Create a new localizable that outputs the callable’s return value.
- Parameters:
call (
collections.abc.Callable
[[betty.locale.Localizer
],str
])- Return type:
- betty.locale.localizable.format(localizable: betty.locale.localizable.Localizable, *format_args: str | betty.locale.localizable.Localizable, **format_kwargs: str | betty.locale.localizable.Localizable) betty.locale.localizable.Localizable [source]¶
Perform string formatting.
The arguments are identical to those of :py:meth:
str.format
.- Parameters:
localizable (
betty.locale.localizable.Localizable
)format_args (
str
|betty.locale.localizable.Localizable
)format_kwargs (
str
|betty.locale.localizable.Localizable
)
- Return type:
- betty.locale.localizable.gettext(message: str) betty.locale.localizable._GettextLocalizable [source]¶
Like
gettext.gettext()
.Positional arguments are identical to those of
gettext.gettext()
. Keyword arguments are identical to those of :py:met:`str.format`, except that anybetty.locale.Localizable
will be localized before string formatting.- Parameters:
message (
str
)- Return type:
betty.locale.localizable._GettextLocalizable
- betty.locale.localizable.ngettext(message_singular: str, message_plural: str, n: int) betty.locale.localizable._GettextLocalizable [source]¶
Like
gettext.ngettext()
.Positional arguments are identical to those of
gettext.ngettext()
. Keyword arguments are identical to those of :py:met:`str.format`, except that anybetty.locale.Localizable
will be localized before string formatting.
- betty.locale.localizable.npgettext(context: str, message_singular: str, message_plural: str, n: int) betty.locale.localizable._GettextLocalizable [source]¶
Like
gettext.npgettext()
.Positional arguments are identical to those of
gettext.npgettext()
. Keyword arguments are identical to those of :py:met:`str.format`, except that anybetty.locale.Localizable
will be localized before string formatting.
- betty.locale.localizable.pgettext(context: str, message: str) betty.locale.localizable._GettextLocalizable [source]¶
Like
gettext.pgettext()
.Positional arguments are identical to those of
gettext.pgettext()
. Keyword arguments are identical to those of :py:met:`str.format`, except that anybetty.locale.Localizable
will be localized before string formatting.
- betty.locale.localizable.plain(plain: Any) betty.locale.localizable.Localizable [source]¶
Create a new localizable that outputs the given plain text string.
Keyword arguments are identical to those of :py:met:`str.format`, except that any
betty.locale.Localizable
will be localized before string formatting.- Parameters:
plain (
typing.Any
)- Return type: