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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
# Copyright (c) 2014 Google, Inc.
# Copyright (c) 2014 LOGILAB S.A. (Paris, FRANCE) <contact@logilab.fr>
# Copyright (c) 2015-2020 Claudiu Popa <pcmanticore@gmail.com>
# Copyright (c) 2015 Ionel Cristian Maries <contact@ionelmc.ro>
# Copyright (c) 2016 Derek Gustafson <degustaf@gmail.com>
# Copyright (c) 2018 Alan Chan <achan961117@gmail.com>
# Copyright (c) 2019-2020 Ashley Whetter <ashley@awhetter.co.uk>
# Copyright (c) 2019 Svet <svet@hyperscience.com>
# Copyright (c) 2020-2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
# Copyright (c) 2020 hippo91 <guillaume.peillex@gmail.com>
# Copyright (c) 2021 Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
# Copyright (c) 2021 Marc Mueller <30130371+cdce8p@users.noreply.github.com>
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
"""Unittest for the logging checker."""
import sys
from typing import Optional, Tuple
import astroid
import pytest
from pylint.checkers import logging
from pylint.interfaces import UNDEFINED
from pylint.testutils import CheckerTestCase, Message, set_config
class TestLoggingModuleDetection(CheckerTestCase):
CHECKER_CLASS = logging.LoggingChecker
def test_detects_standard_logging_module(self) -> None:
stmts = astroid.extract_node(
"""
import logging #@
logging.warn('%s' % '%s') #@
"""
)
self.checker.visit_module(None)
self.checker.visit_import(stmts[0])
with self.assertAddsMessages(
Message("logging-not-lazy", node=stmts[1], args=("lazy %",))
):
self.checker.visit_call(stmts[1])
def test_dont_crash_on_invalid_format_string(self) -> None:
node = astroid.parse(
"""
import logging
logging.error('0} - {1}'.format(1, 2))
"""
)
self.walk(node)
def test_detects_renamed_standard_logging_module(self) -> None:
stmts = astroid.extract_node(
"""
import logging as blogging #@
blogging.warn('%s' % '%s') #@
"""
)
self.checker.visit_module(None)
self.checker.visit_import(stmts[0])
with self.assertAddsMessages(
Message("logging-not-lazy", node=stmts[1], args=("lazy %",))
):
self.checker.visit_call(stmts[1])
@set_config(logging_modules=["logging", "my.logging"])
def test_nonstandard_logging_module(self) -> None:
stmts = astroid.extract_node(
"""
from my import logging as blogging #@
blogging.warn('%s' % '%s') #@
"""
)
self.checker.visit_module(None)
self.checker.visit_import(stmts[0])
with self.assertAddsMessages(
Message("logging-not-lazy", node=stmts[1], args=("lazy %",))
):
self.checker.visit_call(stmts[1])
def _assert_logging_format_no_messages(self, stmt: str) -> None:
stmts = astroid.extract_node(
"""
import logging #@
logging.error<placeholder> #@
""".replace(
"<placeholder>", stmt
)
)
self.checker.visit_module(None)
self.checker.visit_import(stmts[0])
with self.assertNoMessages():
self.checker.visit_call(stmts[1])
def _assert_logging_format_message(
self,
msg: str,
stmt: str,
args: Optional[Tuple[str]] = None,
with_too_many: bool = False,
) -> None:
stmts = astroid.extract_node(
"""
import logging #@
logging.error<placeholder> #@
""".replace(
"<placeholder>", stmt
)
)
self.checker.visit_module(None)
self.checker.visit_import(stmts[0])
messages = [Message(msg, node=stmts[1], args=args, confidence=UNDEFINED)]
if with_too_many:
messages.append(
Message("logging-too-many-args", node=stmts[1], confidence=UNDEFINED)
)
with self.assertAddsMessages(*messages):
self.checker.visit_call(stmts[1])
def _assert_logging_format_too_few_args(self, stmt: str) -> None:
self._assert_logging_format_message("logging-too-few-args", stmt)
def _assert_logging_format_too_many_args(self, stmt: str) -> None:
self._assert_logging_format_message("logging-too-many-args", stmt)
@set_config(logging_format_style="new")
def test_brace_format_style_matching_arguments(self) -> None:
self._assert_logging_format_no_messages("('constant string')")
self._assert_logging_format_no_messages("('{}')")
self._assert_logging_format_no_messages("('{}', 1)")
self._assert_logging_format_no_messages("('{0}', 1)")
self._assert_logging_format_no_messages("('{named}', {'named': 1})")
self._assert_logging_format_no_messages("('{} {named}', 1, {'named': 1})")
self._assert_logging_format_no_messages("('{0} {named}', 1, {'named': 1})")
@set_config(logging_format_style="new")
def test_brace_format_style_too_few_args(self) -> None:
self._assert_logging_format_too_few_args("('{}, {}', 1)")
self._assert_logging_format_too_few_args("('{0}, {1}', 1)")
self._assert_logging_format_too_few_args(
"('{named1}, {named2}', {'named1': 1})"
)
self._assert_logging_format_too_few_args("('{0}, {named}', 1)")
self._assert_logging_format_too_few_args("('{}, {named}', {'named': 1})")
self._assert_logging_format_too_few_args("('{0}, {named}', {'named': 1})")
@set_config(logging_format_style="new")
def test_brace_format_style_not_enough_arguments(self) -> None:
self._assert_logging_format_too_many_args("('constant string', 1, 2)")
self._assert_logging_format_too_many_args("('{}', 1, 2)")
self._assert_logging_format_too_many_args("('{0}', 1, 2)")
self._assert_logging_format_too_many_args("('{}, {named}', 1, 2, {'named': 1})")
self._assert_logging_format_too_many_args(
"('{0}, {named}', 1, 2, {'named': 1})"
)
@pytest.mark.skipif(sys.version_info < (3, 6), reason="F-string require >=3.6")
@set_config(logging_format_style="new")
def test_fstr_not_new_format_style_matching_arguments(self) -> None:
msg = "logging-fstring-interpolation"
args = ("lazy %",)
self._assert_logging_format_message(msg, "(f'{named}')", args)
|
