kgdata.wikidata.models#

class WDClass(id: str, label: kgdata.wikidata.models.multilingual.MultiLingualString, description: kgdata.wikidata.models.multilingual.MultiLingualString, aliases: kgdata.wikidata.models.multilingual.MultiLingualStringList, parents: List[str], properties: List[str], different_froms: List[str], equivalent_classes: List[str], ancestors: Set[str])[source]#

Bases: object

Parameters:
id: str#
label: MultiLingualString#
description: MultiLingualString#
aliases: MultiLingualStringList#
parents: List[str]#
properties: List[str]#
different_froms: List[str]#
equivalent_classes: List[str]#
ancestors: Set[str]#
classmethod from_dict(obj)[source]#
to_dict()[source]#
static from_entity(ent: WDEntity)[source]#
Parameters:

ent (WDEntity) –

class WDProperty(id: str, label: kgdata.wikidata.models.multilingual.MultiLingualString, description: kgdata.wikidata.models.multilingual.MultiLingualString, aliases: kgdata.wikidata.models.multilingual.MultiLingualStringList, datatype: Literal['wikibase-lexeme', 'monolingualtext', 'wikibase-sense', 'url', 'wikibase-property', 'wikibase-form', 'external-id', 'time', 'commonsMedia', 'quantity', 'wikibase-item', 'musical-notation', 'tabular-data', 'string', 'math', 'geo-shape', 'globe-coordinate'], parents: List[str], related_properties: List[str], equivalent_properties: List[str], subjects: List[str], inverse_properties: List[str], instanceof: List[str], ancestors: Set[str])[source]#

Bases: object

Parameters:

  • id (str) –

  • label (MultiLingualString) –

  • description (MultiLingualString) –

  • aliases (MultiLingualStringList) –

  • datatype (Literal['wikibase-lexeme', 'monolingualtext', 'wikibase-sense', 'url', 'wikibase-property', 'wikibase-form', 'external-id', 'time', 'commonsMedia', 'quantity', 'wikibase-item', 'musical-notation', 'tabular-data', 'string', 'math', 'geo-shape', 'globe-coordinate']) –

  • parents (List[str]) –

  • related_properties (List[str]) –

  • equivalent_properties (List[str]) –

  • subjects (List[str]) –

  • inverse_properties (List[str]) –

  • instanceof (List[str]) –

  • ancestors (Set[str]) –

id: str#
label: MultiLingualString#
description: MultiLingualString#
aliases: MultiLingualStringList#
datatype: Literal['wikibase-lexeme', 'monolingualtext', 'wikibase-sense', 'url', 'wikibase-property', 'wikibase-form', 'external-id', 'time', 'commonsMedia', 'quantity', 'wikibase-item', 'musical-notation', 'tabular-data', 'string', 'math', 'geo-shape', 'globe-coordinate']#
parents: List[str]#
related_properties: List[str]#
equivalent_properties: List[str]#
subjects: List[str]#
inverse_properties: List[str]#
instanceof: List[str]#
ancestors: Set[str]#
static from_dict(o)[source]#
static from_entity(ent: WDEntity)[source]#
Parameters:

ent (WDEntity) –

to_dict()[source]#
is_object_property()[source]#
is_data_property()[source]#
is_transitive()[source]#
class WDQuantityPropertyStats(id: str, value: 'QuantityStats', qualifiers: Dict[str, ForwardRef('QuantityStats')])[source]#

Bases: object

Parameters:
id: str#
value: QuantityStats#
qualifiers: Dict[str, QuantityStats]#
static from_dir(indir: str = '/home/docs/checkouts/readthedocs.org/user_builds/kgdata/checkouts/data/wikidata/step_2/quantity_prop_stats/quantity_stats') → Dict[str, WDQuantityPropertyStats][source]#
Parameters:

indir (str) –

Return type:

Dict[str, WDQuantityPropertyStats]

class QuantityStats(units: List[str], min: float, max: float, mean: float, std: float, size: float, int_size: int, n_overi36: int)[source]#

Bases: object

Parameters:
units: List[str]#
min: float#
max: float#
mean: float#
std: float#
size: float#
int_size: int#
n_overi36: int#
class WDEntity(id: 'str', type: "Literal['item', 'property']", label: 'MultiLingualString', datatype: 'Optional[str]', description: 'MultiLingualString', aliases: 'MultiLingualStringList', props: 'Dict[str, List[WDStatement]]', sitelinks: 'Dict[str, SiteLink]')[source]#

Bases: object

Parameters:
id: str#
type: Literal['item', 'property']#
label: MultiLingualString#
datatype: Optional[str]#
description: MultiLingualString#
aliases: MultiLingualStringList#
props: Dict[str, List[WDStatement]]#
shallow_clone()[source]#
to_dict()[source]#
static from_dict(o)[source]#
to_tuple()[source]#
static from_tuple(t)[source]#
static from_wikidump(entity: dict, lang: str = 'en') → WDEntity[source]#

Extract essential information from qnode in the form that are easier to work with

Read more about ranks and truthy statements:
Parameters:

  • qnode (dict) – qnode

  • lang (str, optional) – language, default is ‘en’

  • entity (dict) –

Return type:

QNode

class 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_tuple()[source]#
to_string_repr() → str[source]#
Return type:

str

class 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 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 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 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 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 WDEntityLabel(id: str, label: str)[source]#

Bases: object

Parameters:

  • id (str) –

  • label (str) –

id: str#
label: str#
static from_dict(o: dict)[source]#
Parameters:

o (dict) –

to_dict()[source]#
static from_wdentity_raw(o: dict)[source]#

Extract wdentity label from wdentity raw dictionary (which is passed to .from_dict to deserialize wdentity object)

Parameters:

o (dict) –

class WDEntityMetadata(id: 'str', label: 'MultiLingualString', description: 'MultiLingualString', aliases: 'MultiLingualStringList', instanceof: 'List[str]', subclassof: 'List[str]', subpropertyof: 'List[str]')[source]#

Bases: object

Parameters:
id: str#
label: MultiLingualString#
description: MultiLingualString#
aliases: MultiLingualStringList#
instanceof: List[str]#
subclassof: List[str]#
subpropertyof: List[str]#
to_tuple()[source]#
static from_tuple(t)[source]#

Modules

kgdata.wikidata.models.multilingual

kgdata.wikidata.models.propertystats

kgdata.wikidata.models.wdclass

kgdata.wikidata.models.wdentity

kgdata.wikidata.models.wdentitylabel

kgdata.wikidata.models.wdentitylink

kgdata.wikidata.models.wdentitymetadata

kgdata.wikidata.models.wdproperty

kgdata.wikidata.models.wdstatement

kgdata.wikidata.models.wdvalue