# {py:mod}`pyirk.core`

```{py:module} pyirk.core
```

```{autodoc2-docstring} pyirk.core
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Entity <pyirk.core.Entity>`
  - ```{autodoc2-docstring} pyirk.core.Entity
    :summary:
    ```
* - {py:obj}`PrefixShortCut <pyirk.core.PrefixShortCut>`
  - ```{autodoc2-docstring} pyirk.core.PrefixShortCut
    :summary:
    ```
* - {py:obj}`DataStore <pyirk.core.DataStore>`
  - ```{autodoc2-docstring} pyirk.core.DataStore
    :summary:
    ```
* - {py:obj}`Item <pyirk.core.Item>`
  -
* - {py:obj}`KWArgManager <pyirk.core.KWArgManager>`
  - ```{autodoc2-docstring} pyirk.core.KWArgManager
    :summary:
    ```
* - {py:obj}`SingleKWArgProcessor <pyirk.core.SingleKWArgProcessor>`
  - ```{autodoc2-docstring} pyirk.core.SingleKWArgProcessor
    :summary:
    ```
* - {py:obj}`Relation <pyirk.core.Relation>`
  -
* - {py:obj}`RelationRole <pyirk.core.RelationRole>`
  - ```{autodoc2-docstring} pyirk.core.RelationRole
    :summary:
    ```
* - {py:obj}`RawQualifier <pyirk.core.RawQualifier>`
  - ```{autodoc2-docstring} pyirk.core.RawQualifier
    :summary:
    ```
* - {py:obj}`QualifierFactory <pyirk.core.QualifierFactory>`
  - ```{autodoc2-docstring} pyirk.core.QualifierFactory
    :summary:
    ```
* - {py:obj}`Statement <pyirk.core.Statement>`
  - ```{autodoc2-docstring} pyirk.core.Statement
    :summary:
    ```
* - {py:obj}`QualifierStatement <pyirk.core.QualifierStatement>`
  -
* - {py:obj}`RuleResult <pyirk.core.RuleResult>`
  - ```{autodoc2-docstring} pyirk.core.RuleResult
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`check_type <pyirk.core.check_type>`
  - ```{autodoc2-docstring} pyirk.core.check_type
    :summary:
    ```
* - {py:obj}`wrap_function_with_search_uri_context <pyirk.core.wrap_function_with_search_uri_context>`
  - ```{autodoc2-docstring} pyirk.core.wrap_function_with_search_uri_context
    :summary:
    ```
* - {py:obj}`get_label_to_item_dict <pyirk.core.get_label_to_item_dict>`
  - ```{autodoc2-docstring} pyirk.core.get_label_to_item_dict
    :summary:
    ```
* - {py:obj}`get_label_to_relation_dict <pyirk.core.get_label_to_relation_dict>`
  - ```{autodoc2-docstring} pyirk.core.get_label_to_relation_dict
    :summary:
    ```
* - {py:obj}`process_kwargs_for_entity_creation <pyirk.core.process_kwargs_for_entity_creation>`
  - ```{autodoc2-docstring} pyirk.core.process_kwargs_for_entity_creation
    :summary:
    ```
* - {py:obj}`process_lang_related_kwargs_for_entity_creation <pyirk.core.process_lang_related_kwargs_for_entity_creation>`
  - ```{autodoc2-docstring} pyirk.core.process_lang_related_kwargs_for_entity_creation
    :summary:
    ```
* - {py:obj}`create_item <pyirk.core.create_item>`
  - ```{autodoc2-docstring} pyirk.core.create_item
    :summary:
    ```
* - {py:obj}`run_hooks <pyirk.core.run_hooks>`
  - ```{autodoc2-docstring} pyirk.core.run_hooks
    :summary:
    ```
* - {py:obj}`register_hook <pyirk.core.register_hook>`
  - ```{autodoc2-docstring} pyirk.core.register_hook
    :summary:
    ```
* - {py:obj}`repl_spc_by_udsc <pyirk.core.repl_spc_by_udsc>`
  - ```{autodoc2-docstring} pyirk.core.repl_spc_by_udsc
    :summary:
    ```
* - {py:obj}`tolerant_removal <pyirk.core.tolerant_removal>`
  - ```{autodoc2-docstring} pyirk.core.tolerant_removal
    :summary:
    ```
* - {py:obj}`create_relation <pyirk.core.create_relation>`
  - ```{autodoc2-docstring} pyirk.core.create_relation
    :summary:
    ```
* - {py:obj}`create_builtin_item <pyirk.core.create_builtin_item>`
  - ```{autodoc2-docstring} pyirk.core.create_builtin_item
    :summary:
    ```
* - {py:obj}`create_builtin_relation <pyirk.core.create_builtin_relation>`
  - ```{autodoc2-docstring} pyirk.core.create_builtin_relation
    :summary:
    ```
* - {py:obj}`replace_and_unlink_entity <pyirk.core.replace_and_unlink_entity>`
  - ```{autodoc2-docstring} pyirk.core.replace_and_unlink_entity
    :summary:
    ```
* - {py:obj}`is_true <pyirk.core.is_true>`
  - ```{autodoc2-docstring} pyirk.core.is_true
    :summary:
    ```
* - {py:obj}`format_entity_html <pyirk.core.format_entity_html>`
  - ```{autodoc2-docstring} pyirk.core.format_entity_html
    :summary:
    ```
* - {py:obj}`is_subclass <pyirk.core.is_subclass>`
  - ```{autodoc2-docstring} pyirk.core.is_subclass
    :summary:
    ```
* - {py:obj}`is_instance <pyirk.core.is_instance>`
  - ```{autodoc2-docstring} pyirk.core.is_instance
    :summary:
    ```
* - {py:obj}`is_subproperty <pyirk.core.is_subproperty>`
  - ```{autodoc2-docstring} pyirk.core.is_subproperty
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`allowed_literal_types <pyirk.core.allowed_literal_types>`
  - ```{autodoc2-docstring} pyirk.core.allowed_literal_types
    :summary:
    ```
