68 lines
1.9 KiB
Python
68 lines
1.9 KiB
Python
"""Plugin for logger invocations."""
|
|
from __future__ import annotations
|
|
|
|
from astroid import nodes
|
|
from pylint.checkers import BaseChecker
|
|
from pylint.lint import PyLinter
|
|
|
|
LOGGER_NAMES = ("LOGGER", "_LOGGER")
|
|
LOG_LEVEL_ALLOWED_LOWER_START = ("debug",)
|
|
|
|
|
|
class HassLoggerFormatChecker(BaseChecker): # type: ignore[misc]
|
|
"""Checker for logger invocations."""
|
|
|
|
name = "hass_logger"
|
|
priority = -1
|
|
msgs = {
|
|
"W7401": (
|
|
"User visible logger messages must not end with a period",
|
|
"hass-logger-period",
|
|
"Periods are not permitted at the end of logger messages",
|
|
),
|
|
"W7402": (
|
|
"User visible logger messages must start with a capital letter or downgrade to debug",
|
|
"hass-logger-capital",
|
|
"All logger messages must start with a capital letter",
|
|
),
|
|
}
|
|
options = ()
|
|
|
|
def visit_call(self, node: nodes.Call) -> None:
|
|
"""Check for improper log messages."""
|
|
if not isinstance(node.func, nodes.Attribute) or not isinstance(
|
|
node.func.expr, nodes.Name
|
|
):
|
|
return
|
|
|
|
if node.func.expr.name not in LOGGER_NAMES:
|
|
return
|
|
|
|
if not node.args:
|
|
return
|
|
|
|
first_arg = node.args[0]
|
|
|
|
if not isinstance(first_arg, nodes.Const) or not first_arg.value:
|
|
return
|
|
|
|
log_message = first_arg.value
|
|
|
|
if len(log_message) < 1:
|
|
return
|
|
|
|
if log_message[-1] == ".":
|
|
self.add_message("hass-logger-period", node=node)
|
|
|
|
if (
|
|
isinstance(node.func.attrname, str)
|
|
and node.func.attrname not in LOG_LEVEL_ALLOWED_LOWER_START
|
|
and log_message[0].upper() != log_message[0]
|
|
):
|
|
self.add_message("hass-logger-capital", node=node)
|
|
|
|
|
|
def register(linter: PyLinter) -> None:
|
|
"""Register the checker."""
|
|
linter.register_checker(HassLoggerFormatChecker(linter))
|