Property

Property

Bases: Entity[Union[Datatype, None]]

Binary relationship.

Parameters:

• iri (VTPropertyContent) –

  IRI.

• range (VTDatatype | None, default: None ) –

  Datatype.

aliases property

The aliases of property in KIF context.

description property

The description of property in KIF context.

inverse property

The inverse of property in KIF context.

label property

The label of property in KIF context.

range property

The range of property.

registered_range property

The range of property in KIF context.

schema property

The resolved schema of property in KIF context.

Descriptor

Bases: TypedDict

Property descriptor.

Schema

Bases: TypedDict

Property schema.

__rtruediv__(path)

Constructs a sequence path from property.

Parameters:

• path (TPath) –

  Path.

Returns:

• SequencePath –

  Sequence path.

__truediv__(path)

Constructs a sequence path from property.

Parameters:

• path (TPath | Literal[1]) –

  Path.

Returns:

• Path –

  Sequence path.

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

Describes property in KIF context.

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

If resolve is True, resolves property data.

If resolver is given, uses it to resolve property 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 –

  Property descriptor or None.

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

Describes property 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 property data.

If resolver is given, uses it to resolve property 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 property 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 property data.

If resolver is given, uses it to resolve property 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.

descriptor_to_snaks(descriptor) classmethod

Converts property descriptor to (value) snaks.

Parameters:

• descriptor (Descriptor) –

  Property descriptor.

Returns:

• Iterator[ValueSnak] –

  (Value) snaks.

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

Gets the aliases of property 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 property 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_inverse(resolve=None, resolver=None, force=None, context=None)

Gets the inverse of property in KIF context.

Parameters:

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

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

  Context.

Returns:

• Property | None –

  Property or None.

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

Gets the label of property 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.

get_range(default=None)

Gets the range of property.

If range is None, returns default.

Parameters:

• default (Datatype | None, default: None ) –

  Default range.

Returns:

• Datatype | None –

  Datatype.

get_registered_range(resolve=None, resolver=None, force=None, context=None)

Gets the range of property in KIF context.

Parameters:

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

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

  Context.

Returns:

• Datatype | None –

  Range or None.

get_schema(default=None, resolve=True, context=None)

Gets the schema of property in KIF context.

If property has no associated schema, assumes default.

If resolve is True, returns a resolved schema, i.e., one in which namespaces are resolved into absolute IRIs by concatenating the namespace IRI with the name part of property IRI.

Parameters:

• default (Schema | None, default: None ) –

  Default schema.

• resolve (bool, default: True ) –

  Whether to resolve the returned schema.

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

  Context.

Returns:

• Schema | None –

  Property schema or None.

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

Adds or updates property 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.

• range (TDatatype | None, default: None ) –

  Range.

• inverse (TProperty | None, default: None ) –

  Inverse property.

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

  Context.

Returns:

• Self –

  Property.

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, range=False, inverse=False, context=None)

Removes property data from KIF context.

If called with no arguments, removes all property 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.

• range (bool, default: False ) –

  Whether to remove range.

• inverse (bool, default: False ) –

  Whether to remove inverse.

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

  Context.

Returns:

• bool –

  True if successful; False otherwise.

Properties(iri, *iris)

Constructs one or more properties.

Parameters:

• iri (VTPropertyContent) –

  IRI.

• iris (VTPropertyContent, default: () ) –

  IRIs.

Returns:

• Iterator[Property] –

  The resulting properties.