1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
# -*- coding: utf-8 -*-
# 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 sys
from pylint.constants import MSG_TYPES
from pylint.exceptions import InvalidMessageError
from pylint.utils import normalize_text
class MessageDefinition:
def __init__(
self,
checker,
msgid,
msg,
description,
symbol,
scope,
minversion=None,
maxversion=None,
old_names=None,
):
self.checker = checker
self.check_msgid(msgid)
self.msgid = msgid
self.symbol = symbol
self.msg = msg
self.description = description
self.scope = scope
self.minversion = minversion
self.maxversion = maxversion
self.old_names = []
if old_names:
for old_msgid, old_symbol in old_names:
self.check_msgid(old_msgid)
self.old_names.append([old_msgid, old_symbol])
@staticmethod
def check_msgid(msgid: str) -> None:
if len(msgid) != 5:
raise InvalidMessageError("Invalid message id %r" % msgid)
if msgid[0] not in MSG_TYPES:
raise InvalidMessageError("Bad message type %s in %r" % (msgid[0], msgid))
def __repr__(self):
return "MessageDefinition:%s (%s)" % (self.symbol, self.msgid)
def __str__(self):
return "%s:\n%s %s" % (repr(self), self.msg, self.description)
def may_be_emitted(self):
"""return True if message may be emitted using the current interpreter"""
if self.minversion is not None and self.minversion > sys.version_info:
return False
if self.maxversion is not None and self.maxversion <= sys.version_info:
return False
return True
def format_help(self, checkerref=False):
"""return the help string for the given message id"""
desc = self.description
if checkerref:
desc += " This message belongs to the %s checker." % self.checker.name
title = self.msg
if self.minversion or self.maxversion:
restr = []
if self.minversion:
restr.append("< %s" % ".".join([str(n) for n in self.minversion]))
if self.maxversion:
restr.append(">= %s" % ".".join([str(n) for n in self.maxversion]))
restr = " or ".join(restr)
if checkerref:
desc += " It can't be emitted when using Python %s." % restr
else:
desc += " This message can't be emitted when using Python %s." % restr
msg_help = normalize_text(" ".join(desc.split()), indent=" ")
message_id = "%s (%s)" % (self.symbol, self.msgid)
if title != "%s":
title = title.splitlines()[0]
return ":%s: *%s*\n%s" % (message_id, title.rstrip(" "), msg_help)
return ":%s:\n%s" % (message_id, msg_help)
|