* - {py:obj}`RELKEYS_WITH_LITERAL_RANGE <pyirk.core.RELKEYS_WITH_LITERAL_RANGE>`
  - ```{autodoc2-docstring} pyirk.core.RELKEYS_WITH_LITERAL_RANGE
    :summary:
    ```
* - {py:obj}`pf <pyirk.core.pf>`
  - ```{autodoc2-docstring} pyirk.core.pf
    :summary:
    ```
* - {py:obj}`ds <pyirk.core.ds>`
  - ```{autodoc2-docstring} pyirk.core.ds
    :summary:
    ```
* - {py:obj}`YAML_VALUE <pyirk.core.YAML_VALUE>`
  - ```{autodoc2-docstring} pyirk.core.YAML_VALUE
    :summary:
    ```
* - {py:obj}`re_prefix_shortkey_suffix <pyirk.core.re_prefix_shortkey_suffix>`
  - ```{autodoc2-docstring} pyirk.core.re_prefix_shortkey_suffix
    :summary:
    ```
* - {py:obj}`re_suffix_underscore <pyirk.core.re_suffix_underscore>`
  - ```{autodoc2-docstring} pyirk.core.re_suffix_underscore
    :summary:
    ```
* - {py:obj}`re_suffix_square_brackets <pyirk.core.re_suffix_square_brackets>`
  - ```{autodoc2-docstring} pyirk.core.re_suffix_square_brackets
    :summary:
    ```
* - {py:obj}`langcode_end_pattern <pyirk.core.langcode_end_pattern>`
  - ```{autodoc2-docstring} pyirk.core.langcode_end_pattern
    :summary:
    ```
* - {py:obj}`VALID_HOOK_PHASES <pyirk.core.VALID_HOOK_PHASES>`
  - ```{autodoc2-docstring} pyirk.core.VALID_HOOK_PHASES
    :summary:
    ```
* - {py:obj}`VALID_HOOK_TYPES <pyirk.core.VALID_HOOK_TYPES>`
  - ```{autodoc2-docstring} pyirk.core.VALID_HOOK_TYPES
    :summary:
    ```
* - {py:obj}`_uri_stack <pyirk.core._uri_stack>`
  - ```{autodoc2-docstring} pyirk.core._uri_stack
    :summary:
    ```
* - {py:obj}`_search_uri_stack <pyirk.core._search_uri_stack>`
  - ```{autodoc2-docstring} pyirk.core._search_uri_stack
    :summary:
    ```
* - {py:obj}`_attr_name_cache <pyirk.core._attr_name_cache>`
  - ```{autodoc2-docstring} pyirk.core._attr_name_cache
    :summary:
    ```
* - {py:obj}`df <pyirk.core.df>`
  - ```{autodoc2-docstring} pyirk.core.df
    :summary:
    ```
* - {py:obj}`en <pyirk.core.en>`
  - ```{autodoc2-docstring} pyirk.core.en
    :summary:
    ```
* - {py:obj}`de <pyirk.core.de>`
  - ```{autodoc2-docstring} pyirk.core.de
    :summary:
    ```
* - {py:obj}`fr <pyirk.core.fr>`
  - ```{autodoc2-docstring} pyirk.core.fr
    :summary:
    ```
* - {py:obj}`it <pyirk.core.it>`
  - ```{autodoc2-docstring} pyirk.core.it
    :summary:
    ```
