# {py:mod}`pyirk.auxiliary`

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

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

## Module Contents

### Classes

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

* - {py:obj}`OneToOneMapping <pyirk.auxiliary.OneToOneMapping>`
  - ```{autodoc2-docstring} pyirk.auxiliary.OneToOneMapping
    :summary:
    ```
* - {py:obj}`ListWithAttributes <pyirk.auxiliary.ListWithAttributes>`
  - ```{autodoc2-docstring} pyirk.auxiliary.ListWithAttributes
    :summary:
    ```
````

### Functions

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

* - {py:obj}`ensure_list <pyirk.auxiliary.ensure_list>`
  - ```{autodoc2-docstring} pyirk.auxiliary.ensure_list
    :summary:
    ```
* - {py:obj}`apply_func_to_table_cells <pyirk.auxiliary.apply_func_to_table_cells>`
  - ```{autodoc2-docstring} pyirk.auxiliary.apply_func_to_table_cells
    :summary:
    ```
* - {py:obj}`ensure_rdf_str_literal <pyirk.auxiliary.ensure_rdf_str_literal>`
  - ```{autodoc2-docstring} pyirk.auxiliary.ensure_rdf_str_literal
    :summary:
    ```
* - {py:obj}`all_subclasses <pyirk.auxiliary.all_subclasses>`
  - ```{autodoc2-docstring} pyirk.auxiliary.all_subclasses
    :summary:
    ```
* - {py:obj}`print_inheritance_tree <pyirk.auxiliary.print_inheritance_tree>`
  - ```{autodoc2-docstring} pyirk.auxiliary.print_inheritance_tree
    :summary:
    ```
* - {py:obj}`ensure_valid_short_key <pyirk.auxiliary.ensure_valid_short_key>`
  - ```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_short_key
    :summary:
    ```
* - {py:obj}`ensure_valid_uri <pyirk.auxiliary.ensure_valid_uri>`
  - ```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_uri
    :summary:
    ```
* - {py:obj}`ensure_valid_relation_uri <pyirk.auxiliary.ensure_valid_relation_uri>`
  - ```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_relation_uri
    :summary:
    ```
* - {py:obj}`ensure_valid_item_uri <pyirk.auxiliary.ensure_valid_item_uri>`
  - ```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_item_uri
    :summary:
    ```
* - {py:obj}`ensure_valid_prefix <pyirk.auxiliary.ensure_valid_prefix>`
  - ```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_prefix
    :summary:
    ```
* - {py:obj}`parse_uri <pyirk.auxiliary.parse_uri>`
  - ```{autodoc2-docstring} pyirk.auxiliary.parse_uri
    :summary:
    ```
* - {py:obj}`ensure_valid_baseuri <pyirk.auxiliary.ensure_valid_baseuri>`
  - ```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_baseuri
    :summary:
    ```
* - {py:obj}`make_uri <pyirk.auxiliary.make_uri>`
  - ```{autodoc2-docstring} pyirk.auxiliary.make_uri
    :summary:
    ```
* - {py:obj}`convert_key_str_to_num <pyirk.auxiliary.convert_key_str_to_num>`
  - ```{autodoc2-docstring} pyirk.auxiliary.convert_key_str_to_num
    :summary:
    ```
* - {py:obj}`clean_dict <pyirk.auxiliary.clean_dict>`
  - ```{autodoc2-docstring} pyirk.auxiliary.clean_dict
    :summary:
    ```
* - {py:obj}`uri_set <pyirk.auxiliary.uri_set>`
  - ```{autodoc2-docstring} pyirk.auxiliary.uri_set
    :summary:
    ```
* - {py:obj}`bright <pyirk.auxiliary.bright>`
  - ```{autodoc2-docstring} pyirk.auxiliary.bright
    :summary:
    ```
* - {py:obj}`bblue <pyirk.auxiliary.bblue>`
  - ```{autodoc2-docstring} pyirk.auxiliary.bblue
    :summary:
    ```
* - {py:obj}`bcyan <pyirk.auxiliary.bcyan>`
  - ```{autodoc2-docstring} pyirk.auxiliary.bcyan
    :summary:
    ```
* - {py:obj}`bmagenta <pyirk.auxiliary.bmagenta>`
  - ```{autodoc2-docstring} pyirk.auxiliary.bmagenta
    :summary:
    ```
