Merge remote-tracking branch 'origin/main' into fix-docs

Author: Pierre-Sassoulas

doc/whatsnew/fragments/9357.feature

@@ -0,0 +1,4 @@
+The verbose option now outputs the filenames of the files that have been checked.
+Previously, it only included the number of checked and skipped files.
+
+Closes #9357

doc/whatsnew/fragments/9999.false_negative

@@ -0,0 +1,5 @@
+We now raise a ``logging-too-few-args`` for format string with no
+interpolation arguments at all (i.e. for something like ``logging.debug("Awaiting process %s")``
+or ``logging.debug("Awaiting process {pid}")``). Previously we did not raise for such case.
+
+Closes #9999

pylint/checkers/logging.py

@@ -326,11 +326,6 @@ def _check_format_string(self, node: nodes.Call, format_arg: Literal[0, 1]) -> N
           format_arg: Index of the format string in the node arguments.
         """
         num_args = _count_supplied_tokens(node.args[format_arg + 1 :])
-        if not num_args:
-            # If no args were supplied the string is not interpolated and can contain
-            # formatting characters - it's used verbatim. Don't check any further.
-            return
-
         format_string = node.args[format_arg].value
         required_num_args = 0
         if isinstance(format_string, bytes):

pylint/lint/pylinter.py

@@ -764,6 +764,7 @@ def _lint_files(
                 continue
             try:
                 self._lint_file(fileitem, module, check_astroid_module)
+                self.stats.modules_names.add(fileitem.filepath)
             except Exception as ex:  # pylint: disable=broad-except
                 template_path = prepare_crash_report(
                     ex, fileitem.filepath, self.crash_file_path
@@ -1161,7 +1162,12 @@ def _report_evaluation(self, verbose: bool = False) -> int | None:
 
             if verbose:
                 checked_files_count = self.stats.node_count["module"]
-                msg += f"\nChecked {checked_files_count} files, skipped {self.stats.skipped} files/modules"
+                unchecked_files_count = self.stats.undocumented["module"]
+                checked_files = ", ".join(self.stats.modules_names)
+                msg += (
+                    f"\nChecked {checked_files_count} files/modules ({checked_files}),"
+                    f" skipped {unchecked_files_count} files/modules"
+                )
 
         if self.config.score:
             sect = report_nodes.EvaluationSection(msg)

pylint/utils/linterstats.py

@@ -109,6 +109,7 @@ def __init__(
         self.code_type_count = code_type_count or CodeTypeCount(
             code=0, comment=0, docstring=0, empty=0, total=0
         )
+        self.modules_names: set[str] = set()
 
         self.dependencies: dict[str, set[str]] = dependencies or {}
         self.duplicated_lines = duplicated_lines or DuplicatedLines(

tests/config/data/logging_format_interpolation_style.py

@@ -5,7 +5,6 @@
 import logging
 
 logging.error("constant string")
-logging.error("{}")
 logging.error("{}", 1)
 logging.error("{0}", 1)
 logging.error("{named}", {"named": 1})

tests/functional/l/logging/logging_format_interpolation_style.py

@@ -3,7 +3,6 @@
 import logging
 
 logging.error("constant string")
-logging.error("{}")
 logging.error("{}", 1)
 logging.error("{0}", 1)
 logging.error("{named}", {"named": 1})

tests/functional/l/logging/logging_too_few_args.txt

@@ -1,9 +1,12 @@
-"""Tests for logging-too-few-args"""
+"""Tests for logging-too-few-args new style"""
 
 import logging
 
 logging.error("{}, {}", 1)  # [logging-too-few-args]
 logging.error("{0}, {1}", 1)  # [logging-too-few-args]
+logging.error("{}")  # [logging-too-few-args]
+logging.error("{0}")  # [logging-too-few-args]
+logging.error("{named}")  # [logging-too-few-args]
 logging.error("{named1}, {named2}", {"named1": 1})  # [logging-too-few-args]
 logging.error("{0}, {named}", 1)  # [logging-too-few-args]
 logging.error("{}, {named}", {"named": 1})  # [logging-too-few-args]

tests/functional/l/logging/logging_too_few_args.py renamed to tests/functional/l/logging/logging_too_few_args_new_style.py

@@ -0,0 +1,9 @@
+logging-too-few-args:5:0:5:26::Not enough arguments for logging format string:UNDEFINED
+logging-too-few-args:6:0:6:28::Not enough arguments for logging format string:UNDEFINED
+logging-too-few-args:7:0:7:19::Not enough arguments for logging format string:UNDEFINED
+logging-too-few-args:8:0:8:20::Not enough arguments for logging format string:UNDEFINED
+logging-too-few-args:9:0:9:24::Not enough arguments for logging format string:UNDEFINED
+logging-too-few-args:10:0:10:50::Not enough arguments for logging format string:UNDEFINED
+logging-too-few-args:11:0:11:32::Not enough arguments for logging format string:UNDEFINED
+logging-too-few-args:12:0:12:42::Not enough arguments for logging format string:UNDEFINED
+logging-too-few-args:13:0:13:43::Not enough arguments for logging format string:UNDEFINED

tests/functional/l/logging/logging_too_few_args.rc renamed to tests/functional/l/logging/logging_too_few_args_new_style.rc

@@ -0,0 +1,6 @@
+"""Tests for logging-too-few-args old style"""
+
+import logging
+
+logging.error("%s, %s", 1)  # [logging-too-few-args]
+logging.debug("Sisyphus table %s: sleep")  # [logging-too-few-args]

tests/functional/l/logging/logging_too_few_args_new_style.txt

@@ -0,0 +1,2 @@
+[LOGGING]
+logging-format-style=old

tests/functional/l/logging/logging_too_few_args_old_style.py

@@ -0,0 +1,2 @@
+logging-too-few-args:5:0:5:26::Not enough arguments for logging format string:UNDEFINED
+logging-too-few-args:6:0:6:41::Not enough arguments for logging format string:UNDEFINED

tests/functional/l/logging/logging_too_few_args_old_style.rc

@@ -0,0 +1,11 @@
+# pylint: disable=missing-docstring,too-few-public-methods
+
+class DynamicGetitem:
+    def __getitem__(self, key):
+        if key == 'attributes':
+            return []
+        return {'world': 123}
+
+
+ex = DynamicGetitem()
+a = ex['hello']['world']  # [invalid-sequence-index] known false-positive

tests/functional/l/logging/logging_too_few_args_old_style.txt

@@ -0,0 +1 @@
+invalid-sequence-index:11:4:11:24::Sequence index is not an int, slice, or instance with __index__:UNDEFINED

tests/functional/r/regression_02/regression_dynamic_getitiem.py

@@ -0,0 +1,7 @@
+# pylint: disable=missing-docstring
+
+data = {
+    'abc': None,
+}
+data['abc'] = lambda: print("Callback called")
+data['abc']()  # [not-callable] known false-positive

tests/functional/r/regression_02/regression_dynamic_getitiem.txt

@@ -0,0 +1 @@
+not-callable:7:0:7:13::data['abc'] is not callable:UNDEFINED

tests/functional/r/regression_02/regression_lambda_inference_not_callable.py

@@ -22,7 +22,7 @@ def pprint():
     logging.info(1)
     logging.info(True)
     logging.info('')
-    logging.info('%s%')
+    logging.info('%s%')  # [logging-format-truncated]
     logging.info('%s', '')
     logging.info('%s%%', '')
     logging.info('%s%s', '', '')

tests/functional/r/regression_02/regression_lambda_inference_not_callable.txt

@@ -4,3 +4,4 @@ logging-format-truncated:16:4:16:27:pprint:Logging format string ends in middle
 logging-too-few-args:17:4:17:28:pprint:Not enough arguments for logging format string:UNDEFINED
 logging-unsupported-format:18:4:18:32:pprint:Unsupported logging format character 'y' (0x79) at index 3:UNDEFINED
 logging-too-many-args:19:4:19:36:pprint:Too many arguments for logging format string:HIGH
+logging-format-truncated:25:4:25:23:pprint:Logging format string ends in middle of conversion specifier:UNDEFINED

tests/functional/s/string/string_log_formatting.py

@@ -257,7 +257,10 @@ def test_output_with_verbose(self) -> None:
             out=out,
             code=4,
         )
-        assert "Checked 1 files, skipped 1 files/modules" in out.getvalue().strip()
+        stripped = out.getvalue().strip()
+        assert "Checked 1 files/modules" in stripped
+        assert "unnecessary_lambda.py" in stripped
+        assert "skipped 0 files/modules" in stripped
 
     def test_no_out_encoding(self) -> None:
         """Test redirection of stdout with non ascii characters."""