coala-analyzer / coala

coalib/results/Result.py

import uuid
from os.path import relpath

from coalib.misc.Decorators import (
    enforce_signature, generate_ordering, generate_repr, get_public_members)
from coalib.results.RESULT_SEVERITY import RESULT_SEVERITY
from coalib.results.SourceRange import SourceRange


# Omit additional info, debug message and diffs for brevity
@generate_repr(("id", hex),

The variable hex does not seem to be defined.

               "origin",
               "affected_code",
               ("severity", RESULT_SEVERITY.reverse.get),

The variable RESULT_SEVERITY does not seem to be defined.

               "message")
@generate_ordering("affected_code",
                   "severity",
                   "origin",
                   "message",
                   "additional_info",
                   "debug_msg",
                   "diffs")
class Result:
    """
    A result is anything that has an origin and a message.

    Optionally it might affect a file.
    """

    @enforce_signature

The variable enforce_signature does not seem to be defined.

    def __init__(self,
                 origin,
                 message: str,

The variable str does not seem to be defined.

                 affected_code: (tuple, list)=(),

The variable list does not seem to be defined.

The variable tuple does not seem to be defined.

                 severity: int=RESULT_SEVERITY.NORMAL,

The variable RESULT_SEVERITY does not seem to be defined.

The variable int does not seem to be defined.

                 additional_info: str="",
                 debug_msg="",
                 diffs: (dict, None)=None):

The variable dict does not seem to be defined.

        """
        :param origin:          Class name or class of the creator of this
                                object.
        :param message:         Message to show with this result.
        :param affected_code:   A tuple of SourceRange objects pointing to
                                related positions in the source code.
        :param severity:        Severity of this result.
        :param additional_info: A long description holding additional
                                information about the issue and/or how to fix
                                it. You can use this like a manual entry for a
                                category of issues.
        :param debug_msg:       A message which may help the user find out why
                                this result was yielded.
        :param diffs:           A dictionary with filenames as key and a
                                sequence of ``Diff`` objects associated with
                                them as values.
        """
        origin = origin or ""

The variable origin does not seem to be defined.

        if not isinstance(origin, str):
            origin = origin.__class__.__name__
        if severity not in RESULT_SEVERITY.reverse:

The variable severity does not seem to be defined.

            raise ValueError("severity is no valid RESULT_SEVERITY")

        self.origin = origin
        self.message = message

The variable message does not seem to be defined.

        self.debug_msg = debug_msg

The variable debug_msg does not seem to be defined.

        self.additional_info = additional_info

The variable additional_info does not seem to be defined.

        # Sorting is important for tuple comparison
        self.affected_code = tuple(sorted(affected_code))

The variable affected_code does not seem to be defined.

        self.severity = severity
        self.diffs = diffs

The variable diffs does not seem to be defined.

        self.id = uuid.uuid4().int

    @classmethod

The variable classmethod does not seem to be defined.

    @enforce_signature

The variable enforce_signature does not seem to be defined.

    def from_values(cls,
                    origin,
                    message: str,

The variable str does not seem to be defined.

                    file: str,
                    line: (int, None)=None,

The variable int does not seem to be defined.

                    column: (int, None)=None,
                    end_line: (int, None)=None,
                    end_column: (int, None)=None,
                    severity: int=RESULT_SEVERITY.NORMAL,

The variable RESULT_SEVERITY does not seem to be defined.

                    additional_info: str="",
                    debug_msg="",
                    diffs: (dict, None)=None):

The variable dict does not seem to be defined.

        """
        Creates a result with only one SourceRange with the given start and end
        locations.

        :param origin:          Class name or class of the creator of this
                                object.
        :param message:         A message to explain the result.
        :param file:            The related file.
        :param line:            The first related line in the file.
                                (First line is 1)
        :param column:          The column indicating the first character.
                                (First character is 1)
        :param end_line:        The last related line in the file.
        :param end_column:      The column indicating the last character.
        :param severity:        A RESULT_SEVERITY object.
        :param debug_msg:       Another message for debugging purposes.
        :param additional_info: A long description holding additional
                                information about the issue and/or how to fix
                                it. You can use this like a manual entry for a
                                category of issues.
        :param diffs:           A dictionary with filenames as key and a
                                sequence of ``Diff`` objects associated with
                                them as values.
        """
        range = SourceRange.from_values(file,

The variable file does not seem to be defined.

                                        line,

The variable line does not seem to be defined.

                                        column,

The variable column does not seem to be defined.

                                        end_line,

The variable end_line does not seem to be defined.

                                        end_column)

