Skip to content
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.

Sign up for GitHub

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

Add support for .log(level, msg) calls in flake8-logging-format #3726

Merged
merged 4 commits into from
Mar 25, 2023
Merged

Add support for .log(level, msg) calls in flake8-logging-format #3726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eff4a16
Add support for `.log(level, msg)` calls
dhruvmanila Mar 25, 2023
b2f1902
Fix clippy warnings
dhruvmanila Mar 25, 2023
1339633
Merge branch 'main' into fix/detect-log-fn
charliermarsh Mar 25, 2023
8c77c57
Add test case for keyword arguments
charliermarsh Mar 25, 2023
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
4 changes: 4 additions & 0 deletions crates/ruff/resources/test/fixtures/flake8_logging_format/G001.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,8 @@
import logging as foo

logging.info("Hello {}".format("World!"))
logging.log(logging.INFO, "Hello {}".format("World!"))
charliermarsh marked this conversation as resolved.
Show resolved Hide resolved
foo.info("Hello {}".format("World!"))
logging.log(logging.INFO, msg="Hello {}".format("World!"))
logging.log(level=logging.INFO, msg="Hello {}".format("World!"))
logging.log(msg="Hello {}".format("World!"), level=logging.INFO)
1 change: 1 addition & 0 deletions crates/ruff/resources/test/fixtures/flake8_logging_format/G002.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import logging

logging.info("Hello %s" % "World!")
logging.log(logging.INFO, "Hello %s" % "World!")
1 change: 1 addition & 0 deletions crates/ruff/resources/test/fixtures/flake8_logging_format/G003.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import logging

logging.info("Hello" + " " + "World!")
logging.log(logging.INFO, "Hello" + " " + "World!")
1 change: 1 addition & 0 deletions crates/ruff/resources/test/fixtures/flake8_logging_format/G004.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@

name = "world"
logging.info(f"Hello {name}")
logging.log(logging.INFO, f"Hello {name}")
65 changes: 44 additions & 21 deletions crates/ruff/src/rules/flake8_logging_format/rules.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,14 +125,31 @@ fn check_log_record_attr_clash(checker: &mut Checker, extra: &Keyword) {
}
}

enum LoggingCallType {
/// Logging call with a level method, e.g., `logging.info`.
LevelCall(LoggingLevel),
/// Logging call with an integer level as an argument, e.g., `logger.log(level, ...)`.
LogCall,
}

impl LoggingCallType {
fn from_attribute(attr: &str) -> Option<Self> {
if attr == "log" {
Some(LoggingCallType::LogCall)
} else {
LoggingLevel::from_attribute(attr).map(LoggingCallType::LevelCall)
}
}
}

