mirror of
https://github.com/PiBrewing/craftbeerpi4.git
synced 2024-11-30 02:34:18 +01:00
83 lines
2.9 KiB
Python
83 lines
2.9 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 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_name = checker.name
|
||
|
|
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)
|