-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Summary Implements [FURB152](https://github.com/dosisod/refurb/blob/master/docs/checks.md#furb152-use-math-constant) that checks for literals that are similar to constants in `math` module, for example: ```python A = 3.141592 * r ** 2 ``` Use instead: ```python A = math.pi * r ** 2 ``` Related to #1348.
- Loading branch information
Showing
9 changed files
with
175 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
r = 3.1 # OK | ||
|
||
A = 3.14 * r ** 2 # FURB152 | ||
|
||
C = 6.28 * r # FURB152 | ||
|
||
e = 2.71 # FURB152 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
90 changes: 90 additions & 0 deletions
90
crates/ruff_linter/src/rules/refurb/rules/math_constant.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
use anyhow::Result; | ||
|
||
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; | ||
use ruff_macros::{derive_message_formats, violation}; | ||
use ruff_python_ast::{self as ast, Number}; | ||
use ruff_text_size::Ranged; | ||
|
||
use crate::checkers::ast::Checker; | ||
use crate::importer::ImportRequest; | ||
|
||
/// ## What it does | ||
/// Checks for literals that are similar to constants in `math` module. | ||
/// | ||
/// ## Why is this bad? | ||
/// Hard-coding mathematical constants like π increases code duplication, | ||
/// reduces readability, and may lead to a lack of precision. | ||
/// | ||
/// ## Example | ||
/// ```python | ||
/// A = 3.141592 * r**2 | ||
/// ``` | ||
/// | ||
/// Use instead: | ||
/// ```python | ||
/// A = math.pi * r**2 | ||
/// ``` | ||
/// | ||
/// ## References | ||
/// - [Python documentation: `math` constants](https://docs.python.org/3/library/math.html#constants) | ||
#[violation] | ||
pub struct MathConstant { | ||
literal: String, | ||
constant: &'static str, | ||
} | ||
|
||
impl Violation for MathConstant { | ||
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Sometimes; | ||
|
||
#[derive_message_formats] | ||
fn message(&self) -> String { | ||
let MathConstant { literal, constant } = self; | ||
format!("Replace `{literal}` with `math.{constant}`") | ||
} | ||
|
||
fn fix_title(&self) -> Option<String> { | ||
let MathConstant { constant, .. } = self; | ||
Some(format!("Use `math.{constant}`")) | ||
} | ||
} | ||
|
||
/// FURB152 | ||
pub(crate) fn math_constant(checker: &mut Checker, literal: &ast::ExprNumberLiteral) { | ||
let Number::Float(value) = literal.value else { | ||
return; | ||
}; | ||
for (real_value, constant) in [ | ||
(std::f64::consts::PI, "pi"), | ||
(std::f64::consts::E, "e"), | ||
(std::f64::consts::TAU, "tau"), | ||
] { | ||
if (value - real_value).abs() < 1e-2 { | ||
let mut diagnostic = Diagnostic::new( | ||
MathConstant { | ||
literal: checker.locator().slice(literal).into(), | ||
constant, | ||
}, | ||
literal.range(), | ||
); | ||
diagnostic.try_set_fix(|| convert_to_constant(literal, constant, checker)); | ||
checker.diagnostics.push(diagnostic); | ||
return; | ||
} | ||
} | ||
} | ||
|
||
fn convert_to_constant( | ||
literal: &ast::ExprNumberLiteral, | ||
constant: &'static str, | ||
checker: &Checker, | ||
) -> Result<Fix> { | ||
let (edit, binding) = checker.importer().get_or_import_symbol( | ||
&ImportRequest::import("math", constant), | ||
literal.start(), | ||
checker.semantic(), | ||
)?; | ||
Ok(Fix::safe_edits( | ||
Edit::range_replacement(binding, literal.range()), | ||
[edit], | ||
)) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
...ter/src/rules/refurb/snapshots/ruff_linter__rules__refurb__tests__FURB152_FURB152.py.snap
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
source: crates/ruff_linter/src/rules/refurb/mod.rs | ||
--- | ||
FURB152.py:3:5: FURB152 [*] Replace `3.14` with `math.pi` | ||
| | ||
1 | r = 3.1 # OK | ||
2 | | ||
3 | A = 3.14 * r ** 2 # FURB152 | ||
| ^^^^ FURB152 | ||
4 | | ||
5 | C = 6.28 * r # FURB152 | ||
| | ||
= help: Use `math.pi` | ||
|
||
ℹ Safe fix | ||
1 |+import math | ||
1 2 | r = 3.1 # OK | ||
2 3 | | ||
3 |-A = 3.14 * r ** 2 # FURB152 | ||
4 |+A = math.pi * r ** 2 # FURB152 | ||
4 5 | | ||
5 6 | C = 6.28 * r # FURB152 | ||
6 7 | | ||
|
||
FURB152.py:5:5: FURB152 [*] Replace `6.28` with `math.tau` | ||
| | ||
3 | A = 3.14 * r ** 2 # FURB152 | ||
4 | | ||
5 | C = 6.28 * r # FURB152 | ||
| ^^^^ FURB152 | ||
6 | | ||
7 | e = 2.71 # FURB152 | ||
| | ||
= help: Use `math.tau` | ||
|
||
ℹ Safe fix | ||
1 |+import math | ||
1 2 | r = 3.1 # OK | ||
2 3 | | ||
3 4 | A = 3.14 * r ** 2 # FURB152 | ||
4 5 | | ||
5 |-C = 6.28 * r # FURB152 | ||
6 |+C = math.tau * r # FURB152 | ||
6 7 | | ||
7 8 | e = 2.71 # FURB152 | ||
|
||
FURB152.py:7:5: FURB152 [*] Replace `2.71` with `math.e` | ||
| | ||
5 | C = 6.28 * r # FURB152 | ||
6 | | ||
7 | e = 2.71 # FURB152 | ||
| ^^^^ FURB152 | ||
| | ||
= help: Use `math.e` | ||
|
||
ℹ Safe fix | ||
1 |+import math | ||
1 2 | r = 3.1 # OK | ||
2 3 | | ||
3 4 | A = 3.14 * r ** 2 # FURB152 | ||
4 5 | | ||
5 6 | C = 6.28 * r # FURB152 | ||
6 7 | | ||
7 |-e = 2.71 # FURB152 | ||
8 |+e = math.e # FURB152 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.