suricata_check.checkers.styleguide.overall
==========================================

.. py:module:: suricata_check.checkers.styleguide.overall

.. autoapi-nested-parse::

   `OverallChecker`.



Classes
-------

.. autoapisummary::

   suricata_check.checkers.styleguide.overall.OverallChecker


Module Contents
---------------

.. py:class:: OverallChecker(include: Optional[collections.abc.Iterable[str]] = None)

   Bases: :py:obj:`suricata_check.checkers.interface.CheckerInterface`


   The `OverallChecker` contains several the most basic checks for Suricata rules.

   Codes S000-S009 report on issues with the direction of the rule.

   Codes S010-S019 report on issues pertaining to the usage of non-standard options.

   Codes S020-S029 report on issues pertaining to the non-usage of recommended options.

   Codes S020-S029 report on issues pertaining to the non-usage of recommended options.

   Codes S031-S039 report on issues pertaining to the inappropriate usage of options.

   Initializes the checker given a list of issue codes to emit.


   .. py:attribute:: codes

      A Mapping of issue codes emitted by the checker to metadata for those issue types.
      The metadata is structured in the form of a Mapping from attribute name to attribute value.
      The one mandatory metadata attribute is severity, which must be one of the levels provided by the `logging` module