suricata_check.checkers.styleguide.whitespace
=============================================

.. py:module:: suricata_check.checkers.styleguide.whitespace

.. autoapi-nested-parse::

   `WhitespaceChecker`.



Classes
-------

.. autoapisummary::

   suricata_check.checkers.styleguide.whitespace.WhitespaceChecker


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

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

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


   The `WhitespaceChecker` contains several checks based on the Suricata Style guide relating to formatting rules.

   Codes S100-S109 report on unneccessary whitespace that should be removed.

   Codes S110-S119 report on missing whitespace that should be added.

   Codes S120-S129 report on non-standard escaping of special characters.

   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