Source code for statick_tool.plugins.tool.black

"""Apply black tool and gather results."""

import logging
import re
import subprocess
from typing import Match, Optional, Pattern

from statick_tool.issue import Issue
from statick_tool.package import Package
from statick_tool.tool_plugin import ToolPlugin




class BlackToolPlugin(ToolPlugin):
    """Apply black tool and gather results."""



    def get_name(self) -> str:
        """Get name of tool.

        Returns:
            Name of the tool.
        """
        return "black"




    def get_file_types(self) -> list[str]:
        """Return a list of file types the plugin can scan.

        Returns:
            List of file types.
        """
        return ["python_src"]




    def process_files(
        self, package: Package, level: str, files: list[str], user_flags: list[str]
    ) -> Optional[list[str]]:
        """Run tool and gather output.

        Args:
            package: The package to process.
            level: The level to run the tool at.
            files: List of files to process.
            user_flags: List of user flags.

        Returns:
            List of output strings or None.
        """
        flags: list[str] = ["--check"]
        flags += user_flags

        total_output: list[str] = []

        tool_bin = self.get_binary()
        try:
            subproc_args = [tool_bin] + flags + files
            output = subprocess.check_output(
                subproc_args, stderr=subprocess.STDOUT, universal_newlines=True
            )

        except subprocess.CalledProcessError as ex:
            # Return code 123 means there was an internal error
            if ex.returncode == 123:
                logging.warning("Black encountered internal error")
                logging.warning("black exception: %s", ex.output)

            # Return code 1 just means "found problems"
            elif ex.returncode != 1:
                logging.warning("Problem %d", ex.returncode)
                logging.warning("%s exception: %s", self.get_name(), ex.output)
                return None

            output = ex.output

        except OSError as ex:
            logging.info("Couldn't find %s! (%s)", tool_bin, ex)
            return None

        total_output.append(output)

        logging.debug("%s", total_output)

        return total_output




    def parse_output(
        self, total_output: list[str], package: Optional[Package] = None
    ) -> list[Issue]:
        """Parse tool output and report issues.

        Args:
            total_output: List of output strings.
            package: The package being processed.

        Returns:
            List of issues found.
        """
        tool_re_reformat = r"(.+)\s(.+)\s(.+)"
        parse_reformat: Pattern[str] = re.compile(tool_re_reformat)

        # example output for this regex:
        # error: cannot format /home/user/file: INTERNAL ERROR: message
        tool_re_error = r"\w+:\s(.+):\s(.+):\s(.+):\s(.+)"
        parse_tool_error: Pattern[str] = re.compile(tool_re_error)

        # example output for this regex:
        # error: cannot format /home/user/file: Cannot parse: 1:3: {faulty_line}
        tool_re_parse_error = r"\w+:\s(.+):\s(.+):\s([0-9]+):([0-9]+):\s(.+)"
        parse_error: Pattern[str] = re.compile(tool_re_parse_error)
        issues: list[Issue] = []

        for output in total_output:
            for line in output.splitlines():
                if line.startswith("would reformat"):
                    match: Optional[Match[str]] = parse_reformat.match(line)
                    if match:
                        issues.append(
                            Issue(
                                match.group(3),
                                0,
                                self.get_name(),
                                "format",
                                3,
                                "would reformat",
                                None,
                            )
                        )
                if line.startswith("error"):
                    match_tool_error: Optional[Match[str]] = parse_tool_error.match(
                        line
                    )
                    match_parse_error: Optional[Match[str]] = parse_error.match(line)
                    if match_parse_error:
                        issues.append(
                            Issue(
                                match_parse_error.group(1).split(" ")[2].rstrip(":"),
                                int(match_parse_error.group(3)),
                                self.get_name(),
                                "format",
                                3,
                                match_parse_error.group(2)
                                + " "
                                + match_parse_error.group(5),
                                None,
                            )
                        )
                    elif match_tool_error:
                        issues.append(
                            Issue(
                                match_tool_error.group(1).split(" ")[2].rstrip(":"),
                                0,
                                self.get_name(),
                                "format",
                                3,
                                match_tool_error.group(3),
                                None,
                            )
                        )

        return issues