kgdata.wikidata.models.wdvalue#

Functions

type_check(val)

The function is here to see if the type checker is able to flag error.

Classes

`ValueGlobeCoordinate`
`ValueMonolingualText`
`ValueQuantity`
`ValueTime`
`ValueWikibaseEntityId`
`WDValue`(type, value)

class kgdata.wikidata.models.wdvalue.ValueWikibaseEntityId#

Bases: dict

clear() → None. Remove all items from D.#

copy() → a shallow copy of D#

fromkeys(value=None, /)#: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items#

keys() → a set-like object providing a view on D's keys#

pop(k[, d]) → v, remove specified key and return the corresponding value.#: If key is not found, default is returned if given, otherwise KeyError is raised

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from dict/iterable E and F.#: If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values#

id: str#

class kgdata.wikidata.models.wdvalue.ValueGlobeCoordinate#

Bases: dict

clear() → None. Remove all items from D.#

copy() → a shallow copy of D#

fromkeys(value=None, /)#: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items#

keys() → a set-like object providing a view on D's keys#

pop(k[, d]) → v, remove specified key and return the corresponding value.#: If key is not found, default is returned if given, otherwise KeyError is raised

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from dict/iterable E and F.#: If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values#

latitude: float#

longitude: float#

precision: float#

altitude: None#

globe: str#

class kgdata.wikidata.models.wdvalue.ValueQuantity#

Bases: dict

clear() → None. Remove all items from D.#

copy() → a shallow copy of D#

fromkeys(value=None, /)#: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items#

keys() → a set-like object providing a view on D's keys#

pop(k[, d]) → v, remove specified key and return the corresponding value.#: If key is not found, default is returned if given, otherwise KeyError is raised

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from dict/iterable E and F.#: If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values#

amount: str#

upperBound: str#

lowerBound: str#

unit: str#

class kgdata.wikidata.models.wdvalue.ValueTime#

Bases: dict

clear() → None. Remove all items from D.#

copy() → a shallow copy of D#

fromkeys(value=None, /)#: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items#

keys() → a set-like object providing a view on D's keys#

pop(k[, d]) → v, remove specified key and return the corresponding value.#: If key is not found, default is returned if given, otherwise KeyError is raised

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from dict/iterable E and F.#: If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values#

time: str#

timezone: int#

before: int#

after: int#

precision: int#

calendarmodel: str#

class kgdata.wikidata.models.wdvalue.ValueMonolingualText#

Bases: dict

clear() → None. Remove all items from D.#

copy() → a shallow copy of D#

fromkeys(value=None, /)#: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items#

keys() → a set-like object providing a view on D's keys#

pop(k[, d]) → v, remove specified key and return the corresponding value.#: If key is not found, default is returned if given, otherwise KeyError is raised

popitem()#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from dict/iterable E and F.#: If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values#

text: str#

language: str#

class kgdata.wikidata.models.wdvalue.WDValue(type: T, value: V)[source]#

Bases: Generic[T, V]

Parameters

type (T) –
value (V) –

type: T#

value: V#

static is_string(value: WDValue) → typing_extensions.TypeGuard[WDValue[Literal['string'], str]][source]#

Parameters: value (WDValue) –
Return type: typing_extensions.TypeGuard[WDValue[Literal[‘string’], str]]

static is_time(value: WDValue) → typing_extensions.TypeGuard[WDValue[Literal['time'], ValueTime]][source]#

Parameters: value (WDValue) –
Return type: typing_extensions.TypeGuard[WDValue[Literal[‘time’], ~kgdata.wikidata.models.wdvalue.ValueTime]]

static is_quantity(value: WDValue) → typing_extensions.TypeGuard[WDValue[Literal['quantity'], ValueQuantity]][source]#

Parameters: value (WDValue) –
Return type: typing_extensions.TypeGuard[WDValue[Literal[‘quantity’], ~kgdata.wikidata.models.wdvalue.ValueQuantity]]

static is_mono_lingual_text(value: WDValue) → typing_extensions.TypeGuard[WDValue[Literal['monolingualtext'], ValueMonolingualText]][source]#

