babel.support.Translations Class Reference

Inheritance diagram for babel.support.Translations:

Collaboration diagram for babel.support.Translations:

Public Member Functions
	__init__ (self, gettext._TranslationsReader|None fp=None, str|None domain=None)
NullTranslations	load (cls, str|os.PathLike[str]|None dirname=None, Iterable[str|Locale]|Locale|str|None locales=None, str|None domain=None)
str	__repr__ (self)
	add (self, Translations translations, bool merge=True)
	merge (self, Translations translations)
Public Member Functions inherited from babel.support.NullTranslations
str	dgettext (self, str domain, str message)
str	ldgettext (self, str domain, str message)
str	udgettext (self, str domain, str message)
str	dngettext (self, str domain, str singular, str plural, int num)
str	ldngettext (self, str domain, str singular, str plural, int num)
str	udngettext (self, str domain, str singular, str plural, int num)
str|object	pgettext (self, str context, str message)
str|bytes|object	lpgettext (self, str context, str message)
str	npgettext (self, str context, str singular, str plural, int num)
str|bytes	lnpgettext (self, str context, str singular, str plural, int num)
str	upgettext (self, str context, str message)
str	unpgettext (self, str context, str singular, str plural, int num)
str|object	dpgettext (self, str domain, str context, str message)
str	udpgettext (self, str domain, str context, str message)
str|bytes|object	ldpgettext (self, str domain, str context, str message)
str	dnpgettext (self, str domain, str context, str singular, str plural, int num)
str	udnpgettext (self, str domain, str context, str singular, str plural, int num)
str|bytes	ldnpgettext (self, str domain, str context, str singular, str plural, int num)

Public Attributes
	domain
Public Attributes inherited from babel.support.NullTranslations
	files
	domain

Static Public Attributes
str	DEFAULT_DOMAIN = 'messages'
	ugettext = gettext.GNUTranslations.gettext
	ungettext = gettext.GNUTranslations.ngettext
Static Public Attributes inherited from babel.support.NullTranslations
	DEFAULT_DOMAIN = None
str	dugettext = udgettext
str	dungettext = udngettext
str	CONTEXT_ENCODING = '%s\x04%s'
str	dupgettext = udpgettext
str	dunpgettext = udnpgettext
	ugettext = gettext.NullTranslations.gettext
	ungettext = gettext.NullTranslations.ngettext

Additional Inherited Members
Static Protected Attributes inherited from babel.support.NullTranslations
dict	_info [str, str]
NullTranslations	_fallback | None

Detailed Description

An extended translation catalog class.

Constructor & Destructor Documentation

__init__()

babel.support.Translations.__init__	(		self,
		gettext._TranslationsReader | None	fp = None,
		str | None	domain = None
	)

Initialize the translations catalog.

:param fp: the file-like object the translation should be read from
:param domain: the message domain (default: 'messages')

Reimplemented from babel.support.NullTranslations.

Member Function Documentation

add()

babel.support.Translations.add	(		self,
		Translations	translations,
		bool	merge = True
	)

Add the given translations to the catalog.

If the domain of the translations is different than that of the
current catalog, they are added as a catalog that is only accessible
by the various ``d*gettext`` functions.

:param translations: the `Translations` instance with the messages to
                     add
:param merge: whether translations for message domains that have
              already been added should be merged with the existing
              translations

load()

NullTranslations babel.support.Translations.load	(		cls,
		str | os.PathLike[str] | None	dirname = None,
		Iterable[str | Locale] | Locale | str | None	locales = None,
		str | None	domain = None
	)

Load translations from the given directory.

:param dirname: the directory containing the ``MO`` files
:param locales: the list of locales in order of preference (items in
                this list can be either `Locale` objects or locale
                strings)
:param domain: the message domain (default: 'messages')

merge()

babel.support.Translations.merge	(		self,
		Translations	translations
	)

Merge the given translations into the catalog.

Message translations in the specified catalog override any messages
with the same identifier in the existing catalog.

:param translations: the `Translations` instance with the messages to
                     merge

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/babel/support.py