Skip to content

[logging-too-few-args] Raise for format strings with no interpolation at all #10321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/whatsnew/fragments/9999.false_negative
Original file line number Diff line number Diff line change
@@ -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
5 changes: 0 additions & 5 deletions pylint/checkers/logging.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
1 change: 0 additions & 1 deletion tests/config/data/logging_format_interpolation_style.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import logging

logging.error("constant string")
logging.error("{}")
logging.error("{}", 1)
logging.error("{0}", 1)
logging.error("{named}", {"named": 1})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
import logging

logging.error("constant string")
logging.error("{}")
logging.error("{}", 1)
logging.error("{0}", 1)
logging.error("{named}", {"named": 1})
Expand Down
6 changes: 0 additions & 6 deletions tests/functional/l/logging/logging_too_few_args.txt

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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]
Expand Down
9 changes: 9 additions & 0 deletions tests/functional/l/logging/logging_too_few_args_new_style.txt
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions tests/functional/l/logging/logging_too_few_args_old_style.py
Original file line number Diff line number Diff line change
@@ -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]
2 changes: 2 additions & 0 deletions tests/functional/l/logging/logging_too_few_args_old_style.rc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[LOGGING]
logging-format-style=old
2 changes: 2 additions & 0 deletions tests/functional/l/logging/logging_too_few_args_old_style.txt
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion tests/functional/s/string/string_log_formatting.py
Original file line number Diff line number Diff line change
Expand Up @@ -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', '', '')
1 change: 1 addition & 0 deletions tests/functional/s/string/string_log_formatting.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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