Parameters: value (WDValue) –
Return type: typing_extensions.TypeGuard[WDValue[Literal[‘monolingualtext’], ~kgdata.wikidata.models.wdvalue.ValueMonolingualText]]

static is_globe_coordinate(value: WDValue) → typing_extensions.TypeGuard[WDValue[Literal['globecoordinate'], ValueGlobeCoordinate]][source]#

Parameters: value (WDValue) –
Return type: typing_extensions.TypeGuard[WDValue[Literal[‘globecoordinate’], ~kgdata.wikidata.models.wdvalue.ValueGlobeCoordinate]]

static is_entity_id(value: WDValue) → typing_extensions.TypeGuard[WDValue[Literal['wikibase-entityid'], ValueWikibaseEntityId]][source]#

Parameters: value (WDValue) –
Return type: typing_extensions.TypeGuard[WDValue[Literal[‘wikibase-entityid’], ~kgdata.wikidata.models.wdvalue.ValueWikibaseEntityId]]

static is_qnode(value: WDValue) → typing_extensions.TypeGuard[WDValue[Literal['wikibase-entityid'], ValueWikibaseEntityId]][source]#

Parameters: value (WDValue) –
Return type: typing_extensions.TypeGuard[WDValue[Literal[‘wikibase-entityid’], ~kgdata.wikidata.models.wdvalue.ValueWikibaseEntityId]]

static is_pnode(value: WDValue) → typing_extensions.TypeGuard[WDValue[Literal['wikibase-entityid'], ValueWikibaseEntityId]][source]#

Parameters: value (WDValue) –
Return type: typing_extensions.TypeGuard[WDValue[Literal[‘wikibase-entityid’], ~kgdata.wikidata.models.wdvalue.ValueWikibaseEntityId]]

as_string() → str[source]#

Parameters: self (WDValue[Literal['string'], str]) –
Return type: str

as_entity_id() → str[source]#

Parameters: self (WDValue[Literal['wikibase-entityid'], ~kgdata.wikidata.models.wdvalue.ValueWikibaseEntityId]) –
Return type: str

as_entity_id_safe() → str[source]#

Parameters: self (WDValue) –
Return type: str

as_qnode_id_safe() → str[source]#

Parameters: self (WDValue) –
Return type: str

as_pnode_id_safe() → str[source]#

Parameters: self (WDValue) –
Return type: str

to_dict()[source]#

to_string_repr() → str[source]#

Return type: str

kgdata.wikidata.models.wdvalue.type_check(val: Union[WDValue[Literal['string'], str], WDValue[Literal['wikibase-entityid'], ValueWikibaseEntityId], WDValue[Literal['time'], ValueTime], WDValue[Literal['quantity'], ValueQuantity], WDValue[Literal['monolingualtext'], ValueMonolingualText], WDValue[Literal['globecoordinate'], ValueGlobeCoordinate]])[source]#

The function is here to see if the type checker is able to flag error.

Uncomment to see the errors.

Tested with Pylance and mypy in 2022-05-15.

Parameters: val (Union[WDValue[Literal['string'], str], ~kgdata.wikidata.models.wdvalue.WDValue[~typing.Literal['wikibase-entityid'], ~kgdata.wikidata.models.wdvalue.ValueWikibaseEntityId], ~kgdata.wikidata.models.wdvalue.WDValue[~typing.Literal['time'], ~kgdata.wikidata.models.wdvalue.ValueTime], ~kgdata.wikidata.models.wdvalue.WDValue[~typing.Literal['quantity'], ~kgdata.wikidata.models.wdvalue.ValueQuantity], ~kgdata.wikidata.models.wdvalue.WDValue[~typing.Literal['monolingualtext'], ~kgdata.wikidata.models.wdvalue.ValueMonolingualText], ~kgdata.wikidata.models.wdvalue.WDValue[~typing.Literal['globecoordinate'], ~kgdata.wikidata.models.wdvalue.ValueGlobeCoordinate]]) –