Item

Item

Bases: Entity

Person or thing.

Parameters:

• iri (VTItemContent) –

  IRI.

Descriptor

Bases: TypedDict

Item descriptor in KIF context.

aliases()

The aliases of item in KIF context.

describe(language=None, resolve=None, resolver=None, force=None, context=None)

Describes 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 (TTextLanguage | None, default: None ) –

  Language.

• resolve (bool | None, default: None ) –

  Whether to resolve descriptor.

• resolver (Store | None, default: None ) –

  Resolver store.

• force (bool | None, default: None ) –

  Whether to force resolution.

• context (Context | None, default: None ) –

  Context.

Returns:

• Descriptor | None –

  Item descriptor or None.

describe_using_repr(language=None, resolve=None, resolver=None, force=None, context=None)

Describes item in KIF context using repr. format.

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 (TTextLanguage | None, default: None ) –

  Language.

• resolve (bool | None, default: None ) –

  Whether to resolve descriptor.

• resolver (Store | None, default: None ) –

  Resolver store.

• force (bool | None, default: None ) –

  Whether to force resolution.

• context (Context | None, default: None ) –

  Context.

Returns:

• str –

  Repr. string.

describe_using_statements(language=None, resolve=None, resolver=None, force=None, context=None)

Describes item in KIF context using statements.

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 (TTextLanguage | None, default: None ) –

  Language.

• resolve (bool | None, default: None ) –

  Whether to resolve descriptor.

• resolver (Store | None, default: None ) –

  Resolver store.

• force (bool | None, default: None ) –

  Whether to force resolution.

• context (Context | None, default: None ) –

  Context.

Returns:

• Iterator[Statement] –

  Statement iterator.

description()

The description of item in KIF context.

descriptor_to_snaks(descriptor) classmethod

Converts item descriptor to (value) snaks.

Parameters:

• descriptor (Descriptor) –

  Item descriptor.

Returns:

• Iterator[ValueSnak] –

  (Value) snaks.

get_aliases(language=None, resolve=None, resolver=None, force=None, context=None)

Gets the aliases of item in KIF context.

Parameters:

• language (TTextLanguage | None, default: None ) –

  Language.

• resolve (bool | None, default: None ) –

  Whether to resolve aliases.

• resolver (Store | None, default: None ) –

  Resolver store.

• force (bool | None, default: None ) –

  Whether to force resolution.

• context (Context | None, default: None ) –

  Context.

Returns:

• Set[Text] | None –

  Aliases or None.

get_description(language=None, resolve=None, resolver=None, force=None, context=None)

Gets the description of item in KIF context.

Parameters:

• language (TTextLanguage | None, default: None ) –

  Language.

• resolve (bool | None, default: None ) –

  Whether to resolve description.

• resolver (Store | None, default: None ) –

  Resolver store.

• force (bool | None, default: None ) –

  Whether to force resolution.

• context (Context | None, default: None ) –

  Context.

Returns:

• Text | None –

  Description or None.

get_label(language=None, resolve=None, resolver=None, force=None, context=None)

Gets the label of item in KIF context.

Parameters:

• language (TTextLanguage | None, default: None ) –

  Language.

• resolve (bool | None, default: None ) –

  Whether to resolve label.

• resolver (Store | None, default: None ) –

  Resolver store.

• force (bool | None, default: None ) –

  Whether to force resolution.

• context (Context | None, default: None ) –

  Context.

Returns:

• Text | None –

  Label or None.

label()

The label of item in KIF context.

register(label=None, labels=None, alias=None, aliases=None, description=None, descriptions=None, context=None)

Adds or updates item data in KIF context.

Parameters:

• label (TText | None, default: None ) –

  Label.

• labels (TTextSet | None, default: None ) –

  Labels.

• alias (TText | None, default: None ) –

  Alias.

• aliases (TTextSet | None, default: None ) –

  Aliases.

• description (TText | None, default: None ) –

  Description.

• descriptions (TTextSet | None, default: None ) –

  Descriptions.

• context (Context | None, default: None ) –

  Context.

Returns:

• Self –

  Item.

unregister(label=None, labels=None, alias=None, aliases=None, description=None, descriptions=None, label_language=None, alias_language=None, description_language=None, all_labels=False, all_aliases=False, all_descriptions=False, context=None)

Removes item data from KIF context.

If called with no arguments, removes all item data.

Parameters:

• label (TText | None, default: None ) –

  Label.

• labels (TTextSet | None, default: None ) –

  Labels.

• alias (TText | None, default: None ) –

  Alias.

• aliases (TTextSet | None, default: None ) –

  Aliases.

• description (TText | None, default: None ) –

  Description.

• descriptions (TTextSet | None, default: None ) –

  Descriptions.

• label_language (TTextLanguage | None, default: None ) –

  Language.

• alias_language (TTextLanguage | None, default: None ) –

  Language.

• description_language (TTextLanguage | None, default: None ) –

  Language.

• all_labels (bool, default: False ) –

  Whether to remove all labels.

• all_aliases (bool, default: False ) –

  Whether to remove all aliases.

• all_descriptions (bool, default: False ) –

  Whether to remove all descriptions.

• context (Context | None, default: None ) –

  Context.

Returns:

• bool –

  True if successful; False otherwise.

Items(iri, *iris)

Constructs one or more items.

Parameters:

• iri (VTItemContent) –

  IRI.

• iris (VTItemContent, default: () ) –

  IRIs.

Returns:

• Iterator[Item] –

  The resulting items.