* - {py:obj}`es <pyirk.core.es>`
  - ```{autodoc2-docstring} pyirk.core.es
    :summary:
    ```
````

### API

````{py:data} allowed_literal_types
:canonical: pyirk.core.allowed_literal_types
:value: >
   ()

```{autodoc2-docstring} pyirk.core.allowed_literal_types
```

````

````{py:data} RELKEYS_WITH_LITERAL_RANGE
:canonical: pyirk.core.RELKEYS_WITH_LITERAL_RANGE
:value: >
   ('R1', 'R2', 'R77')

```{autodoc2-docstring} pyirk.core.RELKEYS_WITH_LITERAL_RANGE
```

````

````{py:function} check_type(obj, expected_type, strict=True)
:canonical: pyirk.core.check_type

```{autodoc2-docstring} pyirk.core.check_type
```
````

`````{py:class} Entity(base_uri)
:canonical: pyirk.core.Entity

Bases: {py:obj}`abc.ABC`

```{autodoc2-docstring} pyirk.core.Entity
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.core.Entity.__init__
```

````{py:attribute} short_key
:canonical: pyirk.core.Entity.short_key
:type: str
:value: >
   None

```{autodoc2-docstring} pyirk.core.Entity.short_key
```

````

````{py:method} __call__(*args, **kwargs)
:canonical: pyirk.core.Entity.__call__

```{autodoc2-docstring} pyirk.core.Entity.__call__
```

````

````{py:property} name_labeled_key
:canonical: pyirk.core.Entity.name_labeled_key

```{autodoc2-docstring} pyirk.core.Entity.name_labeled_key
```

````

````{py:method} idoc(adhoc_label: str)
:canonical: pyirk.core.Entity.idoc

```{autodoc2-docstring} pyirk.core.Entity.idoc
```

````

````{py:method} __getitem__(adhoc_label)
:canonical: pyirk.core.Entity.__getitem__

```{autodoc2-docstring} pyirk.core.Entity.__getitem__
```

````

````{py:method} __getattr__(attr_name)
:canonical: pyirk.core.Entity.__getattr__

```{autodoc2-docstring} pyirk.core.Entity.__getattr__
```

````

````{py:method} __setattr__(attr_name: str, attr_value: typing.Any)
:canonical: pyirk.core.Entity.__setattr__

````

````{py:method} __process_attribute_name(attr_name: str, exception_type=AttributeError) -> pyirk._core.keymanager.ProcessedStmtKey
:canonical: pyirk.core.Entity.__process_attribute_name

```{autodoc2-docstring} pyirk.core.Entity.__process_attribute_name
```

````

````{py:method} __eq__(other)
:canonical: pyirk.core.Entity.__eq__

````

````{py:method} __post_init__()
:canonical: pyirk.core.Entity.__post_init__

```{autodoc2-docstring} pyirk.core.Entity.__post_init__
```

````

````{py:method} _perform_inheritance()
:canonical: pyirk.core.Entity._perform_inheritance

```{autodoc2-docstring} pyirk.core.Entity._perform_inheritance
```

````

````{py:method} _perform_instantiation()
:canonical: pyirk.core.Entity._perform_instantiation

```{autodoc2-docstring} pyirk.core.Entity._perform_instantiation
```

````

````{py:method} _get_relation_contents(rel_uri: str, lang_indicator=None)
:canonical: pyirk.core.Entity._get_relation_contents

```{autodoc2-docstring} pyirk.core.Entity._get_relation_contents
```

````

````{py:method} add_method_to_class(func)
:canonical: pyirk.core.Entity.add_method_to_class
:classmethod:

```{autodoc2-docstring} pyirk.core.Entity.add_method_to_class
```

````

````{py:method} add_method(func: callable, name: pyirk._core.keymanager.Optional[str] = None)
:canonical: pyirk.core.Entity.add_method

```{autodoc2-docstring} pyirk.core.Entity.add_method
```

````

````{py:method} _set_relations_from_init_kwargs(**kwargs)
:canonical: pyirk.core.Entity._set_relations_from_init_kwargs

```{autodoc2-docstring} pyirk.core.Entity._set_relations_from_init_kwargs
```

````

````{py:method} set_multiple_relations(relation: pyirk._core.serialization.Union[pyirk.core.Relation, str], obj_seq: pyirk._core.serialization.Union[tuple, list], *args, **kwargs) -> pyirk._core.mod_management.List[pyirk.core.Statement]
:canonical: pyirk.core.Entity.set_multiple_relations

```{autodoc2-docstring} pyirk.core.Entity.set_multiple_relations
```

````

````{py:method} set_relation(relation: pyirk._core.serialization.Union[pyirk.core.Relation, str], obj, scope: pyirk.core.Entity = None, proxyitem: pyirk._core.keymanager.Optional[pyirk.core.Item] = None, qualifiers: pyirk._core.keymanager.Optional[pyirk._core.mod_management.List[pyirk.core.RawQualifier]] = None, prevent_duplicate=False) -> pyirk._core.keymanager.Optional[pyirk.core.Statement]
:canonical: pyirk.core.Entity.set_relation

```{autodoc2-docstring} pyirk.core.Entity.set_relation
```

````

````{py:method} _set_relation(rel_uri: str, rel_content: object, scope: pyirk._core.keymanager.Optional[pyirk.core.Entity] = None, qualifiers: pyirk._core.keymanager.Optional[list] = None, proxyitem: pyirk._core.keymanager.Optional[pyirk.core.Item] = None) -> pyirk.core.Statement
:canonical: pyirk.core.Entity._set_relation

```{autodoc2-docstring} pyirk.core.Entity._set_relation
```

````

````{py:method} get_relations(key_str_or_uri: pyirk._core.keymanager.Optional[str] = None, return_subj: bool = False, return_obj: bool = False) -> pyirk._core.serialization.Union[pyirk._core.keymanager.Dict[str, list], list]
:canonical: pyirk.core.Entity.get_relations

```{autodoc2-docstring} pyirk.core.Entity.get_relations
```

````

````{py:method} get_inv_relations(key_str_or_uri: pyirk._core.keymanager.Optional[str] = None, return_subj: bool = False, return_obj: bool = False) -> pyirk._core.serialization.Union[pyirk._core.keymanager.Dict[str, list], list]
:canonical: pyirk.core.Entity.get_inv_relations

```{autodoc2-docstring} pyirk.core.Entity.get_inv_relations
```

````

````{py:method} _return_relations(base_dict, key_str_or_uri: str, return_subj: bool = False, return_obj: bool = False) -> pyirk._core.serialization.Union[pyirk._core.keymanager.Dict[str, list], list]
:canonical: pyirk.core.Entity._return_relations
:staticmethod:

```{autodoc2-docstring} pyirk.core.Entity._return_relations
```

````

````{py:method} overwrite_statement(rel_key_str_or_uri: str, new_obj: pyirk.core.Entity, qualifiers=None) -> pyirk.core.Statement
:canonical: pyirk.core.Entity.overwrite_statement

```{autodoc2-docstring} pyirk.core.Entity.overwrite_statement
```

````

````{py:method} finalize()
:canonical: pyirk.core.Entity.finalize

```{autodoc2-docstring} pyirk.core.Entity.finalize
```

````

````{py:method} __hash__()
:canonical: pyirk.core.Entity.__hash__

```{autodoc2-docstring} pyirk.core.Entity.__hash__
```

````

````{py:method} update_relations(**kwargs)
:canonical: pyirk.core.Entity.update_relations

```{autodoc2-docstring} pyirk.core.Entity.update_relations
```

````

`````

