mirror of https://github.com/astral-sh/ruff
Fix docs for `PLW1508` (#6602)
This commit is contained in:
parent
a3d4f08f29
commit
097db2fcce
|
|
@ -5,25 +5,29 @@ use ruff_python_ast::{self as ast, Constant, Expr, Operator, Ranged};
|
||||||
use crate::checkers::ast::Checker;
|
use crate::checkers::ast::Checker;
|
||||||
|
|
||||||
/// ## What it does
|
/// ## What it does
|
||||||
/// Checks for `env.getenv` calls with invalid default values.
|
/// Checks for `os.getenv` calls with invalid default values.
|
||||||
///
|
///
|
||||||
/// ## Why is this bad?
|
/// ## Why is this bad?
|
||||||
/// If an environment variable is set, `env.getenv` will return its value as
|
/// If an environment variable is set, `os.getenv` will return its value as
|
||||||
/// a string. If the environment variable is _not_ set, `env.getenv` will
|
/// a string. If the environment variable is _not_ set, `os.getenv` will
|
||||||
/// return `None`, or the default value if one is provided.
|
/// return `None`, or the default value if one is provided.
|
||||||
///
|
///
|
||||||
/// If the default value is not a string or `None`, then it will be
|
/// If the default value is not a string or `None`, then it will be
|
||||||
/// inconsistent with the return type of `env.getenv`, which can lead to
|
/// inconsistent with the return type of `os.getenv`, which can lead to
|
||||||
/// confusing behavior.
|
/// confusing behavior.
|
||||||
///
|
///
|
||||||
/// ## Example
|
/// ## Example
|
||||||
/// ```python
|
/// ```python
|
||||||
/// int(env.getenv("FOO", 1))
|
/// import os
|
||||||
|
///
|
||||||
|
/// int(os.getenv("FOO", 1))
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// Use instead:
|
/// Use instead:
|
||||||
/// ```python
|
/// ```python
|
||||||
/// int(env.getenv("FOO", "1"))
|
/// import os
|
||||||
|
///
|
||||||
|
/// int(os.getenv("FOO", "1"))
|
||||||
/// ```
|
/// ```
|
||||||
#[violation]
|
#[violation]
|
||||||
pub struct InvalidEnvvarDefault;
|
pub struct InvalidEnvvarDefault;
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue