:py:mod:`pytest_flakefighters.main`
===================================

.. py:module:: pytest_flakefighters.main

.. autoapi-nested-parse::

   This module adds all the FlakeFighter configuration options to pytest.



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


Functions
~~~~~~~~~

.. autoapisummary::

   pytest_flakefighters.main.rerun_strategy
   pytest_flakefighters.main.pytest_addoption
   pytest_flakefighters.main.get_config_value
   pytest_flakefighters.main.setup_flakefighter_configs
   pytest_flakefighters.main.pytest_configure



Attributes
~~~~~~~~~~

.. autoapisummary::

   pytest_flakefighters.main.rerun_strategies
   pytest_flakefighters.main.logger


.. py:data:: rerun_strategies

   

.. py:data:: logger

   

.. py:function:: rerun_strategy(strategy: str, max_reruns: int, **kwargs)

   Instantiate the selected rerun strategy.


.. py:function:: pytest_addoption(parser: pytest.Parser)

   Add extra pytest options.
   :param parser: The argument parser.


.. py:function:: get_config_value(config, name)

   Get the configuration value.
   Options specified on the commandline will override those specified in configuration files.
   If neither is specified, the default value specified in `options.py` will be used.


.. py:function:: setup_flakefighter_configs(flakefighter_configs: Any)

   Parse the flakefighter configurations from string, or initialise to empty if None.
   :param flakefighter_configs: The flakefighter config object.


.. py:function:: pytest_configure(config: pytest.Config)

   Initialise the FlakeFighterPlugin class.
   :param config: The config options.