72 lines
2.3 KiB
Rust
72 lines
2.3 KiB
Rust
//! Settings for the `flake-annotations` plugin.
|
|
|
|
use ruff_macros::ConfigurationOptions;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, Default, ConfigurationOptions)]
|
|
#[serde(deny_unknown_fields, rename_all = "kebab-case")]
|
|
pub struct Options {
|
|
#[option(
|
|
doc = r#"
|
|
Whether to allow the omission of a return type hint for `__init__` if at least one
|
|
argument is annotated.
|
|
"#,
|
|
default = "false",
|
|
value_type = "bool",
|
|
example = "mypy-init-return = true"
|
|
)]
|
|
pub mypy_init_return: Option<bool>,
|
|
#[option(
|
|
doc = r#"
|
|
Whether to suppress `ANN000`-level errors for arguments matching the "dummy" variable
|
|
regex (like `_`).
|
|
"#,
|
|
default = "false",
|
|
value_type = "bool",
|
|
example = "suppress-dummy-args = true"
|
|
)]
|
|
pub suppress_dummy_args: Option<bool>,
|
|
#[option(
|
|
doc = r#"
|
|
Whether to suppress `ANN200`-level errors for functions that meet either of the
|
|
following criteria:
|
|
|
|
- Contain no `return` statement.
|
|
- Explicit `return` statement(s) all return `None` (explicitly or implicitly).
|
|
"#,
|
|
default = "false",
|
|
value_type = "bool",
|
|
example = "suppress-none-returning = true"
|
|
)]
|
|
pub suppress_none_returning: Option<bool>,
|
|
#[option(
|
|
doc = "Whether to suppress `ANN401` for dynamically typed `*args` and `**kwargs` \
|
|
arguments.",
|
|
default = "false",
|
|
value_type = "bool",
|
|
example = "allow-star-arg-any = true"
|
|
)]
|
|
pub allow_star_arg_any: Option<bool>,
|
|
}
|
|
|
|
#[derive(Debug, Hash, Default)]
|
|
#[allow(clippy::struct_excessive_bools)]
|
|
pub struct Settings {
|
|
pub mypy_init_return: bool,
|
|
pub suppress_dummy_args: bool,
|
|
pub suppress_none_returning: bool,
|
|
pub allow_star_arg_any: bool,
|
|
}
|
|
|
|
impl Settings {
|
|
#[allow(clippy::needless_pass_by_value)]
|
|
pub fn from_options(options: Options) -> Self {
|
|
Self {
|
|
mypy_init_return: options.mypy_init_return.unwrap_or_default(),
|
|
suppress_dummy_args: options.suppress_dummy_args.unwrap_or_default(),
|
|
suppress_none_returning: options.suppress_none_returning.unwrap_or_default(),
|
|
allow_star_arg_any: options.allow_star_arg_any.unwrap_or_default(),
|
|
}
|
|
}
|
|
}
|