testsuite.report.display
========================

.. py:module:: testsuite.report.display


Attributes
----------

.. autoapisummary::

   testsuite.report.display.args_parser
   testsuite.report.display.KeyType


Classes
-------

.. autoapisummary::

   testsuite.report.display.SupportsLessThan


Functions
---------

.. autoapisummary::

   testsuite.report.display.sorted_counters
   testsuite.report.display.summary_line
   testsuite.report.display.format_result_logs
   testsuite.report.display.generate_report
   testsuite.report.display.main


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

.. py:data:: args_parser

.. py:class:: SupportsLessThan

   Bases: :py:obj:`Protocol`


   Base class for protocol classes.

   Protocol classes are defined as::

       class Proto(Protocol):
           def meth(self) -> int:
               ...

   Such classes are primarily used with static type checkers that recognize
   structural subtyping (static duck-typing).

   For example::

       class C:
           def meth(self) -> int:
               return 0

       def func(x: Proto) -> int:
           return x.meth()

       func(C())  # Passes static type check

   See PEP 544 for details. Protocol classes decorated with
   @typing.runtime_checkable act as simple-minded runtime protocols that check
   only the presence of given attributes, ignoring their type signatures.
   Protocol classes can be generic, they are defined as::

       class GenProto(Protocol[T]):
           def meth(self) -> T:
               ...


   .. py:method:: __lt__(other: SupportsLessThan) -> bool


.. py:data:: KeyType

.. py:function:: sorted_counters(counters: Dict[KeyType, int], key: Callable[[KeyType], SupportsLessThan]) -> List[Tuple[KeyType, int]]

   Filter out the set of null counters and sort them.


.. py:function:: summary_line(result: e3.testsuite.result.TestResultSummary, colors: e3.testsuite.utils.ColorConfig, show_time_info: bool) -> str

   Format a summary line to describe the ``result`` test result.

   :param colors: Proxy to introduce (or not) colors in the result.
   :param show_time_info: Whether to include timing information in the result.


.. py:function:: format_result_logs(result: e3.testsuite.result.TestResult, colors: e3.testsuite.utils.ColorConfig, show_error_output: bool, show_time_info: bool) -> List[str]

   Return a human readable description for the ``result`` test result.

   :param colors: Proxy to introduce (or not) colors in the result.
   :param show_error_output: Whether to include the logs themselves: if False,
       only show the test name, status, message and timing info if requested.
   :param show_time_info: Whether to include timing information in the result.


.. py:function:: generate_report(output_file: IO[str], new_index: e3.testsuite.report.index.ReportIndex, old_index: Optional[e3.testsuite.report.index.ReportIndex], colors: e3.testsuite.utils.ColorConfig, show_all_logs: bool, show_xfail_logs: bool, show_error_output: bool, show_time_info: bool) -> None

   Generate a text report for testsuite results.

   :param output_file: Output file for the report.
   :param new_index: Testsuite results to display.
   :param old_index: Results from a previous testsuite run. If present, used
       to compute the new/already-detected/fixed regressions.
   :param colors: Color configuration for the output.
   :param show_all_logs: Whether to display logs for all testcases (successful
       tests are not displayed by default).
   :param show_xfail_logs: Whether to display logs for XFAIL results (hidden
       by default).
   :param show_error_output: Whether to display logs in test results.
   :param show_time_info: Whether to display time information for test
       results, if available.


.. py:function:: main(argv: Optional[List[str]] = None) -> int