* - {py:obj}`bgreen <pyirk.auxiliary.bgreen>`
  - ```{autodoc2-docstring} pyirk.auxiliary.bgreen
    :summary:
    ```
* - {py:obj}`bred <pyirk.auxiliary.bred>`
  - ```{autodoc2-docstring} pyirk.auxiliary.bred
    :summary:
    ```
* - {py:obj}`byellow <pyirk.auxiliary.byellow>`
  - ```{autodoc2-docstring} pyirk.auxiliary.byellow
    :summary:
    ```
* - {py:obj}`get_irk_root_dir <pyirk.auxiliary.get_irk_root_dir>`
  - ```{autodoc2-docstring} pyirk.auxiliary.get_irk_root_dir
    :summary:
    ```
* - {py:obj}`get_irk_path <pyirk.auxiliary.get_irk_path>`
  - ```{autodoc2-docstring} pyirk.auxiliary.get_irk_path
    :summary:
    ```
* - {py:obj}`_handle_exception <pyirk.auxiliary._handle_exception>`
  - ```{autodoc2-docstring} pyirk.auxiliary._handle_exception
    :summary:
    ```
* - {py:obj}`load_module_configs_from_general_config <pyirk.auxiliary.load_module_configs_from_general_config>`
  - ```{autodoc2-docstring} pyirk.auxiliary.load_module_configs_from_general_config
    :summary:
    ```
* - {py:obj}`_extract_uri_from_python_file <pyirk.auxiliary._extract_uri_from_python_file>`
  - ```{autodoc2-docstring} pyirk.auxiliary._extract_uri_from_python_file
    :summary:
    ```
* - {py:obj}`get_initial_config_content_for_ci <pyirk.auxiliary.get_initial_config_content_for_ci>`
  - ```{autodoc2-docstring} pyirk.auxiliary.get_initial_config_content_for_ci
    :summary:
    ```
````

### Data

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

* - {py:obj}`logger <pyirk.auxiliary.logger>`
  - ```{autodoc2-docstring} pyirk.auxiliary.logger
    :summary:
    ```
* - {py:obj}`startup_workdir <pyirk.auxiliary.startup_workdir>`
  - ```{autodoc2-docstring} pyirk.auxiliary.startup_workdir
    :summary:
    ```
* - {py:obj}`STATEMENTS_URI_PART <pyirk.auxiliary.STATEMENTS_URI_PART>`
  - ```{autodoc2-docstring} pyirk.auxiliary.STATEMENTS_URI_PART
    :summary:
    ```
* - {py:obj}`PREDICATES_URI_PART <pyirk.auxiliary.PREDICATES_URI_PART>`
  - ```{autodoc2-docstring} pyirk.auxiliary.PREDICATES_URI_PART
    :summary:
    ```
* - {py:obj}`QUALIFIERS_URI_PART <pyirk.auxiliary.QUALIFIERS_URI_PART>`
  - ```{autodoc2-docstring} pyirk.auxiliary.QUALIFIERS_URI_PART
    :summary:
    ```
* - {py:obj}`AVAILABLE_PACKAGES <pyirk.auxiliary.AVAILABLE_PACKAGES>`
  - ```{autodoc2-docstring} pyirk.auxiliary.AVAILABLE_PACKAGES
    :summary:
    ```
* - {py:obj}`AVAILABLE_MODULES <pyirk.auxiliary.AVAILABLE_MODULES>`
  - ```{autodoc2-docstring} pyirk.auxiliary.AVAILABLE_MODULES
    :summary:
    ```
* - {py:obj}`STATES <pyirk.auxiliary.STATES>`
  - ```{autodoc2-docstring} pyirk.auxiliary.STATES
    :summary:
    ```
* - {py:obj}`_RE_SHORT_KEY <pyirk.auxiliary._RE_SHORT_KEY>`
  - ```{autodoc2-docstring} pyirk.auxiliary._RE_SHORT_KEY
    :summary:
    ```
````

### API

