# {py:mod}`pyirk.consistency_checking`

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

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

## Module Contents

### Classes

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

* - {py:obj}`IrkConsistencyError <pyirk.consistency_checking.IrkConsistencyError>`
  - ```{autodoc2-docstring} pyirk.consistency_checking.IrkConsistencyError
    :summary:
    ```
* - {py:obj}`IrkTypeError <pyirk.consistency_checking.IrkTypeError>`
  - ```{autodoc2-docstring} pyirk.consistency_checking.IrkTypeError
    :summary:
    ```
* - {py:obj}`WrongArgNumber <pyirk.consistency_checking.WrongArgNumber>`
  - ```{autodoc2-docstring} pyirk.consistency_checking.WrongArgNumber
    :summary:
    ```
* - {py:obj}`WrongArgType <pyirk.consistency_checking.WrongArgType>`
  - ```{autodoc2-docstring} pyirk.consistency_checking.WrongArgType
    :summary:
    ```
````

### Functions

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

* - {py:obj}`check <pyirk.consistency_checking.check>`
  - ```{autodoc2-docstring} pyirk.consistency_checking.check
    :summary:
    ```
* - {py:obj}`check_applied_operator <pyirk.consistency_checking.check_applied_operator>`
  - ```{autodoc2-docstring} pyirk.consistency_checking.check_applied_operator
    :summary:
    ```
* - {py:obj}`check_type <pyirk.consistency_checking.check_type>`
  - ```{autodoc2-docstring} pyirk.consistency_checking.check_type
    :summary:
    ```
* - {py:obj}`get_error_location <pyirk.consistency_checking.get_error_location>`
  - ```{autodoc2-docstring} pyirk.consistency_checking.get_error_location
    :summary:
    ```
* - {py:obj}`get_expected_arg_types <pyirk.consistency_checking.get_expected_arg_types>`
  - ```{autodoc2-docstring} pyirk.consistency_checking.get_expected_arg_types
    :summary:
    ```
* - {py:obj}`enable_consistency_checking <pyirk.consistency_checking.enable_consistency_checking>`
  - ```{autodoc2-docstring} pyirk.consistency_checking.enable_consistency_checking
    :summary:
    ```
* - {py:obj}`apply_constraint_rules_to_entity <pyirk.consistency_checking.apply_constraint_rules_to_entity>`
  - ```{autodoc2-docstring} pyirk.consistency_checking.apply_constraint_rules_to_entity
    :summary:
    ```
````

### API

````{py:class} IrkConsistencyError
:canonical: pyirk.consistency_checking.IrkConsistencyError

Bases: {py:obj}`pyirk.core.aux.GeneralPyIRKError`

```{autodoc2-docstring} pyirk.consistency_checking.IrkConsistencyError
```

````

````{py:class} IrkTypeError
:canonical: pyirk.consistency_checking.IrkTypeError

Bases: {py:obj}`pyirk.consistency_checking.IrkConsistencyError`

```{autodoc2-docstring} pyirk.consistency_checking.IrkTypeError
```

````

````{py:class} WrongArgNumber
:canonical: pyirk.consistency_checking.WrongArgNumber

Bases: {py:obj}`pyirk.consistency_checking.IrkTypeError`

```{autodoc2-docstring} pyirk.consistency_checking.WrongArgNumber
```

````

````{py:class} WrongArgType
:canonical: pyirk.consistency_checking.WrongArgType

Bases: {py:obj}`pyirk.consistency_checking.IrkTypeError`

```{autodoc2-docstring} pyirk.consistency_checking.WrongArgType
```

````

````{py:function} check(itm: pyirk.core.Item)
:canonical: pyirk.consistency_checking.check

```{autodoc2-docstring} pyirk.consistency_checking.check
```
````

````{py:function} check_applied_operator(itm: pyirk.core.Item)
:canonical: pyirk.consistency_checking.check_applied_operator

```{autodoc2-docstring} pyirk.consistency_checking.check_applied_operator
```
````

````{py:function} check_type(actual_type, secondary_class_items, expected_type, raise_exception=True) -> bool
:canonical: pyirk.consistency_checking.check_type

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

````{py:function} get_error_location()
:canonical: pyirk.consistency_checking.get_error_location

```{autodoc2-docstring} pyirk.consistency_checking.get_error_location
```
````

````{py:function} get_expected_arg_types(itm: pyirk.core.Item) -> typing.Tuple[pyirk.core.Item]
:canonical: pyirk.consistency_checking.get_expected_arg_types

```{autodoc2-docstring} pyirk.consistency_checking.get_expected_arg_types
```
````

````{py:function} enable_consistency_checking()
:canonical: pyirk.consistency_checking.enable_consistency_checking

```{autodoc2-docstring} pyirk.consistency_checking.enable_consistency_checking
```
````

````{py:function} apply_constraint_rules_to_entity(entity: pyirk.builtin_entities.Entity)
:canonical: pyirk.consistency_checking.apply_constraint_rules_to_entity

```{autodoc2-docstring} pyirk.consistency_checking.apply_constraint_rules_to_entity
```
````