lookout.core.helpers.server

Utils to work with lookout-sdk binary.

Module Contents

class lookout.core.helpers.server.LookoutSDK[source]

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

version
fetch(self)[source]

Download the lookout-sdk executable from GitHub Releases.

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)[source]

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

Parameters:
  • fr – Corresponds to –from flag.
  • to – Corresponds to –to flag.
  • port – Running analyzer port on localhost.
  • git_dir – Corresponds to –git-dir flag.
  • log_level – Corresponds to –log-level flag.
  • bblfsh – Corresponds to –bblfshd flag.
  • config_json – Corresponds to –config-json flag.
Returns:

CompletedProcess with return code.
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)[source]

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

Parameters:
  • fr – Corresponds to –from flag.
  • to – Corresponds to –to flag.
  • port – Running analyzer port on localhost.
  • git_dir – Corresponds to –git-dir flag.
  • log_level – Corresponds to –log-level flag.
  • bblfsh – Corresponds to –bblfshd flag.
  • config_json – Corresponds to –config-json flag.
Returns:

CompletedProcess with return code.
lookout.core.helpers.server.check_port_free(port:int)[source]

Check if the port is not taken on localhost.

Parameters:port – Port number.
Returns:True if available else False.
lookout.core.helpers.server.find_port(attempts:int=100)[source]

Find a free port on localhost.

Parameters:attempts – Number of random search attempts.
Returns:Found free port number.