````{py:data} logger
:canonical: pyirk.auxiliary.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} pyirk.auxiliary.logger
```

````

````{py:data} startup_workdir
:canonical: pyirk.auxiliary.startup_workdir
:value: >
   'abspath(...)'

```{autodoc2-docstring} pyirk.auxiliary.startup_workdir
```

````

````{py:data} STATEMENTS_URI_PART
:canonical: pyirk.auxiliary.STATEMENTS_URI_PART
:value: >
   '/STATEMENTS'

```{autodoc2-docstring} pyirk.auxiliary.STATEMENTS_URI_PART
```

````

````{py:data} PREDICATES_URI_PART
:canonical: pyirk.auxiliary.PREDICATES_URI_PART
:value: >
   '/PREDICATES'

```{autodoc2-docstring} pyirk.auxiliary.PREDICATES_URI_PART
```

````

````{py:data} QUALIFIERS_URI_PART
:canonical: pyirk.auxiliary.QUALIFIERS_URI_PART
:value: >
   '/QUALIFIERS'

```{autodoc2-docstring} pyirk.auxiliary.QUALIFIERS_URI_PART
```

````

````{py:data} AVAILABLE_PACKAGES
:canonical: pyirk.auxiliary.AVAILABLE_PACKAGES
:type: dict[str, str]
:value: >
   None

```{autodoc2-docstring} pyirk.auxiliary.AVAILABLE_PACKAGES
```

````

````{py:data} AVAILABLE_MODULES
:canonical: pyirk.auxiliary.AVAILABLE_MODULES
:type: dict[str, str]
:value: >
   None

```{autodoc2-docstring} pyirk.auxiliary.AVAILABLE_MODULES
```

````

````{py:data} STATES
:canonical: pyirk.auxiliary.STATES
:value: >
   'Container(...)'

```{autodoc2-docstring} pyirk.auxiliary.STATES
```

````

````{py:data} _RE_SHORT_KEY
:canonical: pyirk.auxiliary._RE_SHORT_KEY
:value: >
   'compile(...)'

```{autodoc2-docstring} pyirk.auxiliary._RE_SHORT_KEY
```

````

```{py:exception} NotYetFinishedError()
:canonical: pyirk.auxiliary.NotYetFinishedError

Bases: {py:obj}`NotImplementedError`

```

`````{py:class} OneToOneMapping(a_dict: dict = None, **kwargs)
:canonical: pyirk.auxiliary.OneToOneMapping

Bases: {py:obj}`object`

```{autodoc2-docstring} pyirk.auxiliary.OneToOneMapping
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.auxiliary.OneToOneMapping.__init__
```

````{py:method} add_pair(key_a, key_b)
:canonical: pyirk.auxiliary.OneToOneMapping.add_pair

```{autodoc2-docstring} pyirk.auxiliary.OneToOneMapping.add_pair
```

````

````{py:method} remove_pair(key_a=None, key_b=None, strict=True)
:canonical: pyirk.auxiliary.OneToOneMapping.remove_pair

```{autodoc2-docstring} pyirk.auxiliary.OneToOneMapping.remove_pair
```

````

`````

````{py:function} ensure_list(arg)
:canonical: pyirk.auxiliary.ensure_list

```{autodoc2-docstring} pyirk.auxiliary.ensure_list
```
````

`````{py:class} ListWithAttributes()
:canonical: pyirk.auxiliary.ListWithAttributes

Bases: {py:obj}`list`

```{autodoc2-docstring} pyirk.auxiliary.ListWithAttributes
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.auxiliary.ListWithAttributes.__init__
```

````{py:attribute} var
:canonical: pyirk.auxiliary.ListWithAttributes.var
:type: typing.Iterable
:value: >
   None

```{autodoc2-docstring} pyirk.auxiliary.ListWithAttributes.var
```

````

`````

````{py:function} apply_func_to_table_cells(func: callable, table: typing.Iterable, *args, **kwargs) -> pyirk.auxiliary.ListWithAttributes
:canonical: pyirk.auxiliary.apply_func_to_table_cells

```{autodoc2-docstring} pyirk.auxiliary.apply_func_to_table_cells
```
````

````{py:function} ensure_rdf_str_literal(arg, allow_none=True) -> typing.Union[rdflib.Literal, None]
:canonical: pyirk.auxiliary.ensure_rdf_str_literal

```{autodoc2-docstring} pyirk.auxiliary.ensure_rdf_str_literal
```
````

````{py:function} all_subclasses(cls)
:canonical: pyirk.auxiliary.all_subclasses

```{autodoc2-docstring} pyirk.auxiliary.all_subclasses
```
````

````{py:function} print_inheritance_tree(cls, prefix='')
:canonical: pyirk.auxiliary.print_inheritance_tree

```{autodoc2-docstring} pyirk.auxiliary.print_inheritance_tree
```
````

````{py:exception} PyIRKException()
:canonical: pyirk.auxiliary.PyIRKException

Bases: {py:obj}`Exception`

```{autodoc2-docstring} pyirk.auxiliary.PyIRKException
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.auxiliary.PyIRKException.__init__
```

````

```{py:exception} GeneralPyIRKError()
:canonical: pyirk.auxiliary.GeneralPyIRKError

