wikibaseintegrator.models.language_values

class wikibaseintegrator.models.language_values.LanguageValue(language, value=None)[source]

Bases: BaseModel

Parameters:

  • language (str) –

  • value (Optional[str]) –

__init__(language, value=None)[source]
Parameters:

  • language (str) –

  • value (str | None) –

from_json(json_data)[source]
Return type:

LanguageValue

Parameters:

json_data (Dict[str, str]) –

get_json()[source]
Return type:

Dict[str, Optional[str]]

property language: str
remove()[source]
Return type:

LanguageValue

property removed: bool
property value: str | None

The value of the LanguageValue instance. :return: A string with the value of the LanguageValue instance.

class wikibaseintegrator.models.language_values.LanguageValues[source]

Bases: BaseModel

__init__()[source]
Return type:

None

add(language_value)[source]

Add a LanguageValue object to the list

Parameters:

language_value (LanguageValue) – A LanguageValue object

Return type:

LanguageValues

Returns:

The current LanguageValues object

from_json(json_data)[source]

Create a new LanguageValues object from a JSON/dict object.

Parameters:

json_data (Dict[str, Dict]) – A dict object who use the same format as Wikibase.

Return type:

LanguageValues

Returns:

The newly created or updated object.

get(language=None)[source]

Get a LanguageValue object with the specified language. Use the default language in wbi_config if none specified.

Parameters:

language (Optional[str]) – The requested language.

Return type:

Optional[LanguageValue]

Returns:

The related LanguageValue object or None if none found.

get_json()[source]

Get a formatted dict who respect the Wikibase format.

Return type:

Dict[str, Dict]

Returns:

A dict using Wikibase format.

set(language=None, value=None, action_if_exists=ActionIfExists.REPLACE_ALL)[source]

Create or update the specified language with the valued passed in arguments.

Parameters:

  • language (Optional[str]) – The desired language.

  • value (Optional[str]) – The desired value of the LanguageValue object. Use None to delete an existing LanguageValue object from the list.

  • action_if_exists (ActionIfExists) – The action if the LanguageValue object is already defined. Can be ActionIfExists.REPLACE_ALL (default) or ActionIfExists.KEEP.

Return type:

Optional[LanguageValue]

Returns:

The created or updated LanguageValue. None if there’s no LanguageValue object with this language.

property values: Dict[str, LanguageValue]

A dict of LanguageValue with the language as key.