````{py:function} wrap_function_with_search_uri_context(func, uri=None)
:canonical: pyirk.core.wrap_function_with_search_uri_context

```{autodoc2-docstring} pyirk.core.wrap_function_with_search_uri_context
```
````

`````{py:class} PrefixShortCut
:canonical: pyirk.core.PrefixShortCut

```{autodoc2-docstring} pyirk.core.PrefixShortCut
```

````{py:method} __getattribute__(prefix_name: str) -> typing.Any
:canonical: pyirk.core.PrefixShortCut.__getattribute__

````

`````

````{py:data} pf
:canonical: pyirk.core.pf
:value: >
   'PrefixShortCut(...)'

```{autodoc2-docstring} pyirk.core.pf
```

````

`````{py:class} DataStore()
:canonical: pyirk.core.DataStore

```{autodoc2-docstring} pyirk.core.DataStore
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.core.DataStore.__init__
```

````{py:method} initialize_hooks() -> dict
:canonical: pyirk.core.DataStore.initialize_hooks

```{autodoc2-docstring} pyirk.core.DataStore.initialize_hooks
```

````

````{py:method} get_item_by_label(label) -> pyirk.core.Entity
:canonical: pyirk.core.DataStore.get_item_by_label

```{autodoc2-docstring} pyirk.core.DataStore.get_item_by_label
```

````

````{py:method} get_entity_by_key_str(key_str, mod_uri=None) -> pyirk.core.Entity
:canonical: pyirk.core.DataStore.get_entity_by_key_str

```{autodoc2-docstring} pyirk.core.DataStore.get_entity_by_key_str
```

````

````{py:method} get_entity_by_uri(uri: str, etype=None, strict=True) -> pyirk._core.serialization.Union[pyirk.core.Entity, None]
:canonical: pyirk.core.DataStore.get_entity_by_uri

```{autodoc2-docstring} pyirk.core.DataStore.get_entity_by_uri
```

````

````{py:method} _default_subject_filter(entity)
:canonical: pyirk.core.DataStore._default_subject_filter
:staticmethod:

```{autodoc2-docstring} pyirk.core.DataStore._default_subject_filter
```

````

````{py:method} get_subjects_for_relation(rel_uri: str, filter=None)
:canonical: pyirk.core.DataStore.get_subjects_for_relation

```{autodoc2-docstring} pyirk.core.DataStore.get_subjects_for_relation
```

````

````{py:method} get_statements(entity_uri: str, rel_uri: str) -> pyirk._core.mod_management.List[pyirk.core.Statement]
:canonical: pyirk.core.DataStore.get_statements

```{autodoc2-docstring} pyirk.core.DataStore.get_statements
```

````

````{py:method} set_statement(stm: pyirk.core.Statement) -> None
:canonical: pyirk.core.DataStore.set_statement

```{autodoc2-docstring} pyirk.core.DataStore.set_statement
```

````

````{py:method} get_uri_for_prefix(prefix: str) -> str
:canonical: pyirk.core.DataStore.get_uri_for_prefix

```{autodoc2-docstring} pyirk.core.DataStore.get_uri_for_prefix
```

````

````{py:method} preprocess_query(query, sanity_check=True)
:canonical: pyirk.core.DataStore.preprocess_query

```{autodoc2-docstring} pyirk.core.DataStore.preprocess_query
```

````

````{py:method} append_scope(scope)
:canonical: pyirk.core.DataStore.append_scope

```{autodoc2-docstring} pyirk.core.DataStore.append_scope
```

````

````{py:method} remove_scope(scope)
:canonical: pyirk.core.DataStore.remove_scope

```{autodoc2-docstring} pyirk.core.DataStore.remove_scope
```

````

````{py:method} get_current_scope()
:canonical: pyirk.core.DataStore.get_current_scope

```{autodoc2-docstring} pyirk.core.DataStore.get_current_scope
```

````

`````