Bases: {py:obj}`Exception`

```

```{py:exception} MultilingualityError()
:canonical: pyirk.auxiliary.MultilingualityError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} EmptyURIStackError()
:canonical: pyirk.auxiliary.EmptyURIStackError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} UnknownPrefixError()
:canonical: pyirk.auxiliary.UnknownPrefixError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} UnknownURIError()
:canonical: pyirk.auxiliary.UnknownURIError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} InvalidURIError()
:canonical: pyirk.auxiliary.InvalidURIError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} InvalidPrefixError()
:canonical: pyirk.auxiliary.InvalidPrefixError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} InvalidShortKeyError()
:canonical: pyirk.auxiliary.InvalidShortKeyError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} InvalidGeneralKeyError()
:canonical: pyirk.auxiliary.InvalidGeneralKeyError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} InconsistentLabelError()
:canonical: pyirk.auxiliary.InconsistentLabelError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} ShortKeyNotFoundError()
:canonical: pyirk.auxiliary.ShortKeyNotFoundError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} InvalidScopeNameError()
:canonical: pyirk.auxiliary.InvalidScopeNameError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} InvalidScopeTypeError()
:canonical: pyirk.auxiliary.InvalidScopeTypeError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} ModuleAlreadyLoadedError()
:canonical: pyirk.auxiliary.ModuleAlreadyLoadedError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} SemanticRuleError()
:canonical: pyirk.auxiliary.SemanticRuleError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} ExplicitlyTriggeredTestException()
:canonical: pyirk.auxiliary.ExplicitlyTriggeredTestException

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} InconsistentEdgeRelations()
:canonical: pyirk.auxiliary.InconsistentEdgeRelations

Bases: {py:obj}`pyirk.auxiliary.SemanticRuleError`

```

```{py:exception} InvalidObjectValue()
:canonical: pyirk.auxiliary.InvalidObjectValue

Bases: {py:obj}`pyirk.auxiliary.SemanticRuleError`

```

```{py:exception} MissingQualifierError()
:canonical: pyirk.auxiliary.MissingQualifierError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} AmbiguousQualifierError()
:canonical: pyirk.auxiliary.AmbiguousQualifierError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} FunctionalRelationError()
:canonical: pyirk.auxiliary.FunctionalRelationError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} UndefinedRelationError()
:canonical: pyirk.auxiliary.UndefinedRelationError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} TaxonomicError()
:canonical: pyirk.auxiliary.TaxonomicError

Bases: {py:obj}`pyirk.auxiliary.GeneralPyIRKError`

```

```{py:exception} RuleTermination()
:canonical: pyirk.auxiliary.RuleTermination

Bases: {py:obj}`pyirk.auxiliary.PyIRKException`

```

```{py:exception} LogicalContradiction()
:canonical: pyirk.auxiliary.LogicalContradiction

Bases: {py:obj}`pyirk.auxiliary.RuleTermination`

```

```{py:exception} ReasoningGoalReached()
:canonical: pyirk.auxiliary.ReasoningGoalReached

Bases: {py:obj}`pyirk.auxiliary.RuleTermination`