The variable end_column does not seem to be defined.

        return cls(origin=origin,

The variable origin does not seem to be defined.

                   message=message,

The variable message does not seem to be defined.

                   affected_code=(range,),

The variable range does not seem to be defined.

                   severity=severity,

The variable severity does not seem to be defined.

                   additional_info=additional_info,

The variable additional_info does not seem to be defined.

                   debug_msg=debug_msg,

The variable debug_msg does not seem to be defined.

                   diffs=diffs)

The variable diffs does not seem to be defined.

    def to_string_dict(self):
        """
        Makes a dictionary which has all keys and values as strings and
        contains all the data that the base Result has.

        FIXME: diffs are not serialized ATM.
        FIXME: Only the first SourceRange of affected_code is serialized. If
        there are more, this data is currently missing.

        :return: Dictionary with keys and values as string.
        """
        retval = {}

        members = ["id",
                   "additional_info",
                   "debug_msg",
                   "message",
                   "origin"]

        for member in members:

The variable members does not seem to be defined.

            value = getattr(self, member)

The variable member does not seem to be defined.

The variable self does not seem to be defined.

            retval[member] = "" if value == None else str(value)

The variable value does not seem to be defined.

        retval["severity"] = str(RESULT_SEVERITY.reverse.get(
            self.severity, ""))
        if len(self.affected_code) > 0:
            retval["file"] = self.affected_code[0].file
            line = self.affected_code[0].start.line
            retval["line_nr"] = "" if line is None else str(line)

The variable line does not seem to be defined.

        else:
            retval["file"], retval["line_nr"] = "", ""

        return retval

The variable retval does not seem to be defined.

    @enforce_signature

The variable enforce_signature does not seem to be defined.

    def apply(self, file_dict: dict):

The variable dict does not seem to be defined.

        """
        Applies all contained diffs to the given file_dict. This operation will
        be done in-place.

        :param file_dict: A dictionary containing all files with filename as
                          key and all lines a value. Will be modified.
        """
        for filename in self.diffs:

The variable self does not seem to be defined.

            file_dict[filename] = self.diffs[filename].modified

The variable filename does not seem to be defined.

    def __add__(self, other):
        """
        Joins those patches to one patch.

        :param other: The other patch.
        """
        assert isinstance(self.diffs, dict)

The variable dict does not seem to be defined.

The variable self does not seem to be defined.

        assert isinstance(other.diffs, dict)

The variable other does not seem to be defined.

        for filename in other.diffs:
            if filename in self.diffs:

The variable filename does not seem to be defined.

                self.diffs[filename] += other.diffs[filename]
            else:
                self.diffs[filename] = other.diffs[filename]

        return self

    def overlaps(self, ranges):
        """
        Determines if the result overlaps with source ranges provided.

        :param ranges: A list SourceRange objects to check for overlap.
        :return:       True if the ranges overlap with the result.
        """
        if isinstance(ranges, SourceRange):

The variable SourceRange does not seem to be defined.

The variable ranges does not seem to be defined.

            ranges = [ranges]

        for range in ranges:
            for self_range in self.affected_code:

The variable self does not seem to be defined.

                if range.overlaps(self_range):

The variable self_range does not seem to be defined.

                    return True

        return False

    def location_repr(self):
        """
        Retrieves a string, that briefly represents
        the affected code of the result.

        :return: A string containing all of the affected files
                 seperated by a comma.
        """

        if not self.affected_code:

The variable self does not seem to be defined.

            return "the whole project"

        # Set important to exclude duplicate file names
        range_paths = set(sourcerange.file

The variable sourcerange does not seem to be defined.

                          for sourcerange in self.affected_code)

        return ', '.join(repr(relpath(range_path))

The variable range_path does not seem to be defined.

                         for range_path in sorted(range_paths))

The variable range_paths does not seem to be defined.

    def __json__(self, use_relpath=False):
        _dict = get_public_members(self)

The variable self does not seem to be defined.

        if use_relpath and _dict['diffs']:

The variable use_relpath does not seem to be defined.

The variable _dict does not seem to be defined.

            _dict['diffs'] = {relpath(file): diff

The variable diff does not seem to be defined.

The variable file does not seem to be defined.

                              for file, diff in _dict['diffs'].items()}
        return _dict