````{py:data} ds
:canonical: pyirk.core.ds
:value: >
   'DataStore(...)'

```{autodoc2-docstring} pyirk.core.ds
```

````

````{py:data} YAML_VALUE
:canonical: pyirk.core.YAML_VALUE
:value: >
   None

```{autodoc2-docstring} pyirk.core.YAML_VALUE
```

````

````{py:function} get_label_to_item_dict(known_duplicates: list = None)
:canonical: pyirk.core.get_label_to_item_dict

```{autodoc2-docstring} pyirk.core.get_label_to_item_dict
```
````

````{py:function} get_label_to_relation_dict(known_duplicates: list = None)
:canonical: pyirk.core.get_label_to_relation_dict

```{autodoc2-docstring} pyirk.core.get_label_to_relation_dict
```
````

````{py:data} re_prefix_shortkey_suffix
:canonical: pyirk.core.re_prefix_shortkey_suffix
:value: >
   'compile(...)'

```{autodoc2-docstring} pyirk.core.re_prefix_shortkey_suffix
```

````

````{py:data} re_suffix_underscore
:canonical: pyirk.core.re_suffix_underscore
:value: >
   'compile(...)'

```{autodoc2-docstring} pyirk.core.re_suffix_underscore
```

````

````{py:data} re_suffix_square_brackets
:canonical: pyirk.core.re_suffix_square_brackets
:value: >
   'compile(...)'

```{autodoc2-docstring} pyirk.core.re_suffix_square_brackets
```

````

````{py:data} langcode_end_pattern
:canonical: pyirk.core.langcode_end_pattern
:value: >
   'compile(...)'

```{autodoc2-docstring} pyirk.core.langcode_end_pattern
```

````

`````{py:class} Item(base_uri: str, key_str: str, **kwargs)
:canonical: pyirk.core.Item

Bases: {py:obj}`pyirk.core.Entity`

````{py:method} __repr__()
:canonical: pyirk.core.Item.__repr__

````

`````

````{py:function} process_kwargs_for_entity_creation(entity_key: str, kwargs: dict) -> tuple[dict, dict]
:canonical: pyirk.core.process_kwargs_for_entity_creation

```{autodoc2-docstring} pyirk.core.process_kwargs_for_entity_creation
```
````

`````{py:class} KWArgManager(entity_key: str, kwargs: dict)
:canonical: pyirk.core.KWArgManager

```{autodoc2-docstring} pyirk.core.KWArgManager
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.core.KWArgManager.__init__
```

````{py:method} process()
:canonical: pyirk.core.KWArgManager.process

```{autodoc2-docstring} pyirk.core.KWArgManager.process
```

````

`````

