-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[flake8-import-conventions
] Syntax check aliases supplied in configuration for unconventional-import-alias (ICN001)
#14477
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
Changes from 2 commits
5a3b3ce
83b5b5f
da079b7
bb3f6aa
6a3ad60
674bf6f
fbcfdad
14ad456
e1805e9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change | ||
---|---|---|---|---|
@@ -1,6 +1,7 @@ | ||||
use regex::Regex; | ||||
use rustc_hash::{FxBuildHasher, FxHashMap, FxHashSet}; | ||||
use serde::{Deserialize, Serialize}; | ||||
use serde::de::{self}; | ||||
use serde::{Deserialize, Deserializer, Serialize}; | ||||
use std::collections::BTreeMap; | ||||
use std::path::PathBuf; | ||||
use strum::IntoEnumIterator; | ||||
|
@@ -34,6 +35,7 @@ use ruff_macros::{CombineOptions, OptionsMetadata}; | |||
use ruff_python_ast::name::Name; | ||||
use ruff_python_formatter::{DocstringCodeLineWidth, QuoteStyle}; | ||||
use ruff_python_semantic::NameImports; | ||||
use ruff_python_stdlib::identifiers::is_identifier; | ||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Default, OptionsMetadata, Serialize, Deserialize)] | ||||
#[serde(deny_unknown_fields, rename_all = "kebab-case")] | ||||
|
@@ -1327,6 +1329,7 @@ pub struct Flake8ImportConventionsOptions { | |||
scipy = "sp" | ||||
"# | ||||
)] | ||||
#[serde(deserialize_with = "deserialize_and_validate_aliases")] | ||||
pub aliases: Option<FxHashMap<String, String>>, | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We would probably get better error messages if you create a newtype for There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This PR does actually already seem to be a small improvement on the status quo when it comes to line numbers. Currently if I make this change to typeshed's pyproject.toml file: diff --git a/pyproject.toml b/pyproject.toml
index 46014bcd2..927da6162 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -111,6 +111,9 @@ ignore = [
"E501", # Line too long
]
+[tool.ruff.lint.flake8-import-conventions.aliases]
+"pandas" = 42
+ Then Ruff v0.7.1 gives me this error message:
|
||||
|
||||
/// A mapping from module to conventional import alias. These aliases will | ||||
|
@@ -1370,6 +1373,30 @@ pub struct Flake8ImportConventionsOptions { | |||
pub banned_from: Option<FxHashSet<String>>, | ||||
} | ||||
|
||||
fn deserialize_and_validate_aliases<'de, D>( | ||||
deserializer: D, | ||||
) -> Result<Option<FxHashMap<String, String>>, D::Error> | ||||
where | ||||
D: Deserializer<'de>, | ||||
{ | ||||
let Some(aliases) = Option::<FxHashMap<String, String>>::deserialize(deserializer)? else { | ||||
return Ok(None); | ||||
}; | ||||
|
||||
for (module, alias) in &aliases { | ||||
if module.is_empty() | ||||
|| module.split('.').any(|part| !is_identifier(part)) | ||||
|| !is_identifier(alias) | ||||
{ | ||||
return Err(de::Error::custom( | ||||
"Module must be valid identifier separated by single periods and alias must be valid identifier", | ||||
)); | ||||
} | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I suggest that we use two dedicated errors: One for There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done! |
||||
} | ||||
|
||||
Ok(Some(aliases)) // Return the validated map. | ||||
} | ||||
|
||||
impl Flake8ImportConventionsOptions { | ||||
pub fn into_settings(self) -> flake8_import_conventions::settings::Settings { | ||||
let mut aliases = match self.aliases { | ||||
|
@@ -3406,12 +3433,20 @@ pub struct AnalyzeOptions { | |||
|
||||
#[cfg(test)] | ||||
mod tests { | ||||
use crate::options::Flake8ImportConventionsOptions; | ||||
use crate::options::Flake8SelfOptions; | ||||
use ruff_linter::rules::flake8_self; | ||||
use ruff_linter::settings::types::PythonVersion as LinterPythonVersion; | ||||
use ruff_python_ast::name::Name; | ||||
use ruff_python_formatter::PythonVersion as FormatterPythonVersion; | ||||
|
||||
#[test] | ||||
fn flake8_import_conventions_validate_aliases() { | ||||
let json_options = r#"{"aliases": {"a.b":"a.b"}}"#; | ||||
let result: Result<Flake8ImportConventionsOptions, _> = serde_json::from_str(json_options); | ||||
assert!(result.unwrap_err().to_string().contains("Module must be valid identifier separated by single periods and alias must be valid identifier")); | ||||
} | ||||
|
||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm leaning towards making this a ruff cli integration test. It then also demonstrates how the error message is displayed to the users. See ruff/crates/ruff/tests/lint.rs Line 23 in c847cad
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done! |
||||
#[test] | ||||
fn flake8_self_options() { | ||||
let default_settings = flake8_self::settings::Settings::default(); | ||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be a dev-dependency if it is only used in tests
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No longer used (test moved to integration test)