:mod:`lookout.style.format.utils`
=================================

.. py:module:: lookout.style.format.utils

.. autoapi-nested-parse::

   Commonly used utils.










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






.. py:class:: FakeDataStub(files:Iterable[File])

   Fake data source.


   

   

   

   .. method:: GetFiles(self, _)

      
      Return sequence of files.

      :param _: noop.
      :return: sequence of files.

      











.. function:: generate_comment(filename:str, confidence:int, line:int, text:str)

   
   Generate comment.

   :param filename: filename.
   :param confidence: confidence of comment. Should be in range [0, 100].
   :param line: line number for comment. Expecting 1-based indexing. If 0 - comment for the whole
                file.
   :param text: comment text.
   :return: generated comment.

   









.. function:: get_classification_report(y_pred:numpy.ndarray, y_true:numpy.ndarray, target_names:Sequence[str])

   
   Colllect the main information that is needed for quality report generation.

   :param y_pred: predicted target values.
   :param y_true: true targets.
   :param target_names: labels to names mapping.
   :return: Dictionary with the report information inside.