mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-04 02:38:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Remove flatten to improve deserialization error messages (#15414)

Browse source 
## Summary

Closes: #9719  

## Test Plan

**Before:**

```
ruff failed
  Cause: Failed to parse /Users/dhruv/playground/ruff/pyproject.toml
  Cause: TOML parse error at line 22, column 1
   |
22 | [tool.ruff.lint]
   | ^^^^^^^^^^^^^^^^
invalid type: string "false", expected a boolean
```

**After:**

```
ruff failed
  Cause: Failed to parse /Users/dhruv/playground/ruff/pyproject.toml
  Cause: TOML parse error at line 27, column 20
   |
27 | mypy-init-return = "false"
   |                    ^^^^^^^
invalid type: string "false", expected a boolean
```
This commit is contained in:
Dhruv Manilawala 2025-01-11 22:08:21 +05:30 • committed by GitHub
parent c39ca8fe6d
commit 38f873ba52
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 186 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

172
crates/ruff_workspace/src/options.rs
View file

@ -438,7 +438,11 @@ pub struct Options {
/// Options specified in the `lint` section take precedence over the deprecated top-level settings.
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
#[derive(Clone, Debug, PartialEq, Eq, Default, OptionsMetadata, Serialize, Deserialize)]
#[serde(deny_unknown_fields, rename_all = "kebab-case")]
#[serde(
from = "LintOptionsWire",
deny_unknown_fields,
rename_all = "kebab-case"
)]
pub struct LintOptions {
#[serde(flatten)]
pub common: LintCommonOptions,
@ -3535,6 +3539,172 @@ pub struct AnalyzeOptions {
pub include_dependencies: Option<BTreeMap<PathBuf, Vec<String>>>,
}
/// Like [`LintCommonOptions`], but with any `#[serde(flatten)]` fields inlined. This leads to far,
/// far better error messages when deserializing.
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(rename_all = "kebab-case", deny_unknown_fields)]
pub struct LintOptionsWire {
// common: LintCommonOptions
allowed_confusables: Option<Vec<char>>,
dummy_variable_rgx: Option<String>,
extend_ignore: Option<Vec<RuleSelector>>,
extend_select: Option<Vec<RuleSelector>>,
extend_fixable: Option<Vec<RuleSelector>>,
extend_unfixable: Option<Vec<RuleSelector>>,
external: Option<Vec<String>>,
fixable: Option<Vec<RuleSelector>>,
ignore: Option<Vec<RuleSelector>>,
extend_safe_fixes: Option<Vec<RuleSelector>>,
extend_unsafe_fixes: Option<Vec<RuleSelector>>,
ignore_init_module_imports: Option<bool>,
logger_objects: Option<Vec<String>>,
select: Option<Vec<RuleSelector>>,
explicit_preview_rules: Option<bool>,
task_tags: Option<Vec<String>>,
typing_modules: Option<Vec<String>>,
unfixable: Option<Vec<RuleSelector>>,
flake8_annotations: Option<Flake8AnnotationsOptions>,
flake8_bandit: Option<Flake8BanditOptions>,
flake8_boolean_trap: Option<Flake8BooleanTrapOptions>,
flake8_bugbear: Option<Flake8BugbearOptions>,
flake8_builtins: Option<Flake8BuiltinsOptions>,
flake8_comprehensions: Option<Flake8ComprehensionsOptions>,
flake8_copyright: Option<Flake8CopyrightOptions>,
flake8_errmsg: Option<Flake8ErrMsgOptions>,
flake8_quotes: Option<Flake8QuotesOptions>,
flake8_self: Option<Flake8SelfOptions>,
flake8_tidy_imports: Option<Flake8TidyImportsOptions>,
flake8_type_checking: Option<Flake8TypeCheckingOptions>,
flake8_gettext: Option<Flake8GetTextOptions>,
flake8_implicit_str_concat: Option<Flake8ImplicitStrConcatOptions>,
flake8_import_conventions: Option<Flake8ImportConventionsOptions>,
flake8_pytest_style: Option<Flake8PytestStyleOptions>,
flake8_unused_arguments: Option<Flake8UnusedArgumentsOptions>,
isort: Option<IsortOptions>,
mccabe: Option<McCabeOptions>,
pep8_naming: Option<Pep8NamingOptions>,
pycodestyle: Option<PycodestyleOptions>,
pydocstyle: Option<PydocstyleOptions>,
pyflakes: Option<PyflakesOptions>,
pylint: Option<PylintOptions>,
pyupgrade: Option<PyUpgradeOptions>,
per_file_ignores: Option<FxHashMap<String, Vec<RuleSelector>>>,
extend_per_file_ignores: Option<FxHashMap<String, Vec<RuleSelector>>>,
exclude: Option<Vec<String>>,
ruff: Option<RuffOptions>,
preview: Option<bool>,
}
impl From<LintOptionsWire> for LintOptions {
fn from(value: LintOptionsWire) -> LintOptions {
let LintOptionsWire {
allowed_confusables,
dummy_variable_rgx,
extend_ignore,
extend_select,
extend_fixable,
extend_unfixable,
external,
fixable,
ignore,
extend_safe_fixes,
extend_unsafe_fixes,
ignore_init_module_imports,
logger_objects,
select,
explicit_preview_rules,
task_tags,
typing_modules,
unfixable,
flake8_annotations,
flake8_bandit,
flake8_boolean_trap,
flake8_bugbear,
flake8_builtins,
flake8_comprehensions,
flake8_copyright,
flake8_errmsg,
flake8_quotes,
flake8_self,
flake8_tidy_imports,
flake8_type_checking,
flake8_gettext,
flake8_implicit_str_concat,
flake8_import_conventions,
flake8_pytest_style,
flake8_unused_arguments,
isort,
mccabe,
pep8_naming,
pycodestyle,
pydocstyle,
pyflakes,
pylint,
pyupgrade,
per_file_ignores,
extend_per_file_ignores,
exclude,
ruff,
preview,
} = value;
LintOptions {
#[allow(deprecated)]
common: LintCommonOptions {
allowed_confusables,
dummy_variable_rgx,
extend_ignore,
extend_select,
extend_fixable,
extend_unfixable,
external,
fixable,
ignore,
extend_safe_fixes,
extend_unsafe_fixes,
ignore_init_module_imports,
logger_objects,
select,
explicit_preview_rules,
task_tags,
typing_modules,
unfixable,
flake8_annotations,
flake8_bandit,
flake8_boolean_trap,
flake8_bugbear,
flake8_builtins,
flake8_comprehensions,
flake8_copyright,
flake8_errmsg,
flake8_quotes,
flake8_self,
flake8_tidy_imports,
flake8_type_checking,
flake8_gettext,
flake8_implicit_str_concat,
flake8_import_conventions,
flake8_pytest_style,
flake8_unused_arguments,
isort,
mccabe,
pep8_naming,
pycodestyle,
pydocstyle,
pyflakes,
pylint,
pyupgrade,
per_file_ignores,
extend_per_file_ignores,
},
exclude,
ruff,
preview,
}
}
}
#[cfg(test)]
mod tests {
use crate::options::Flake8SelfOptions;