/// Check logging calls for violations.
pub fn logging_call(checker: &mut Checker, func: &Expr, args: &[Expr], keywords: &[Keyword]) {
if !is_logger_candidate(&checker.ctx, func) {
return;
}

if let ExprKind::Attribute { value, attr, .. } = &func.node {
if let Some(logging_level) = LoggingLevel::from_attribute(attr.as_str()) {
if let Some(logging_call_type) = LoggingCallType::from_attribute(attr.as_str()) {
let call_args = SimpleCallArgs::new(args, keywords);
let level_call_range = Range::new(
Location::new(
Expand All @@ -146,13 +163,17 @@ pub fn logging_call(checker: &mut Checker, func: &Expr, args: &[Expr], keywords:
);

// G001 - G004
if let Some(format_arg) = call_args.argument("msg", 0) {
let msg_pos = usize::from(matches!(logging_call_type, LoggingCallType::LogCall));
if let Some(format_arg) = call_args.argument("msg", msg_pos) {
check_msg(checker, format_arg);
}

// G010
if checker.settings.rules.enabled(Rule::LoggingWarn)
&& matches!(logging_level, LoggingLevel::Warn)
&& matches!(
logging_call_type,
LoggingCallType::LevelCall(LoggingLevel::Warn)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should extend this to warn on logging.log(logging.WARN, "...")

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Can be in a separate PR if needed, not even sure whether that's correct to flag.)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regarding the level variable, I'm not sure as the docs doesn't mention anything about it although the WARN level isn't mentioned in the levels table.

If we do decide to change it, it'll need to be updated wherever the level argument is accepted.

)
{
let mut diagnostic = Diagnostic::new(LoggingWarn, level_call_range);
if checker.patch(diagnostic.kind.rule()) {
Expand Down Expand Up @@ -204,27 +225,29 @@ pub fn logging_call(checker: &mut Checker, func: &Expr, args: &[Expr], keywords:
return;
}

match logging_level {
LoggingLevel::Error => {
if checker.settings.rules.enabled(Rule::LoggingExcInfo) {
checker
.diagnostics
.push(Diagnostic::new(LoggingExcInfo, level_call_range));
if let LoggingCallType::LevelCall(logging_level) = logging_call_type {
match logging_level {
LoggingLevel::Error => {
if checker.settings.rules.enabled(Rule::LoggingExcInfo) {
checker
.diagnostics
.push(Diagnostic::new(LoggingExcInfo, level_call_range));
}
}
}
LoggingLevel::Exception => {
if checker
.settings
.rules
.enabled(Rule::LoggingRedundantExcInfo)
{
checker.diagnostics.push(Diagnostic::new(
LoggingRedundantExcInfo,
Range::from(exc_info),
));
LoggingLevel::Exception => {
if checker
.settings
.rules
.enabled(Rule::LoggingRedundantExcInfo)
{
checker.diagnostics.push(Diagnostic::new(
LoggingRedundantExcInfo,
Range::from(exc_info),
));
}
}
_ => {}
}
_ => {}
}
}
}
Expand Down
54 changes: 53 additions & 1 deletion ...s/flake8_logging_format/snapshots/ruff__rules__flake8_logging_format__tests__G001.py.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,62 @@ expression: diagnostics
fixable: false
location:
row: 5
column: 9
column: 26
end_location:
row: 5
column: 53
fix: ~
parent: ~
- kind:
name: LoggingStringFormat
body: "Logging statement uses `string.format()`"
suggestion: ~
fixable: false
location:
row: 6
column: 9
end_location:
row: 6
column: 36
fix: ~
parent: ~
- kind:
name: LoggingStringFormat
body: "Logging statement uses `string.format()`"
suggestion: ~
fixable: false
location:
row: 7
column: 30
end_location:
row: 7
column: 57
fix: ~
parent: ~
- kind:
name: LoggingStringFormat
body: "Logging statement uses `string.format()`"
suggestion: ~
fixable: false
location:
row: 8
column: 36
end_location:
row: 8
column: 63
fix: ~
parent: ~
- kind:
name: LoggingStringFormat
body: "Logging statement uses `string.format()`"
suggestion: ~
fixable: false
location:
row: 9
column: 16
end_location:
row: 9
column: 43
fix: ~
parent: ~

13 changes: 13 additions & 0 deletions ...s/flake8_logging_format/snapshots/ruff__rules__flake8_logging_format__tests__G002.py.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,17 @@ expression: diagnostics
column: 34
fix: ~
parent: ~
- kind:
name: LoggingPercentFormat
body: "Logging statement uses `%`"
suggestion: ~
fixable: false
location:
row: 4
column: 26
end_location:
row: 4
column: 47
fix: ~
parent: ~

13 changes: 13 additions & 0 deletions ...s/flake8_logging_format/snapshots/ruff__rules__flake8_logging_format__tests__G003.py.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,17 @@ expression: diagnostics
column: 37
fix: ~
parent: ~
- kind:
name: LoggingStringConcat
body: "Logging statement uses `+`"
suggestion: ~
fixable: false
location:
row: 4
column: 26
end_location:
row: 4
column: 50
fix: ~
parent: ~

13 changes: 13 additions & 0 deletions ...s/flake8_logging_format/snapshots/ruff__rules__flake8_logging_format__tests__G004.py.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,17 @@ expression: diagnostics
column: 28
fix: ~
parent: ~
- kind:
name: LoggingFString
body: Logging statement uses f-string
suggestion: ~
fixable: false
location:
row: 5
column: 26
end_location:
row: 5
column: 41
fix: ~
parent: ~