robot.conf.languages.Languages Class Reference

Keeps a list of languages and unifies the translations in the properties. More...

Public Member Functions
def	__init__ (self, languages=None, add_english=True)
	:param languages: Initial language or list of languages. More...
def	__iter__ (self)
def	add_language (self, lang)
	Add new language. More...
def	reset (self, languages=None, add_english=True)
	Resets the instance to the given languages. More...

Public Attributes
	bdd_prefixes
	false_strings
	headers
	languages
	settings
	true_strings

Private Member Functions
def	_add_language (self, lang)
def	_get_available_languages (self)
def	_get_languages (self, languages, add_english=True)
def	_import_languages (self, lang)
def	_resolve_languages (self, languages, add_english=True)

Detailed Description

Keeps a list of languages and unifies the translations in the properties.

Example::

    languages = Languages('de', add_english=False)
    print(languages.settings)
    languages = Languages(['pt-BR', 'Finnish', 'MyLang.py'])
    for lang in languages:
        print(lang.name, lang.code)

Definition at line 34 of file languages.py.

Constructor & Destructor Documentation

__init__()

def robot.conf.languages.Languages.__init__	(		self,
			languages = None,
			add_english = True
	)

:param languages: Initial language or list of languages.

Languages can be given as language codes or names, paths or names of language modules to load, or as :class:Language instances. :param add_english: If True, English is added automatically. :raises: :class:~robot.errors.DataError if a given language is not found.

:meth:add_language can be used to add languages after initialization.

Definition at line 45 of file languages.py.

Member Function Documentation

__iter__()

def robot.conf.languages.Languages.__iter__

(

self

)

Definition at line 147 of file languages.py.

_add_language()

def robot.conf.languages.Languages._add_language (   self,   lang  )

private

Definition at line 83 of file languages.py.

_get_available_languages()

def robot.conf.languages.Languages._get_available_languages (   self )

private

Definition at line 128 of file languages.py.

_get_languages()

def robot.conf.languages.Languages._get_languages (   self,   languages,   add_english = True  )

private

Definition at line 93 of file languages.py.

_import_languages()

def robot.conf.languages.Languages._import_languages (   self,   lang  )

private

Definition at line 137 of file languages.py.

_resolve_languages()

def robot.conf.languages.Languages._resolve_languages (   self,   languages,   add_english = True  )

private

Definition at line 108 of file languages.py.

add_language()

def robot.conf.languages.Languages.add_language	(		self,
			lang
	)

Add new language.

    :param lang: Language to add. Can be a language code or name, name or
        path of a language module to load, or a :class:`Language` instance.
    :raises: :class:`~robot.errors.DataError` if the language is not found.

    Language codes and names are passed to by :meth:`Language.from_name`.
    Language modules are imported and :class:`Language` subclasses in them
    loaded.

Definition at line 69 of file languages.py.

reset()

def robot.conf.languages.Languages.reset	(		self,
			languages = None,
			add_english = True
	)

Resets the instance to the given languages.

Definition at line 56 of file languages.py.

Member Data Documentation

bdd_prefixes

robot.conf.languages.Languages.bdd_prefixes

Definition at line 49 of file languages.py.

false_strings

robot.conf.languages.Languages.false_strings

Definition at line 51 of file languages.py.

headers

robot.conf.languages.Languages.headers

Definition at line 47 of file languages.py.

languages

robot.conf.languages.Languages.languages

Definition at line 46 of file languages.py.

settings

robot.conf.languages.Languages.settings

Definition at line 48 of file languages.py.

true_strings

robot.conf.languages.Languages.true_strings

Definition at line 50 of file languages.py.

---

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

• src/robot/conf/languages.py