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

Refactor flake8_tidy_imports rules to consistently take Checker #4023

Merged
merged 1 commit into from
Apr 19, 2023
Merged

Refactor flake8_tidy_imports rules to consistently take Checker #4023

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 9 additions & 27 deletions crates/ruff/src/checkers/ast/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -970,15 +970,11 @@ where

// flake8_tidy_imports
if self.settings.rules.enabled(Rule::BannedApi) {
if let Some(diagnostic) =
flake8_tidy_imports::banned_api::name_or_parent_is_banned(
alias,
&alias.node.name,
&self.settings.flake8_tidy_imports.banned_api,
)
{
self.diagnostics.push(diagnostic);
}
flake8_tidy_imports::banned_api::name_or_parent_is_banned(
self,
&alias.node.name,
alias,
);
}

// pylint
Expand Down Expand Up @@ -1161,25 +1157,11 @@ where
if self.settings.rules.enabled(Rule::BannedApi) {
if let Some(module) = module {
for name in names {
if let Some(diagnostic) =
flake8_tidy_imports::banned_api::name_is_banned(
module,
name,
&self.settings.flake8_tidy_imports.banned_api,
)
{
self.diagnostics.push(diagnostic);
}
}
if let Some(diagnostic) =
flake8_tidy_imports::banned_api::name_or_parent_is_banned(
stmt,
module,
&self.settings.flake8_tidy_imports.banned_api,
)
{
self.diagnostics.push(diagnostic);
flake8_tidy_imports::banned_api::name_is_banned(self, module, name);
}
flake8_tidy_imports::banned_api::name_or_parent_is_banned(
self, module, stmt,
);
}
}

Expand Down
35 changes: 13 additions & 22 deletions crates/ruff/src/rules/flake8_tidy_imports/banned_api.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,57 +51,49 @@ impl Violation for BannedApi {
}

/// TID251
pub fn name_is_banned(
module: &str,
name: &Alias,
api_bans: &FxHashMap<String, ApiBan>,
) -> Option<Diagnostic> {
pub fn name_is_banned(checker: &mut Checker, module: &str, name: &Alias) {
let banned_api = &checker.settings.flake8_tidy_imports.banned_api;
let full_name = format!("{module}.{}", &name.node.name);
if let Some(ban) = api_bans.get(&full_name) {
return Some(Diagnostic::new(
if let Some(ban) = banned_api.get(&full_name) {
checker.diagnostics.push(Diagnostic::new(
BannedApi {
name: full_name,
message: ban.msg.to_string(),
},
Range::from(name),
));
}
None
}

/// TID251
pub fn name_or_parent_is_banned<T>(
located: &Located<T>,
name: &str,
api_bans: &FxHashMap<String, ApiBan>,
) -> Option<Diagnostic> {
pub fn name_or_parent_is_banned<T>(checker: &mut Checker, name: &str, located: &Located<T>) {
let banned_api = &checker.settings.flake8_tidy_imports.banned_api;
let mut name = name;
loop {
if let Some(ban) = api_bans.get(name) {
return Some(Diagnostic::new(
if let Some(ban) = banned_api.get(name) {
checker.diagnostics.push(Diagnostic::new(
BannedApi {
name: name.to_string(),
message: ban.msg.to_string(),
},
Range::from(located),
));
return;
}
match name.rfind('.') {
Some(idx) => {
name = &name[..idx];
}
None => return None,
None => return,
}
}
}

/// TID251
pub fn banned_attribute_access(checker: &mut Checker, expr: &Expr) {
let banned_api = &checker.settings.flake8_tidy_imports.banned_api;
if let Some((banned_path, ban)) = checker.ctx.resolve_call_path(expr).and_then(|call_path| {
checker
.settings
.flake8_tidy_imports
.banned_api
banned_api
.iter()
.find(|(banned_path, ..)| call_path == from_qualified_name(banned_path))
}) {
Expand All @@ -119,11 +111,10 @@ pub fn banned_attribute_access(checker: &mut Checker, expr: &Expr) {
mod tests {
use std::path::Path;

use crate::assert_messages;
use anyhow::Result;

use rustc_hash::FxHashMap;

use crate::assert_messages;
use crate::registry::Rule;
use crate::settings::Settings;
use crate::test::test_path;
Expand Down