third_party.pylibs.pylint.src/pylint/testutils/output_line.py
Pierre Sassoulas 8020641d2b Move from format() to f-string where it makes sense
As we do not maintain python 3.5 it permit to simplify some code
2021-02-16 07:53:15 +01:00

92 lines
2.8 KiB
Python

# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/master/COPYING
import collections
from pylint import interfaces
from pylint.constants import PY38_PLUS
from pylint.testutils.constants import UPDATE_OPTION
class Message(
collections.namedtuple("Message", ["msg_id", "line", "node", "args", "confidence"])
):
def __new__(cls, msg_id, line=None, node=None, args=None, confidence=None):
return tuple.__new__(cls, (msg_id, line, node, args, confidence))
def __eq__(self, other):
if isinstance(other, Message):
if self.confidence and other.confidence:
return super().__eq__(other)
return self[:-1] == other[:-1]
return NotImplemented # pragma: no cover
class MalformedOutputLineException(Exception):
def __init__(self, row, exception):
example = "msg-symbolic-name:42:27:MyClass.my_function:The message"
other_example = "msg-symbolic-name:7:42::The message"
expected = [
"symbol",
"line",
"column",
"MyClass.myFunction, (or '')",
"Message",
"confidence",
]
reconstructed_row = ""
i = 0
for i, column in enumerate(row):
reconstructed_row += f"\t{expected[i]}='{column}' ?\n"
for missing in expected[i + 1 :]:
reconstructed_row += f"\t{missing}= Nothing provided !\n"
raw = ":".join(row)
msg = f"""\
{exception}
Expected '{example}' or '{other_example}' but we got '{raw}':
{reconstructed_row}
Try updating it with: 'python tests/test_functional.py {UPDATE_OPTION}'"""
Exception.__init__(self, msg)
class OutputLine(
collections.namedtuple(
"OutputLine", ["symbol", "lineno", "column", "object", "msg", "confidence"]
)
):
@classmethod
def from_msg(cls, msg):
column = cls.get_column(msg.column)
return cls(
msg.symbol,
msg.line,
column,
msg.obj or "",
msg.msg.replace("\r\n", "\n"),
msg.confidence.name
if msg.confidence != interfaces.UNDEFINED
else interfaces.HIGH.name,
)
@classmethod
def get_column(cls, column):
if not PY38_PLUS:
return ""
return str(column)
@classmethod
def from_csv(cls, row):
try:
confidence = row[5] if len(row) == 6 else interfaces.HIGH.name
column = cls.get_column(row[2])
return cls(row[0], int(row[1]), column, row[3], row[4], confidence)
except Exception as e:
raise MalformedOutputLineException(row, e) from e
def to_csv(self):
if self.confidence == interfaces.HIGH.name:
return self[:-1]
return self