language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-30 13:51:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Support IfExp with dual string arms in invalid-envvar-default (#9734)

Browse source 
## Summary

Just like #6537 and #6538 but for the `default` second parameter to
`getenv()`.

Also rename "BAD" to "BAR" in the tests, since those strings shouldn't
trigger the rule.

## Test Plan

Added passing and failing examples to `invalid_envvar_default.py`.
This commit is contained in:
Christopher Covington 2024-01-31 15:41:24 +00:00 • committed by GitHub
parent 9e3ff01ce8
commit 7ae7bf6e30
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 25 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

53
crates/ruff_linter/src/rules/pylint/rules/invalid_envvar_default.rs
View file

@ -1,6 +1,7 @@
use ruff_diagnostics::{Diagnostic, Violation};
use ruff_macros::{derive_message_formats, violation};
use ruff_python_ast::{self as ast, Expr, Operator};
use ruff_python_ast as ast;
use ruff_python_semantic::analyze::type_inference::{PythonType, ResolvedPythonType};
use ruff_text_size::Ranged;
use crate::checkers::ast::Checker;
@ -40,43 +41,6 @@ impl Violation for InvalidEnvvarDefault {
}
}
fn is_valid_default(expr: &Expr) -> bool {
// We can't infer the types of these defaults, so assume they're valid.
if matches!(
expr,
Expr::Name(_) | Expr::Attribute(_) | Expr::Subscript(_) | Expr::Call(_)
) {
return true;
}
// Allow string concatenation.
if let Expr::BinOp(ast::ExprBinOp {
left,
right,
op: Operator::Add,
range: _,
}) = expr
{
return is_valid_default(left) && is_valid_default(right);
}
// Allow string formatting.
if let Expr::BinOp(ast::ExprBinOp {
left,
op: Operator::Mod,
..
}) = expr
{
return is_valid_default(left);
}
// Otherwise, the default must be a string or `None`.
matches!(
expr,
Expr::StringLiteral(_) | Expr::NoneLiteral(_) | Expr::FString(_)
)
}
/// PLW1508
pub(crate) fn invalid_envvar_default(checker: &mut Checker, call: &ast::ExprCall) {
if checker
@ -89,10 +53,15 @@ pub(crate) fn invalid_envvar_default(checker: &mut Checker, call: &ast::ExprCall
return;
};
if !is_valid_default(expr) {
checker
.diagnostics
.push(Diagnostic::new(InvalidEnvvarDefault, expr.range()));
if matches!(
ResolvedPythonType::from(expr),
ResolvedPythonType::Unknown
| ResolvedPythonType::Atom(PythonType::String | PythonType::None)
) {
return;
}
checker
.diagnostics
.push(Diagnostic::new(InvalidEnvvarDefault, expr.range()));
}
}

12
crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW1508_invalid_envvar_default.py.snap
View file

@ -34,11 +34,19 @@ invalid_envvar_default.py:6:25: PLW1508 Invalid type for environment variable de
invalid_envvar_default.py:10:17: PLW1508 Invalid type for environment variable default; expected `str` or `None`
|
8 | os.getenv("AA", f"GOOD")
9 | os.getenv("AA", "GOOD" + "BAD")
9 | os.getenv("AA", "GOOD" + "BAR")
10 | os.getenv("AA", "GOOD" + 1)
| ^^^^^^^^^^ PLW1508
11 | os.getenv("AA", "GOOD %s" % "BAD")
11 | os.getenv("AA", "GOOD %s" % "BAR")
12 | os.getenv("B", Z)
|
invalid_envvar_default.py:14:17: PLW1508 Invalid type for environment variable default; expected `str` or `None`
|
12 | os.getenv("B", Z)
13 | os.getenv("AA", "GOOD" if Z else "BAR")
14 | os.getenv("AA", 1 if Z else "BAR") # [invalid-envvar-default]
| ^^^^^^^^^^^^^^^^^ PLW1508
|