Utility methods
===============

Aiviro utility are additional constants, methods and classes which can be used as arguments for Search Objects or are return values in Robot's methods.

aiviro.Area
-----------

.. autoclass:: aiviro.Area

.. autoclass:: aiviro.BoundBox


aiviro.find_method
------------------

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


aiviro.table_anchor
-------------------

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


aiviro.layout_anchor
--------------------

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


aiviro.layout_positions
-----------------------

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


aiviro.layout_comparison_mode
-----------------------------

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


aiviro.scroll_option
--------------------

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


aiviro.boundary_type
--------------------------

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


aiviro.working_area_limit
-------------------------

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


aiviro.key
----------

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


aiviro.init_logging
-------------------

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


aiviro.log_prefect_markdown_text
--------------------------------

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


aiviro.Secret
-------------

.. autoclass:: aiviro.core.utils.secret.Secret


aiviro.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


aiviro.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.utils_constants
    :members: AIVIRO_DEBUG_KEY, AIVIRO_DEBUG_VALUE, IS_RUNNING_IN_PREFECT, SCENARIO_CONFIG_FOLDER_KEY, SCENARIO_CONFIG_FOLDER_PATH