pip_services3_commons.data.MultiString module

class pip_services3_commons.data.MultiString.MultiString(map: Any = None)

Bases: dict

Creates a new MultiString object and initializes it with values.

append(map: Any)

Appends a map with language-translation pairs.

Parameters

map – the map with language-translation pairs.

clear() → Any

Clears all translations from this MultiString object.

static from_tuples(*tuples: Any)pip_services3_commons.data.MultiString.MultiString

Creates a new MultiString object from language-translation pairs (tuples).

Parameters

tuples – an array that contains language-translation tuples.

Returns

a MultiString Object.

:see from_tuples_array

static from_tuples_array(tuples: Sequence[Any])pip_services3_commons.data.MultiString.MultiString

Creates a new MultiString object from language-translation pairs (tuples) specified as array.

Parameters

tuples – an array that contains language-translation tuples.

Returns

a MultiString Object.

static from_value(value: Any)pip_services3_commons.data.MultiString.MultiString

Creates a new MultiString object from a args that contains language-translation pairs.

Parameters

value – the args to initialize MultiString.

Returns

a MultiString object.

See StringValueMap

get(language: str)str

Gets a string translation by specified language. When language is not found it defaults to English (‘en’). When English is not found it takes the first args.

Parameters

language – a language two-symbol code.

Returns

a translation for the specified language or default translation.

get_languages() → List[str]

Gets all languages stored in this MultiString object,

Returns

a list with language codes.

length()int

Returns the number of translations stored in this MultiString object.

Returns

the number of translations.

put(language: str, value: Any)

Puts a new translation for the specified language.

Parameters
  • language – a language two-symbol code.

  • value – a new translation for the specified language.

remove(language: str)

Removes translation for the specified language.

Parameters

language – a language two-symbol code.