waive
=====

.. py:module:: waive

.. autoapi-nested-parse::

   Functionality for an automatic failure waiving logic, configured by
   a custom file format. See WAIVERS.md.









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

.. py:class:: WaiverSection

   Bases: :py:obj:`tuple`


   .. py:attribute:: regexes


   .. py:attribute:: python_code


   .. py:attribute:: python_source


.. py:exception:: WaiveParseError(filedesc, msg)

   Bases: :py:obj:`SyntaxError`


   Easy waiver file syntax error reporting, with line numbers derived
   from _PushbackIterator style counter.


.. py:function:: collect_waivers()

   Recursively walk a directory of waiver files/directories,
   yielding waiver sections.


.. py:class:: Match(matches, *, strict=False)

   A True/False result with additional metadata, returned from
   custom waiving format and its python code blocks.

   Use 'strict=True' to fail when the waiver matches on 'pass'.


   .. py:attribute:: matches


   .. py:attribute:: strict
      :value: False



.. py:function:: match_result(status, name, note)

.. py:function:: rewrite_result(status, name, note, new_status='warn')