`````{py:class} SingleKWArgProcessor(kwam: pyirk.core.KWArgManager, kwarg_name: str, kwarg_value: str)
:canonical: pyirk.core.SingleKWArgProcessor

```{autodoc2-docstring} pyirk.core.SingleKWArgProcessor
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.core.SingleKWArgProcessor.__init__
```

````{py:method} handle_kwarg_stage1()
:canonical: pyirk.core.SingleKWArgProcessor.handle_kwarg_stage1

```{autodoc2-docstring} pyirk.core.SingleKWArgProcessor.handle_kwarg_stage1
```

````

````{py:method} handle_kwarg_stage2()
:canonical: pyirk.core.SingleKWArgProcessor.handle_kwarg_stage2

```{autodoc2-docstring} pyirk.core.SingleKWArgProcessor.handle_kwarg_stage2
```

````

````{py:method} dispatch_value_multiplicity_for_rk_with_lr()
:canonical: pyirk.core.SingleKWArgProcessor.dispatch_value_multiplicity_for_rk_with_lr

```{autodoc2-docstring} pyirk.core.SingleKWArgProcessor.dispatch_value_multiplicity_for_rk_with_lr
```

````

````{py:method} handle_rk_with_lr(scalar_kwarg_value)
:canonical: pyirk.core.SingleKWArgProcessor.handle_rk_with_lr

```{autodoc2-docstring} pyirk.core.SingleKWArgProcessor.handle_rk_with_lr
```

````

````{py:method} _handle_kwarg_for_functional_rel(scalar_kwarg_value)
:canonical: pyirk.core.SingleKWArgProcessor._handle_kwarg_for_functional_rel

```{autodoc2-docstring} pyirk.core.SingleKWArgProcessor._handle_kwarg_for_functional_rel
```

````

````{py:method} _check_for_valid_language(scalar_kwarg_value, first_value=False)
:canonical: pyirk.core.SingleKWArgProcessor._check_for_valid_language

```{autodoc2-docstring} pyirk.core.SingleKWArgProcessor._check_for_valid_language
```

````

````{py:method} _handle_value(kwarg_value, lang_related_value_list=None) -> pyirk._core.serialization.Literal
:canonical: pyirk.core.SingleKWArgProcessor._handle_value

```{autodoc2-docstring} pyirk.core.SingleKWArgProcessor._handle_value
```

````

`````

````{py:function} process_lang_related_kwargs_for_entity_creation(entity: pyirk.core.Entity, short_key: str, lang_related_kwargs: dict) -> None
:canonical: pyirk.core.process_lang_related_kwargs_for_entity_creation

```{autodoc2-docstring} pyirk.core.process_lang_related_kwargs_for_entity_creation
```
````

````{py:function} create_item(key_str: str = '', **kwargs) -> pyirk.core.Item
:canonical: pyirk.core.create_item

```{autodoc2-docstring} pyirk.core.create_item
```
````

`````{py:class} Relation(base_uri: str, short_key: str, **kwargs)
:canonical: pyirk.core.Relation

Bases: {py:obj}`pyirk.core.Entity`

````{py:method} __repr__()
:canonical: pyirk.core.Relation.__repr__

````

`````

`````{py:class} RelationRole(*args, **kwds)
:canonical: pyirk.core.RelationRole

Bases: {py:obj}`pyirk._core.keymanager.Enum`

```{autodoc2-docstring} pyirk.core.RelationRole
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.core.RelationRole.__init__
```

````{py:attribute} SUBJECT
:canonical: pyirk.core.RelationRole.SUBJECT
:value: >
   0

```{autodoc2-docstring} pyirk.core.RelationRole.SUBJECT
```

````

````{py:attribute} PREDICATE
:canonical: pyirk.core.RelationRole.PREDICATE
:value: >
   1

```{autodoc2-docstring} pyirk.core.RelationRole.PREDICATE
```

````

````{py:attribute} OBJECT
:canonical: pyirk.core.RelationRole.OBJECT
:value: >
   2

```{autodoc2-docstring} pyirk.core.RelationRole.OBJECT
```

````

`````

````{py:data} VALID_HOOK_PHASES
:canonical: pyirk.core.VALID_HOOK_PHASES
:value: >
   ['post-create', 'post-finalize']

```{autodoc2-docstring} pyirk.core.VALID_HOOK_PHASES
```

````

