Aiviro Utilities
================

The section is a hub for essential tools like constants, methods, and classes.
It's sorted into different categories, each handling specific tasks like spatial objects, logging, parameter controls, constants, keyboard and exceptions.
These tools are vital for different functions within the Aiviro package.

Area & Text
-----------

.. autoclass:: aiviro.Area

.. autoclass:: aiviro.BoundBox

.. autoclass:: aiviro.Secret


Logging
-------
All logging methods can be accessed by ``aiviro.*`` notation.

.. automethod:: aiviro.core.utils.logging.init_logging

.. automethod:: aiviro.core.utils.logging.stop_logging

.. automethod:: aiviro.core.utils.logging.get_logger

.. automethod:: aiviro.core.utils.logging.get_logger_advanced

.. automethod:: aiviro.core.utils.logging.disable_logger

.. automethod:: aiviro.core.utils.logging.log_prefect_markdown_text


Control Parameters
------------------

.. autoclass:: aiviro.core.constants.ui_constants.FindMethod
    :members:

.. autoclass:: aiviro.core.utils.search_objects.TableAnchor
    :members:

.. autoclass:: aiviro.core.constants.ui_constants.LayoutAnchor
    :members:

.. autoclass:: aiviro.core.constants.ui_constants.LayoutPositions
    :members:

.. autoclass:: aiviro.core.constants.ui_constants.LayoutComparisonMode
    :members:

.. autoclass:: aiviro.core.constants.ui_constants.ScrollOption
    :members:

.. autoclass:: aiviro.core.constants.ui_constants.BoundaryType
    :members:

.. autoclass:: aiviro.core.constants.ui_constants.WorkingAreaLimit
    :members:


Constants
---------
Every constant can be access by ``aiviro.*`` notation.

.. code-block:: python

    >>> import aiviro
    >>> DB_NAME = "production" if aiviro.AIVIRO_DEBUG_VALUE else "testing"

.. automodule:: aiviro.core.constants.environment_constants
    :members: AIVIRO_DEBUG_KEY, AIVIRO_DEBUG_VALUE, IS_RUNNING_IN_PREFECT, SCENARIO_CONFIG_FOLDER_KEY, SCENARIO_CONFIG_FOLDER_PATH

.. automodule:: aiviro.core.utils.locale
    :members: LOCALE_KEY, LOCALE_VALUE


Keyboard
--------

.. autoclass:: aiviro.core.services.device.keyboard.BaseKey
    :members:


Exceptions
----------
Every exception can be access by ``aiviro.*Error`` notation.

.. code-block:: python

    >>> import aiviro
    >>> try:
    ...     # some code
    >>> except aiviro.CheckCommandError:
    ...     # process exception

.. automodule:: aiviro.core.utils.exceptions
    :members: SearchObjectError, CheckCommandError, TooManyElementsError, ElementIndexError,
        ReferenceElementError, AndElementError, BoundaryElementError, WorkingAreaError,
        ScreenNotStableError, ScrollEndException, ImageNotSetError