suricata_check.utils
====================

.. py:module:: suricata_check.utils

.. autoapi-nested-parse::

   The `suricata_check.utils` module contains several utilities for the suricata-check main program and the checkers.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/suricata_check/utils/checker/index
   /autoapi/suricata_check/utils/checker_typing/index
   /autoapi/suricata_check/utils/regex/index


Classes
-------

.. autoapisummary::

   suricata_check.utils.ClickHandler


Functions
---------

.. autoapisummary::

   suricata_check.utils.find_rules_file


Package Contents
----------------

.. py:class:: ClickHandler(level: int = 0, github: bool = False, github_level: int = logging.WARNING, **kwargs: dict)

   Bases: :py:obj:`logging.Handler`


   Handler to color and write logging messages for the click module.

   Initializes the instance - basically setting the formatter to None
   and the filter list to empty.


   .. py:method:: emit(record: logging.LogRecord) -> None

      Log the record via click stdout with appropriate colors.



.. py:function:: find_rules_file(root: str) -> str

   Find the Suricata rules file in the given directory.