:mod:`lookout.core.helpers.server`
==================================

.. py:module:: lookout.core.helpers.server

.. autoapi-nested-parse::

   Utils to work with lookout-sdk binary.










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






.. py:class:: LookoutSDK

   Wrapper class for `lookout-sdk` executable.

   Allows you to query analyzers the same way lookout server do.
   About lookout-sdk read https://github.com/src-d/lookout-sdk


   

   

   

   

   .. attribute:: version
      

      



   

   

   

   .. method:: fetch(self)

      
      Download the lookout-sdk executable from GitHub Releases.

      



   

   .. method:: push(self, fr:str, to:str, port:int, *, git_dir:str, bblfsh:Optional[str]=None, log_level:Optional[str]=None, config_json:Optional[dict]=None)

      
      Provide a simple data server and triggers an analyzer push event.

      :param fr: Corresponds to --from flag.
      :param to: Corresponds to --to flag.
      :param port: Running analyzer port on localhost.
      :param git_dir: Corresponds to --git-dir flag.
      :param log_level: Corresponds to --log-level flag.
      :param bblfsh: Corresponds to --bblfshd flag.
      :param config_json: Corresponds to --config-json flag.
      :return: CompletedProcess with return code.

      



   

   .. method:: review(self, fr:str, to:str, port:int, *, git_dir:str, bblfsh:Optional[str]=None, log_level:Optional[str]=None, config_json:Optional[dict]=None)

      
      Provide a simple data server and triggers an analyzer review event.

      :param fr: Corresponds to --from flag.
      :param to: Corresponds to --to flag.
      :param port: Running analyzer port on localhost.
      :param git_dir: Corresponds to --git-dir flag.
      :param log_level: Corresponds to --log-level flag.
      :param bblfsh: Corresponds to --bblfshd flag.
      :param config_json: Corresponds to --config-json flag.
      :return: CompletedProcess with return code.

      



   









.. function:: check_port_free(port:int)

   
   Check if the port is not taken on localhost.

   :param port: Port number.
   :return: True if available else False.

   









.. function:: find_port(attempts:int=100)

   
   Find a free port on localhost.

   :param attempts: Number of random search attempts.
   :return: Found free port number.