pylint_score.py

# Pyflow an open-source tool for modular visual programing in python
# Copyright (C) 2021-2022 Bycelium <https://www.gnu.org/licenses/>

""" Module to get pylint score."""

import sys
import html
from pylint.interfaces import IReporter
from pylint.reporters import *
from pylint.lint import Run
from utils import score_to_rgb_color


class MyReporterClass(BaseReporter):
    """Report messages and layouts."""

    __implements__ = IReporter
    name = "myreporter"
    extension = "myreporter"

    def __init__(self, output=sys.stdout):
        BaseReporter.__init__(self, output)
        self.messages = []

    def handle_message(self, msg):
        """Manage message of different type and in the context of path."""
        self.messages.append(
            {
                "type": msg.category,
                "module": msg.module,
                "obj": msg.obj,
                "line": msg.line,
                "column": msg.column,
                "path": msg.path,
                "symbol": msg.symbol,
                "message": html.escape(msg.msg or "", quote=False),
                "message-id": msg.msg_id,
            }
        )

    def display_messages(self, layout):
        """Do nothing."""

    def display_reports(self, layout):
        """Do nothing."""

    def _display(self, layout):
        """Do nothing."""


def register(linter):
    """Register the reporter classes with the linter."""
    linter.register_reporter(MyReporterClass)


if __name__ == "__main__":
    options = ["pyflow", "--output-format=pylint_score.MyReporterClass"]
    results = Run(options, exit=False)
    score = results.linter.stats.global_note
    score_min = 8.0
    score_max = 10
    if sys.argv[1] == "--score":
        print(f"{score:.2f}")
        if score < score_min or score > score_max:
            raise Exception(
                f"Insufficient score with pylint: {score:.2f}<{score_min:.2f}"
            )
    elif sys.argv[1] == "--color":
        print(score_to_rgb_color(score, score_min=score_min, score_max=score_max))
    else:
        raise ValueError(f"Unknowed argument: {sys.argv[1]}")