Context

Context

KIF context.

entities property

The entity registry.

iris property

The IRI registry.

options property

The options of context.

get_aliases(entity, language=None, resolve=None, resolver=None, force=None, function=None)

Gets the aliases of item or property in registry.

Parameters:

• entity (Item | Property) –

  Item or property.

• 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.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• Set[Text] | None –

  Aliases or None.

get_category(lexeme, resolve=None, resolver=None, force=None, function=None)

Gets the lexical category of lexeme in registry.

Parameters:

• lexeme (Lexeme) –

  Lexeme.

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

  Whether to resolve lexical category.

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

  Resolver store.

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

  Whether to force resolution.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• Item | None –

  Item or None.

get_description(entity, language=None, resolve=None, resolver=None, force=None, function=None)

Gets the description of item or property in registry.

Parameters:

• entity (Item | Property) –

  Item or property.

• 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.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• Text | None –

  Description or None.

get_entities()

Gets the entity registry.

Returns:

• EntityRegistry –

  Entity registry.

get_inverse(property, resolve=None, resolver=None, force=None, function=None)

Gets the inverse of property in registry.

Parameters:

• property (Property) –

  Property.

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

  Whether to resolve inverse.

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

  Resolver store.

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

  Whether to force resolution.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• Property | None –

  Property or None.

get_iris()

Gets the IRI registry.

Returns:

• IRI_Registry –

  IRI registry.

get_label(entity, language=None, resolve=None, resolver=None, force=None, function=None)

Gets the label of item or property in registry.

Parameters:

• entity (Item | Property) –

  Item or property.

• 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.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• Text | None –

  Label or None.

get_language(lexeme, resolve=None, resolver=None, force=None, function=None)

Gets the language of lexeme in registry.

Parameters:

• lexeme (Lexeme) –

  Lexeme.

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

  Whether to resolve language.

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

  Resolver store.

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

  Whether to force resolution.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• Item | None –

  Item or None.

get_lemma(lexeme, resolve=None, resolver=None, force=None, function=None)

Gets the lemma of lexeme in registry.

Parameters:

• lexeme (Lexeme) –

  Lexeme.

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

  Whether to resolve lemma.

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

  Resolver store.

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

  Whether to force resolution.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• Text | None –

  Text or None.

get_option_by_name(name)

Gets option by name.

Parameters:

• name (str | Sequence[str]) –

  Option name.

Returns:

• Any –

  The option value.

Raises:

• `KeyError` –

  No such option.

get_option_description_by_name(name)

Gets option description by name.

Parameters:

• name (str | Sequence[str]) –

  Option name.

Returns:

• Any –

  The option description.

Raises:

• `KeyError` –

  No such option.

get_options()

Gets the options of context.

Returns:

• Options –

  Options.

get_prefix(iri, function=None)

Gets the prefix of IRI in registry.

Parameters:

• iri (T_IRI) –

  IRI.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• str | None –

  Prefix or None.

get_range(property, resolve=None, resolver=None, force=None, function=None)

Gets the range of property in registry.

Parameters:

• property (Property) –

  Property.

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

  Whether to resolve range.

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

  Resolver store.

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

  Whether to force resolution.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• Datatype | None –

  Range or None.

get_resolver(iri, function=None)

Gets the entity resolver of IRI or entity in registry.

Parameters:

• iri (T_IRI | Entity) –

  IRI.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• Store | None –

  Store or None.

get_schema(iri, function=None)

Gets the property schema of IRI or property in registry.

Parameters:

• iri (T_IRI | Property) –

  IRI.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• Schema | None –

  Property schema or None.

resolve(objects, resolver=None, batch_size=None, label=False, aliases=False, description=False, language=None, range=False, inverse=False, lemma=False, category=False, lexeme_language=False, all=False, force=None, function=None)

Resolves entity data.

Traverses objects recursively and resolves the data of every entity found into context's entity registry.

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

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

If force is given, forces resolution.

Parameters:

• objects (Iterable[T]) –

  Objects.

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

  Resolver store.

• batch_size (int | None, default: None ) –

  Batch size for resolver calls.

• label (bool, default: False ) –

  Whether to resolve labels.

• aliases (bool, default: False ) –

  Whether to resolve aliases.

• description (bool, default: False ) –

  Whether to resolve descriptions.

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

  Language.

• range (bool, default: False ) –

  Whether to resolve ranges.

• inverse (bool, default: False ) –

  Whether to resolve inverses.

• lemma (bool, default: False ) –

  Whether to resolve lemmas.

• category (bool, default: False ) –

  Whether to resolve lexical categories.

• lexeme_language (bool, default: False ) –

  Whether to resolve lexeme languages.

• all (bool, default: False ) –

  Whether to resolve all data.

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

  Whether to force resolve.

• batch_size (int | None, default: None ) –

  Batch size.

• function (Location | None, default: None ) –

  Function or function name.

Returns:

• Iterable[T] –

  objects.

top(context=None) classmethod

Gets the current context.

If context is not None, returns context.

Returns:

• Context –

  Context.