````{py:data} VALID_HOOK_TYPES
:canonical: pyirk.core.VALID_HOOK_TYPES
:value: >
   ['post-create-entity', 'post-create-item', 'post-create-relation', 'post-finalize-entity', 'post-fin...

```{autodoc2-docstring} pyirk.core.VALID_HOOK_TYPES
```

````

````{py:function} run_hooks(entity: pyirk.core.Entity, phase: str) -> None
:canonical: pyirk.core.run_hooks

```{autodoc2-docstring} pyirk.core.run_hooks
```
````

````{py:function} register_hook(type_str: str, func: callable) -> None
:canonical: pyirk.core.register_hook

```{autodoc2-docstring} pyirk.core.register_hook
```
````

````{py:function} repl_spc_by_udsc(txt: str) -> str
:canonical: pyirk.core.repl_spc_by_udsc

```{autodoc2-docstring} pyirk.core.repl_spc_by_udsc
```
````

`````{py:class} RawQualifier(rel: pyirk.core.Relation, obj: pyirk._core.serialization.Union[pyirk._core.serialization.Literal, pyirk.core.Entity])
:canonical: pyirk.core.RawQualifier

```{autodoc2-docstring} pyirk.core.RawQualifier
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.core.RawQualifier.__init__
```

````{py:method} __repr__()
:canonical: pyirk.core.RawQualifier.__repr__

````

`````

`````{py:class} QualifierFactory(relation: pyirk.core.Relation, registry_name: pyirk._core.keymanager.Optional[str] = None)
:canonical: pyirk.core.QualifierFactory

```{autodoc2-docstring} pyirk.core.QualifierFactory
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.core.QualifierFactory.__init__
```

````{py:method} __call__(obj)
:canonical: pyirk.core.QualifierFactory.__call__

```{autodoc2-docstring} pyirk.core.QualifierFactory.__call__
```

````

`````

`````{py:class} Statement(relation: pyirk.core.Relation = None, relation_tuple: tuple = None, role: pyirk.core.RelationRole = None, corresponding_entity: pyirk.core.Entity = None, corresponding_literal=None, scope=None, qualifiers: pyirk._core.keymanager.Optional[pyirk._core.serialization.Union[pyirk._core.mod_management.List[pyirk.core.RawQualifier], pyirk._core.mod_management.List[pyirk.core.QualifierStatement]]] = None, proxyitem: pyirk._core.keymanager.Optional[pyirk.core.Item] = None)
:canonical: pyirk.core.Statement

```{autodoc2-docstring} pyirk.core.Statement
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.core.Statement.__init__
```

````{py:property} key_str
:canonical: pyirk.core.Statement.key_str

```{autodoc2-docstring} pyirk.core.Statement.key_str
```

````

````{py:method} __repr__()
:canonical: pyirk.core.Statement.__repr__

````

````{py:method} _process_qualifiers(qlist: pyirk._core.serialization.Union[pyirk._core.mod_management.List[pyirk.core.RawQualifier], pyirk._core.mod_management.List[pyirk.core.QualifierStatement]], scope: pyirk._core.keymanager.Optional[pyirk.core.Entity] = None) -> None
:canonical: pyirk.core.Statement._process_qualifiers

```{autodoc2-docstring} pyirk.core.Statement._process_qualifiers
```

````

````{py:method} is_qualifier()
:canonical: pyirk.core.Statement.is_qualifier

```{autodoc2-docstring} pyirk.core.Statement.is_qualifier
```

````

````{py:method} get_first_qualifier_obj_with_rel(key=None, uri=None, tolerate_key_error=False)
:canonical: pyirk.core.Statement.get_first_qualifier_obj_with_rel

```{autodoc2-docstring} pyirk.core.Statement.get_first_qualifier_obj_with_rel
```

````

````{py:method} unlink(*args) -> None
:canonical: pyirk.core.Statement.unlink

```{autodoc2-docstring} pyirk.core.Statement.unlink
```

````

`````

```{py:class} QualifierStatement(*args, **kwargs)
:canonical: pyirk.core.QualifierStatement

Bases: {py:obj}`pyirk.core.Statement`

```

````{py:function} tolerant_removal(sequence, element)
:canonical: pyirk.core.tolerant_removal

```{autodoc2-docstring} pyirk.core.tolerant_removal
```
````

````{py:function} create_relation(key_str: str = '', **kwargs) -> pyirk.core.Relation
:canonical: pyirk.core.create_relation

```{autodoc2-docstring} pyirk.core.create_relation
```
````

````{py:function} create_builtin_item(*args, **kwargs) -> pyirk.core.Item
:canonical: pyirk.core.create_builtin_item

```{autodoc2-docstring} pyirk.core.create_builtin_item
```
````

````{py:function} create_builtin_relation(*args, **kwargs) -> pyirk.core.Relation
:canonical: pyirk.core.create_builtin_relation

```{autodoc2-docstring} pyirk.core.create_builtin_relation
```
````

````{py:data} _uri_stack
:canonical: pyirk.core._uri_stack
:value: >
   []

```{autodoc2-docstring} pyirk.core._uri_stack
```

````

````{py:data} _search_uri_stack
:canonical: pyirk.core._search_uri_stack
:value: >
   []

```{autodoc2-docstring} pyirk.core._search_uri_stack
```

````

````{py:data} _attr_name_cache
:canonical: pyirk.core._attr_name_cache
:type: dict
:value: >
   None

```{autodoc2-docstring} pyirk.core._attr_name_cache
```

````

````{py:function} replace_and_unlink_entity(old_entity: pyirk.core.Entity, new_entity: pyirk.core.Entity)
:canonical: pyirk.core.replace_and_unlink_entity

```{autodoc2-docstring} pyirk.core.replace_and_unlink_entity
```
````

````{py:data} df
:canonical: pyirk.core.df
:value: >
   'LanguageCode(...)'

```{autodoc2-docstring} pyirk.core.df
```

````

````{py:data} en
:canonical: pyirk.core.en
:value: >
   'LanguageCode(...)'

```{autodoc2-docstring} pyirk.core.en
```

````

````{py:data} de
:canonical: pyirk.core.de
:value: >
   'LanguageCode(...)'

```{autodoc2-docstring} pyirk.core.de
```

````

````{py:data} fr
:canonical: pyirk.core.fr
:value: >
   'LanguageCode(...)'

```{autodoc2-docstring} pyirk.core.fr
```

````

````{py:data} it
:canonical: pyirk.core.it
:value: >
   'LanguageCode(...)'

```{autodoc2-docstring} pyirk.core.it
```

````

````{py:data} es
:canonical: pyirk.core.es
:value: >
   'LanguageCode(...)'

```{autodoc2-docstring} pyirk.core.es
```

````

`````{py:class} RuleResult()
:canonical: pyirk.core.RuleResult

```{autodoc2-docstring} pyirk.core.RuleResult
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.core.RuleResult.__init__
```

````{py:method} add_statement(stm: pyirk.core.Statement)
:canonical: pyirk.core.RuleResult.add_statement

```{autodoc2-docstring} pyirk.core.RuleResult.add_statement
```

````

````{py:method} add_statements(stms: pyirk._core.mod_management.List[pyirk.core.Statement])
:canonical: pyirk.core.RuleResult.add_statements

```{autodoc2-docstring} pyirk.core.RuleResult.add_statements
```

````

````{py:method} add_entity(entity: pyirk.core.Entity)
:canonical: pyirk.core.RuleResult.add_entity

```{autodoc2-docstring} pyirk.core.RuleResult.add_entity
```

````

````{py:method} extend(part: pyirk.core.RuleResult)
:canonical: pyirk.core.RuleResult.extend

```{autodoc2-docstring} pyirk.core.RuleResult.extend
```

````

````{py:method} add_partial(part: pyirk.core.RuleResult)
:canonical: pyirk.core.RuleResult.add_partial

```{autodoc2-docstring} pyirk.core.RuleResult.add_partial
```

````

````{py:method} __repr__()
:canonical: pyirk.core.RuleResult.__repr__

````

````{py:property} rule
:canonical: pyirk.core.RuleResult.rule

```{autodoc2-docstring} pyirk.core.RuleResult.rule
```

````

````{py:method} get_new_triples() -> list[tuple[pyirk.core.Entity]]
:canonical: pyirk.core.RuleResult.get_new_triples

```{autodoc2-docstring} pyirk.core.RuleResult.get_new_triples
```

````

`````

````{py:function} is_true(subject: pyirk.core.Entity, predicate: pyirk.core.Relation, object) -> tuple[bool, None]
:canonical: pyirk.core.is_true

```{autodoc2-docstring} pyirk.core.is_true
```
````

````{py:function} format_entity_html(e: pyirk.core.Entity)
:canonical: pyirk.core.format_entity_html

```{autodoc2-docstring} pyirk.core.format_entity_html
```
````

````{py:function} is_subclass(item: pyirk.core.Item, parent_item: pyirk.core.Item)
:canonical: pyirk.core.is_subclass

```{autodoc2-docstring} pyirk.core.is_subclass
```
````

````{py:function} is_instance(item: pyirk.core.Item, parent_item: pyirk.core.Item)
:canonical: pyirk.core.is_instance

```{autodoc2-docstring} pyirk.core.is_instance
```
````

````{py:function} is_subproperty(item: pyirk.core.Item, parent_property: pyirk.core.Item)
:canonical: pyirk.core.is_subproperty

```{autodoc2-docstring} pyirk.core.is_subproperty
```
````