coalib.bearlib.abstractions.CorrectionBasedBear

Complexity

Total Complexity

13

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

5 Methods

Rating	Name	Duplication	Size	Complexity
A	retrieve_results()	0	20	2
A	__yield_diffs()	0	7	3
A	__run_process()	0	18	1
A	__print_errors()	0	3	3
A	check_prerequisites()	0	11	3

from subprocess import Popen, PIPE

from coalib.bears.LocalBear import LocalBear
from coalib.results.Diff import Diff
from coalib.results.RESULT_SEVERITY import RESULT_SEVERITY
from coalib.results.Result import Result


class CorrectionBasedBear(LocalBear):
    SEVERITY = RESULT_SEVERITY.NORMAL
    GET_REPLACEMENT = (lambda self, file, cli_options:
                       self.__run_process(file, cli_options))

    def __run_process(self, file, cli_options):
        process = Popen(self.BINARY + ' ' + cli_options,
                        shell=True,
                        stdin=PIPE,
                        stdout=PIPE,
                        stderr=PIPE,
                        universal_newlines=True)
        process.stdin.writelines(file)
        process.stdin.close()
        process.wait()

        corrected = process.stdout.readlines()
        errors = process.stderr.readlines()

        process.stdout.close()
        process.stderr.close()

        return corrected, errors

    @staticmethod
    def __yield_diffs(file, new_file):
        if new_file != file:
            wholediff = Diff.from_string_arrays(file, new_file)

            for diff in wholediff.split_diff():
                yield diff

    def __print_errors(self, errors):
        for line in filter(lambda error: bool(error.strip()), errors):
            self.warn(line)

    def retrieve_results(self, filename, file, **kwargs):
        """
        Yields results using the self.GET_REPLACEMENT function.

        :param filename: The filename, just pass it over as you got it!
        :param file:     The file, just pass it over as you got it!
        :param kwargs:   Any keyword arguments that will be passed to the
                         GET_REPLACEMENT function. Please provide cli_options
                         if you don't override the default.
        """
        new_file, errors = self.GET_REPLACEMENT(file=file, **kwargs)
        self.__print_errors(errors)

        for diff in self.__yield_diffs(file, new_file):
            yield Result(
                self,
                self.RESULT_MESSAGE,
                affected_code=(diff.range(filename),),
                diffs={filename: diff},
                severity=self.SEVERITY)

    @classmethod
    def check_prerequisites(cls):
        try:
            bin_args = getattr(cls, "BINARY_CHECK_ARGUMENTS", "--version")
            Popen([cls.BINARY, bin_args], stdout=PIPE, stderr=PIPE)
            return True
        except OSError:
            return repr(cls.BINARY) + " is not installed."
        except AttributeError:
            # Happens when `BINARY` does not exist in `cls`.
            return True