Item

class Item(*args: Any, **kwargs: Any)[source]

Bases: Entity

Person or thing.

Parameters:

iri – IRI.

datatype_class

alias of ItemDatatype

datatype: ClassVar[ItemDatatype] = ItemDatatype()

Datatype associated with this value class.

template_class

alias of ItemTemplate

variable_class

alias of ItemVariable

class Descriptor[source]

Bases: TypedDict

Item descriptor in KIF context.

labels: Mapping[str, Text]

Label indexed by language.

aliases: Mapping[str, Set[Text]]

Aliases indexed by language.

descriptions: Mapping[str, Text]

Description indexed by language.

__init__(iri: VTItemContent) → None[source]
display(language: TTextLanguage | None = None) → str[source]

Gets the display-name of entity in KIF context.

Parameters:

language – Language.

Returns:

Display name.

describe(language: TTextLanguage | None = None, resolve: bool | None = None, resolver: Store | None = None, force: bool | None = None) → Item.Descriptor | None[source]

Gets the descriptor of item in KIF context.

If language is given, resolves only text in language. Otherwise, resolves text in all languages.

If resolve is True, resolves item data.

If resolver is given, uses it to resolve item data. Otherwise, uses the resolver registered in context (if any).

If force is given, forces resolution.

Parameters:

  • language – Language.

  • resolve – Whether to resolve descriptor.

  • resolver – Resolver store.

  • force – Whether to force resolution.

Returns:

Item descriptor or None.

property label: Text | None

The label of item in KIF context.

get_label(language: TTextLanguage | None = None, resolve: bool | None = None, resolver: Store | None = None, force: bool | None = None) → Text | None[source]

Gets the label of item in KIF context.

Parameters:

  • language – Language.

  • resolve – Whether to resolve label.

  • resolver – Resolver store.

  • force – Whether to force resolution.

Returns:

Label or None.

property aliases: Set[Text] | None

The aliases of item in KIF context.

get_aliases(language: TTextLanguage | None = None, resolve: bool | None = None, resolver: Store | None = None, force: bool | None = None) → Set[Text] | None[source]

Gets the aliases of item in KIF context.

Parameters:

  • language – Language.

  • resolve – Whether to resolve aliases.

  • resolver – Resolver store.

  • force – Whether to force resolution.

Returns:

Aliases or None.

property description: Text | None

The description of item in KIF context.

get_description(language: TTextLanguage | None = None, resolve: bool | None = None, resolver: Store | None = None, force: bool | None = None) → Text | None[source]

Gets the description of item in KIF context.

Parameters:

  • language – Language.

  • resolve – Whether to resolve description.

  • resolver – Resolver store.

  • force – Whether to force resolution.

Returns:

Description or None.

register(label: TText | None = None, labels: TTextSet | None = None, alias: TText | None = None, aliases: TTextSet | None = None, description: TText | None = None, descriptions: TTextSet | None = None) → Self[source]

Adds or updates item data in KIF context.

Parameters:

  • label – Label.

  • labels – Labels.

  • alias – Alias.

  • aliases – Aliases.

  • description – Description.

  • descriptions – Descriptions.

Returns:

Item.

unregister(label: TText | None = None, labels: TTextSet | None = None, alias: TText | None = None, aliases: TTextSet | None = None, description: TText | None = None, descriptions: TTextSet | None = None, label_language: TTextLanguage | None = None, alias_language: TTextLanguage | None = None, description_language: TTextLanguage | None = None, all_labels: bool = False, all_aliases: bool = False, all_descriptions: bool = False) → bool[source]

Removes item data from KIF context.

If called with no arguments, removes all item data.

Parameters:

  • label – Label.

  • labels – Labels.

  • alias – Alias.

  • aliases – Aliases.

  • description – Description.

  • descriptions – Descriptions.

  • label_language – Language.

  • alias_language – Language.

  • description_language – Language.

  • all_labels – Whether to remove all labels.

  • all_aliases – Whether to remove all aliases.

  • all_descriptions – Whether to remove all descriptions.

Returns:

True if successful; False otherwise.

class ItemTemplate(*args: Any, **kwargs: Any)[source]

Bases: EntityTemplate

Item template.

Parameters:

iri – IRI, IRI template, or IRI variable.

object_class

alias of Item

__init__(iri: VTItemContent)[source]
class ItemVariable(name: str | None = None, variable_class: type[Variable] | type[Term] | None = None)[source]

Bases: EntityVariable

Item variable.

Parameters:

name – Name.

object_class

alias of Item

class ItemDatatype(datatype_class: TDatatype | None = None)[source]

Bases: Datatype

Item datatype.

instance: ClassVar[ItemDatatype] = ItemDatatype()

Singleton instance of this datatype class.

value_class

alias of Item