Property

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

Bases: Entity

Binary relationship.

Parameters:

  • iri – IRI.

  • range – Datatype.

datatype_class

alias of PropertyDatatype

datatype: ClassVar[PropertyDatatype] = PropertyDatatype()

Datatype associated with this value class.

template_class

alias of PropertyTemplate

variable_class

alias of PropertyVariable

class Descriptor[source]

Bases: TypedDict

Property descriptor.

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.

range: Datatype

Range datatype.

inverse: Property

Inverse property.

__init__(iri: VTPropertyContent, range: VTDatatype | None = None) → None[source]
property range: Datatype | None

The range of property.

get_range(default: Datatype | None = None) → Datatype | None[source]

Gets the range of property.

If range is None, returns default.

Parameters:

default – Default range.

Returns:

Datatype.

display(language: TString | 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) → Property.Descriptor | None[source]

Gets the descriptor of 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 – Language.

  • resolve – Whether to resolve descriptor.

  • resolver – Resolver store.

  • force – Whether to force resolution.

Returns:

Property descriptor or None.

property label: Text | None

The label of property 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 property 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 property 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 property 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 property 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 property in KIF context.

Parameters:

  • language – Language.

  • resolve – Whether to resolve description.

  • resolver – Resolver store.

  • force – Whether to force resolution.

Returns:

Description or None.

property registered_range: Datatype | None

The range of property in KIF context.

get_registered_range(resolve: bool | None = None, resolver: Store | None = None, force: bool | None = None) → Datatype | None[source]

Gets the range of property in KIF context.

Parameters:

  • resolve – Whether to resolve range.

  • resolver – Resolver store.

  • force – Whether to force resolution.

Returns:

Range or None.

property inverse: Property | None

The inverse of property in KIF context.

get_inverse(resolve: bool | None = None, resolver: Store | None = None, force: bool | None = None) → Property | None[source]

Gets the inverse of property in KIF context.

Parameters:

  • resolve – Whether to resolve inverse.

  • resolver – Resolver store.

  • force – Whether to force resolution.

Returns:

Property 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, range: TDatatype | None = None, inverse: TProperty | None = None) → Self[source]

Adds or updates property data in KIF context.

Parameters:

  • label – Label.

  • labels – Labels.

  • alias – Alias.

  • aliases – Aliases.

  • description – Description.

  • descriptions – Descriptions.

  • range – Range.

  • inverse – Inverse property.

Returns:

Property.

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, range: bool = False, inverse: bool = False) → bool[source]

Removes property data from KIF context.

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

  • range – Whether to remove range.

  • inverse – Whether to remove inverse.

Returns:

True if successful; False otherwise.

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

Bases: EntityTemplate

Property template.

Parameters:

  • iri – IRI, IRI template, or IRI variable.

  • range – Datatype or datatype variable.

object_class

alias of Property

__init__(iri: VT_IRI, range: VTDatatype | None = None) → None[source]
property range: DatatypeVariable | Datatype | None

The range of property template.

get_range(default: DatatypeVariable | Datatype | None = None) → DatatypeVariable | Datatype | None[source]

Gets the range of property template.

If range is None, returns default.

Parameters:

default – Default range.

Returns:

Datatype or datatype variable.

class PropertyVariable(name: str | None = None, variable_class: type[Variable] | type[Term] | None = None)[source]

Bases: EntityVariable

Property variable.

Parameters:

name – Name.

object_class

alias of Property

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

Bases: Datatype

Property datatype.

instance: ClassVar[PropertyDatatype] = PropertyDatatype()

Singleton instance of this datatype class.

value_class

alias of Property