Method: pylint.message.message_definition.MessageDefinition.format_help
Calls: 361, Exceptions: 0, Paths: 8Back
Path 1: 341 calls (0.94)
False (341)
':basic-checker-example (W0001): *Basic checker has an example.*\n Used nowhere and serves no purpose.' (2) ':msg-symbol (W1234): *message*\n msg de...
1def format_help(self, checkerref: bool = False) -> str:
2 """Return the help string for the given message id."""
3 desc = self.description
4 if checkerref:
5 desc += f" This message belongs to the {self.checker_name} checker."
6 title = self.msg
7 if self.minversion or self.maxversion:
8 restr = []
9 if self.minversion:
10 restr.append(f"< {'.'.join(str(n) for n in self.minversion)}")
11 if self.maxversion:
12 restr.append(f">= {'.'.join(str(n) for n in self.maxversion)}")
13 restriction = " or ".join(restr)
14 if checkerref:
15 desc += f" It can't be emitted when using Python {restriction}."
16 else:
17 desc += (
18 f" This message can't be emitted when using Python {restriction}."
19 )
20 msg_help = normalize_text(" ".join(desc.split()), indent=" ")
21 message_id = f"{self.symbol} ({self.msgid})"
22 if title != "%s":
23 title = title.splitlines()[0]
24 return f":{message_id}: *{title.rstrip(' ')}*\n{msg_help}"
25 return f":{message_id}:\n{msg_help}"
Path 2: 4 calls (0.01)
True (4)
':msg-symbol (W1234): *message*\n msg description. This message belongs to the achecker checker.' (2) ':dummy-message-01 (I9061): *Dummy short desc 0...
1def format_help(self, checkerref: bool = False) -> str:
2 """Return the help string for the given message id."""
3 desc = self.description
4 if checkerref:
5 desc += f" This message belongs to the {self.checker_name} checker."
6 title = self.msg
7 if self.minversion or self.maxversion:
8 restr = []
9 if self.minversion:
10 restr.append(f"< {'.'.join(str(n) for n in self.minversion)}")
11 if self.maxversion:
12 restr.append(f">= {'.'.join(str(n) for n in self.maxversion)}")
13 restriction = " or ".join(restr)
14 if checkerref:
15 desc += f" It can't be emitted when using Python {restriction}."
16 else:
17 desc += (
18 f" This message can't be emitted when using Python {restriction}."
19 )
20 msg_help = normalize_text(" ".join(desc.split()), indent=" ")
21 message_id = f"{self.symbol} ({self.msgid})"
22 if title != "%s":
23 title = title.splitlines()[0]
24 return f":{message_id}: *{title.rstrip(' ')}*\n{msg_help}"
25 return f":{message_id}:\n{msg_help}"
Path 3: 4 calls (0.01)
False (4)
":not-async-context-manager (E1701): *Async context manager '%s' doesn't implement __aenter__ and __aexit__.*\n Used when an async context manager is...
1def format_help(self, checkerref: bool = False) -> str:
2 """Return the help string for the given message id."""
3 desc = self.description
4 if checkerref:
5 desc += f" This message belongs to the {self.checker_name} checker."
6 title = self.msg
7 if self.minversion or self.maxversion:
8 restr = []
9 if self.minversion:
10 restr.append(f"< {'.'.join(str(n) for n in self.minversion)}")
11 if self.maxversion:
12 restr.append(f">= {'.'.join(str(n) for n in self.maxversion)}")
13 restriction = " or ".join(restr)
14 if checkerref:
15 desc += f" It can't be emitted when using Python {restriction}."
16 else:
17 desc += (
18 f" This message can't be emitted when using Python {restriction}."
19 )
20 msg_help = normalize_text(" ".join(desc.split()), indent=" ")
21 message_id = f"{self.symbol} ({self.msgid})"
22 if title != "%s":
23 title = title.splitlines()[0]
24 return f":{message_id}: *{title.rstrip(' ')}*\n{msg_help}"
25 return f":{message_id}:\n{msg_help}"
Path 4: 4 calls (0.01)
False (4)
":duplicate-keyword-arg (E1234): *Duplicate keyword argument %r in %s call*\n Used when a function call passes the same keyword argument multiple tim...
1def format_help(self, checkerref: bool = False) -> str:
2 """Return the help string for the given message id."""
3 desc = self.description
4 if checkerref:
5 desc += f" This message belongs to the {self.checker_name} checker."
6 title = self.msg
7 if self.minversion or self.maxversion:
8 restr = []
9 if self.minversion:
10 restr.append(f"< {'.'.join(str(n) for n in self.minversion)}")
11 if self.maxversion:
12 restr.append(f">= {'.'.join(str(n) for n in self.maxversion)}")
13 restriction = " or ".join(restr)
14 if checkerref:
15 desc += f" It can't be emitted when using Python {restriction}."
16 else:
17 desc += (
18 f" This message can't be emitted when using Python {restriction}."
19 )
20 msg_help = normalize_text(" ".join(desc.split()), indent=" ")
21 message_id = f"{self.symbol} ({self.msgid})"
22 if title != "%s":
23 title = title.splitlines()[0]
24 return f":{message_id}: *{title.rstrip(' ')}*\n{msg_help}"
25 return f":{message_id}:\n{msg_help}"
Path 5: 4 calls (0.01)
False (4)
':fixme (W0511):\n Used when a warning note as FIXME or XXX is detected.' (1) ':use-symbolic-message-instead (I0023):\n Used when a message is enabl...
1def format_help(self, checkerref: bool = False) -> str:
2 """Return the help string for the given message id."""
3 desc = self.description
4 if checkerref:
5 desc += f" This message belongs to the {self.checker_name} checker."
6 title = self.msg
7 if self.minversion or self.maxversion:
8 restr = []
9 if self.minversion:
10 restr.append(f"< {'.'.join(str(n) for n in self.minversion)}")
11 if self.maxversion:
12 restr.append(f">= {'.'.join(str(n) for n in self.maxversion)}")
13 restriction = " or ".join(restr)
14 if checkerref:
15 desc += f" It can't be emitted when using Python {restriction}."
16 else:
17 desc += (
18 f" This message can't be emitted when using Python {restriction}."
19 )
20 msg_help = normalize_text(" ".join(desc.split()), indent=" ")
21 message_id = f"{self.symbol} ({self.msgid})"
22 if title != "%s":
23 title = title.splitlines()[0]
24 return f":{message_id}: *{title.rstrip(' ')}*\n{msg_help}"
25 return f":{message_id}:\n{msg_help}"
Path 6: 2 calls (0.01)
True (2)
":duplicate-keyword-arg (E1234): *Duplicate keyword argument %r in %s call*\n Used when a function call passes the same keyword argument multiple tim...
1def format_help(self, checkerref: bool = False) -> str:
2 """Return the help string for the given message id."""
3 desc = self.description
4 if checkerref:
5 desc += f" This message belongs to the {self.checker_name} checker."
6 title = self.msg
7 if self.minversion or self.maxversion:
8 restr = []
9 if self.minversion:
10 restr.append(f"< {'.'.join(str(n) for n in self.minversion)}")
11 if self.maxversion:
12 restr.append(f">= {'.'.join(str(n) for n in self.maxversion)}")
13 restriction = " or ".join(restr)
14 if checkerref:
15 desc += f" It can't be emitted when using Python {restriction}."
16 else:
17 desc += (
18 f" This message can't be emitted when using Python {restriction}."
19 )
20 msg_help = normalize_text(" ".join(desc.split()), indent=" ")
21 message_id = f"{self.symbol} ({self.msgid})"
22 if title != "%s":
23 title = title.splitlines()[0]
24 return f":{message_id}: *{title.rstrip(' ')}*\n{msg_help}"
25 return f":{message_id}:\n{msg_help}"
Path 7: 1 calls (0.0)
False (1)
":msg-symbol (W1234): *message*\n description This message can't be emitted when using Python < 3.9 or >= 3.11." (1)
1def format_help(self, checkerref: bool = False) -> str:
2 """Return the help string for the given message id."""
3 desc = self.description
4 if checkerref:
5 desc += f" This message belongs to the {self.checker_name} checker."
6 title = self.msg
7 if self.minversion or self.maxversion:
8 restr = []
9 if self.minversion:
10 restr.append(f"< {'.'.join(str(n) for n in self.minversion)}")
11 if self.maxversion:
12 restr.append(f">= {'.'.join(str(n) for n in self.maxversion)}")
13 restriction = " or ".join(restr)
14 if checkerref:
15 desc += f" It can't be emitted when using Python {restriction}."
16 else:
17 desc += (
18 f" This message can't be emitted when using Python {restriction}."
19 )
20 msg_help = normalize_text(" ".join(desc.split()), indent=" ")
21 message_id = f"{self.symbol} ({self.msgid})"
22 if title != "%s":
23 title = title.splitlines()[0]
24 return f":{message_id}: *{title.rstrip(' ')}*\n{msg_help}"
25 return f":{message_id}:\n{msg_help}"
Path 8: 1 calls (0.0)
True (1)
":msg-symbol (W1234): *message*\n description This message belongs to the falsechecker checker. It can't be\n emitted when using Python < 3.9 or >= ...
1def format_help(self, checkerref: bool = False) -> str:
2 """Return the help string for the given message id."""
3 desc = self.description
4 if checkerref:
5 desc += f" This message belongs to the {self.checker_name} checker."
6 title = self.msg
7 if self.minversion or self.maxversion:
8 restr = []
9 if self.minversion:
10 restr.append(f"< {'.'.join(str(n) for n in self.minversion)}")
11 if self.maxversion:
12 restr.append(f">= {'.'.join(str(n) for n in self.maxversion)}")
13 restriction = " or ".join(restr)
14 if checkerref:
15 desc += f" It can't be emitted when using Python {restriction}."
16 else:
17 desc += (
18 f" This message can't be emitted when using Python {restriction}."
19 )
20 msg_help = normalize_text(" ".join(desc.split()), indent=" ")
21 message_id = f"{self.symbol} ({self.msgid})"
22 if title != "%s":
23 title = title.splitlines()[0]
24 return f":{message_id}: *{title.rstrip(' ')}*\n{msg_help}"
25 return f":{message_id}:\n{msg_help}"