wikidata.client — Client session

wikidata.client.WIKIDATA_BASE_URL = 'https://www.wikidata.org/'

(str) The default base_url of Client constructor.

Changed in version 0.3.0: As the meaning of Client constructor’s base_url parameter, it now became to https://www.wikidata.org/ from https://www.wikidata.org/wiki/ (which contained the trailing path wiki/).

class wikidata.client.Client(base_url: str='https://www.wikidata.org/', opener: typing.Union=None, datavalue_decoder: typing.Union=None, entity_type_guess: bool=True, repr_string: typing.Union=None) → None

Wikidata client session.

Parameters:

Changed in version 0.3.0: The meaning of base_url parameter changed. It originally meant https://www.wikidata.org/wiki/ which contained the trailing path wiki/, but now it means only https://www.wikidata.org/.

New in version 0.2.0: The entity_type_guess option.

datavalue_decoder = None

(Union[Decoder, Callable[[Client, str, Mapping[str, object]], object]]) The function to decode the given datavalue. It’s typically an instance of Decoder or its subclass.

decode_datavalue(datatype: str, datavalue: typing.Mapping) → object

Decode the given datavalue using the configured datavalue_decoder.

New in version 0.3.0.

entity_type_guess = True

(bool) Whether to guess type of Entity from its id for less HTTP requests.

New in version 0.2.0.

get(entity_id: <function NewType.<locals>.new_type at 0x7fc400288488>, load: bool=False) → wikidata.entity.Entity

Get a Wikidata entity by its EntityId.

Parameters:
  • entity_id – The id of the Entity to find.
  • load (bool) – Eager loading on True. Lazy loading (False) by default.
Returns:

The found entity.
Return type:

Entity

New in version 0.3.0: The load option.

guess_entity_type(entity_id: <function NewType.<locals>.new_type at 0x7fc400288488>) → typing.Union

Guess EntityType from the given EntityId. It could return None when it fails to guess.

Note

It always fails to guess when entity_type_guess is configued to False.

Returns:The guessed EntityId, or None if it fails to guess.
Return type:Optional[EntityType]

New in version 0.2.0.