```

````{py:exception} ContinueOuterLoop()
:canonical: pyirk.auxiliary.ContinueOuterLoop

Bases: {py:obj}`pyirk.auxiliary.PyIRKException`

```{autodoc2-docstring} pyirk.auxiliary.ContinueOuterLoop
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk.auxiliary.ContinueOuterLoop.__init__
```

````

````{py:function} ensure_valid_short_key(txt: str, strict: bool = True) -> bool
:canonical: pyirk.auxiliary.ensure_valid_short_key

```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_short_key
```
````

````{py:function} ensure_valid_uri(txt: str, strict: bool = True) -> bool
:canonical: pyirk.auxiliary.ensure_valid_uri

```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_uri
```
````

````{py:function} ensure_valid_relation_uri(txt: str, strict=True)
:canonical: pyirk.auxiliary.ensure_valid_relation_uri

```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_relation_uri
```
````

````{py:function} ensure_valid_item_uri(txt: str, strict=True)
:canonical: pyirk.auxiliary.ensure_valid_item_uri

```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_item_uri
```
````

````{py:function} ensure_valid_prefix(txt: str, strict: bool = True) -> bool
:canonical: pyirk.auxiliary.ensure_valid_prefix

```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_prefix
```
````

````{py:function} parse_uri(txt: str) -> addict.Addict
:canonical: pyirk.auxiliary.parse_uri

```{autodoc2-docstring} pyirk.auxiliary.parse_uri
```
````

````{py:function} ensure_valid_baseuri(txt: str, strict: bool = True) -> bool
:canonical: pyirk.auxiliary.ensure_valid_baseuri

```{autodoc2-docstring} pyirk.auxiliary.ensure_valid_baseuri
```
````

````{py:function} make_uri(base_uri: str, short_key)
:canonical: pyirk.auxiliary.make_uri

```{autodoc2-docstring} pyirk.auxiliary.make_uri
```
````

````{py:function} convert_key_str_to_num(key_str: str) -> int
:canonical: pyirk.auxiliary.convert_key_str_to_num

```{autodoc2-docstring} pyirk.auxiliary.convert_key_str_to_num
```
````

````{py:function} clean_dict(dikt: typing.Dict[typing.Any, typing.Union[list, dict]]) -> typing.Dict[typing.Any, typing.Union[list, dict]]
:canonical: pyirk.auxiliary.clean_dict

```{autodoc2-docstring} pyirk.auxiliary.clean_dict
```
````

````{py:function} uri_set(*args)
:canonical: pyirk.auxiliary.uri_set

```{autodoc2-docstring} pyirk.auxiliary.uri_set
```
````

````{py:function} bright(txt)
:canonical: pyirk.auxiliary.bright

```{autodoc2-docstring} pyirk.auxiliary.bright
```
````

````{py:function} bblue(txt)
:canonical: pyirk.auxiliary.bblue

```{autodoc2-docstring} pyirk.auxiliary.bblue
```
````

````{py:function} bcyan(txt)
:canonical: pyirk.auxiliary.bcyan

```{autodoc2-docstring} pyirk.auxiliary.bcyan
```
````

````{py:function} bmagenta(txt)
:canonical: pyirk.auxiliary.bmagenta

```{autodoc2-docstring} pyirk.auxiliary.bmagenta
```
````

````{py:function} bgreen(txt)
:canonical: pyirk.auxiliary.bgreen

```{autodoc2-docstring} pyirk.auxiliary.bgreen
```
````

````{py:function} bred(txt)
:canonical: pyirk.auxiliary.bred

```{autodoc2-docstring} pyirk.auxiliary.bred
```
````

````{py:function} byellow(txt)
:canonical: pyirk.auxiliary.byellow

```{autodoc2-docstring} pyirk.auxiliary.byellow
```
````

````{py:function} get_irk_root_dir() -> str
:canonical: pyirk.auxiliary.get_irk_root_dir

```{autodoc2-docstring} pyirk.auxiliary.get_irk_root_dir
```
````

````{py:function} get_irk_path(dirname=None)
:canonical: pyirk.auxiliary.get_irk_path

```{autodoc2-docstring} pyirk.auxiliary.get_irk_path
```
````

````{py:function} _handle_exception(e: Exception, msg)
:canonical: pyirk.auxiliary._handle_exception

```{autodoc2-docstring} pyirk.auxiliary._handle_exception
```
````

````{py:function} load_module_configs_from_general_config()
:canonical: pyirk.auxiliary.load_module_configs_from_general_config

```{autodoc2-docstring} pyirk.auxiliary.load_module_configs_from_general_config
```
````

````{py:function} _extract_uri_from_python_file(fpath)
:canonical: pyirk.auxiliary._extract_uri_from_python_file

```{autodoc2-docstring} pyirk.auxiliary._extract_uri_from_python_file
```
````

````{py:function} get_initial_config_content_for_ci() -> str
:canonical: pyirk.auxiliary.get_initial_config_content_for_ci

```{autodoc2-docstring} pyirk.auxiliary.get_initial_config_content_for_ci
```
````