diff options
author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2021-05-30 18:30:14 +0200 |
---|---|---|
committer | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2021-06-02 13:13:01 +0200 |
commit | 35a030ea6052d83f2d325868af850f3b26bb53f3 (patch) | |
tree | d1bc64e1d67bd6945abb8c7d3fdb4cceff7086dc /pylint/message/message_definition.py | |
parent | 6dae5e9b5b08c04b5556fc31236f5194513a5117 (diff) | |
download | pylint-git-35a030ea6052d83f2d325868af850f3b26bb53f3.tar.gz |
Add typing in pylint.messages
Only the one that are not creating circular imports.
See #4530
Diffstat (limited to 'pylint/message/message_definition.py')
-rw-r--r-- | pylint/message/message_definition.py | 37 |
1 files changed, 21 insertions, 16 deletions
diff --git a/pylint/message/message_definition.py b/pylint/message/message_definition.py index 3b2e917b5..1e8c53ea6 100644 --- a/pylint/message/message_definition.py +++ b/pylint/message/message_definition.py @@ -2,6 +2,7 @@ # For details: https://github.com/PyCQA/pylint/blob/master/LICENSE import sys +from typing import List, Optional, Tuple from pylint.constants import MSG_TYPES from pylint.exceptions import InvalidMessageError @@ -11,15 +12,15 @@ from pylint.utils import normalize_text class MessageDefinition: def __init__( self, - checker, - msgid, - msg, - description, - symbol, - scope, - minversion=None, - maxversion=None, - old_names=None, + checker, # BaseChecker + msgid: str, + msg: str, + description: str, + symbol: str, + scope: str, + minversion: Optional[Tuple[int, int, int, str, int]] = None, + maxversion: Optional[Tuple[int, int, int, str, int]] = None, + old_names: List[Tuple[str, str]] = None, ): self.checker_name = checker.name self.check_msgid(msgid) @@ -30,11 +31,13 @@ class MessageDefinition: self.scope = scope self.minversion = minversion self.maxversion = maxversion - self.old_names = [] + self.old_names: List[Tuple[str, str]] = [] if old_names: for old_msgid, old_symbol in old_names: self.check_msgid(old_msgid) - self.old_names.append([old_msgid, old_symbol]) + self.old_names.append( + (old_msgid, old_symbol), + ) @staticmethod def check_msgid(msgid: str) -> None: @@ -49,7 +52,7 @@ class MessageDefinition: def __str__(self): return f"{repr(self)}:\n{self.msg} {self.description}" - def may_be_emitted(self): + def may_be_emitted(self) -> bool: """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 @@ -57,7 +60,7 @@ class MessageDefinition: return False return True - def format_help(self, checkerref=False): + def format_help(self, checkerref: bool = False) -> str: """return the help string for the given message id""" desc = self.description if checkerref: @@ -69,11 +72,13 @@ class MessageDefinition: 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) + restriction = " or ".join(restr) if checkerref: - desc += " It can't be emitted when using Python %s." % restr + desc += " It can't be emitted when using Python %s." % restriction else: - desc += " This message can't be emitted when using Python %s." % restr + desc += ( + " This message can't be emitted when using Python %s." % restriction + ) msg_help = normalize_text(" ".join(desc.split()), indent=" ") message_id = f"{self.symbol} ({self.msgid})" if title != "%s": |