Utilities APIs
==============

Avocado gives to you more than 40 python utility libraries (so far), that can
be found under the :mod:`avocado.utils`. You can use these libraries to avoid
having to write necessary routines for your tests. These are very general in
nature and can help you speed up your test development.

The utility libraries may receive incompatible changes across minor versions,
but these will be done in a staged fashion. If a given change to an utility
library can cause test breakage, it will first be documented and/or deprecated,
and only on the next subsequent minor version, it will actually be changed.

What this means is that upon updating to later minor versions of Avocado, you
should look at the Avocado Release Notes for changes that may impact your
tests.

This is a set of utility APIs that Avocado provides as added value to test
writers. It's suppose to be generic, without any knowledge of Avocado and
reusable in different projects.


Subpackages
-----------

.. toctree::
   :maxdepth: 4

   avocado.utils.external
   avocado.utils.network
   avocado.utils.software_manager

Submodules
----------

avocado.utils.ar module
-----------------------

.. automodule:: avocado.utils.ar
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.archive module
----------------------------

.. automodule:: avocado.utils.archive
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.asset module
--------------------------

.. automodule:: avocado.utils.asset
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.astring module
----------------------------

.. automodule:: avocado.utils.astring
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.aurl module
-------------------------

.. automodule:: avocado.utils.aurl
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.build module
--------------------------

.. automodule:: avocado.utils.build
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.cloudinit module
------------------------------

.. automodule:: avocado.utils.cloudinit
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.cpu module
------------------------

.. automodule:: avocado.utils.cpu
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.crypto module
---------------------------

.. automodule:: avocado.utils.crypto
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.data\_factory module
----------------------------------

.. automodule:: avocado.utils.data_factory
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.data\_structures module
-------------------------------------

.. automodule:: avocado.utils.data_structures
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.datadrainer module
--------------------------------

.. automodule:: avocado.utils.datadrainer
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.debug module
--------------------------

.. automodule:: avocado.utils.debug
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.diff\_validator module
------------------------------------

.. automodule:: avocado.utils.diff_validator
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.disk module
-------------------------

.. automodule:: avocado.utils.disk
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.distro module
---------------------------

.. automodule:: avocado.utils.distro
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.dmesg module
--------------------------

.. automodule:: avocado.utils.dmesg
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.download module
-----------------------------

.. automodule:: avocado.utils.download
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.exit\_codes module
--------------------------------

.. automodule:: avocado.utils.exit_codes
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.file\_utils module
--------------------------------

.. automodule:: avocado.utils.file_utils
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.filelock module
-----------------------------

.. automodule:: avocado.utils.filelock
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.gdb module
------------------------

.. automodule:: avocado.utils.gdb
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.genio module
--------------------------

.. automodule:: avocado.utils.genio
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.git module
------------------------

.. automodule:: avocado.utils.git
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.iso9660 module
----------------------------

.. automodule:: avocado.utils.iso9660
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.kernel module
---------------------------

.. automodule:: avocado.utils.kernel
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.linux module
--------------------------

.. automodule:: avocado.utils.linux
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.linux\_modules module
-----------------------------------

.. automodule:: avocado.utils.linux_modules
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.lv\_utils module
------------------------------

.. automodule:: avocado.utils.lv_utils
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.memory module
---------------------------

.. automodule:: avocado.utils.memory
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.multipath module
------------------------------

.. automodule:: avocado.utils.multipath
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.nvme module
-------------------------

.. automodule:: avocado.utils.nvme
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.output module
---------------------------

.. automodule:: avocado.utils.output
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.partition module
------------------------------

.. automodule:: avocado.utils.partition
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.path module
-------------------------

.. automodule:: avocado.utils.path
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.pci module
------------------------

.. automodule:: avocado.utils.pci
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.pmem module
-------------------------

.. automodule:: avocado.utils.pmem
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.podman module
---------------------------

.. automodule:: avocado.utils.podman
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.process module
----------------------------

.. automodule:: avocado.utils.process
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.script module
---------------------------

.. automodule:: avocado.utils.script
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.service module
----------------------------

.. automodule:: avocado.utils.service
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.softwareraid module
---------------------------------

.. automodule:: avocado.utils.softwareraid
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.ssh module
------------------------

.. automodule:: avocado.utils.ssh
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.stacktrace module
-------------------------------

.. automodule:: avocado.utils.stacktrace
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.sysinfo module
----------------------------

.. automodule:: avocado.utils.sysinfo
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.vmimage module
----------------------------

.. automodule:: avocado.utils.vmimage
   :members:
   :undoc-members:
   :show-inheritance:

avocado.utils.wait module
-------------------------

.. automodule:: avocado.utils.wait
   :members:
   :undoc-members:
   :show-inheritance:

Module contents
---------------

.. automodule:: avocado.utils
   :members:
   :undoc-members:
   :show-inheritance: