-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement E0308 - invalid-bytes-returned
- Loading branch information
1 parent
4284e07
commit be811c6
Showing
8 changed files
with
155 additions
and
0 deletions.
There are no files selected for viewing
35 changes: 35 additions & 0 deletions
35
crates/ruff_linter/resources/test/fixtures/pylint/invalid_return_type_bytes.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# These testcases should raise errors | ||
|
||
class Float: | ||
def __bytes__(self): | ||
return 3.05 # [invalid-bytes-return] | ||
|
||
class Int: | ||
def __bytes__(self): | ||
return 0 # [invalid-bytes-return] | ||
|
||
class Str: | ||
def __bytes__(self): | ||
return "some bytes" # [invalid-bytes-return] | ||
|
||
# TODO: Once Ruff has better type checking | ||
def return_bytes(): | ||
return "some string" | ||
|
||
class ComplexReturn: | ||
def __bytes__(self): | ||
return return_bytes() # [invalid-bytes-return] | ||
|
||
|
||
|
||
# These testcases should NOT raise errors | ||
|
||
class Bytes: | ||
def __bytes__(self): | ||
return b"some bytes" | ||
|
||
|
||
class Bytes2: | ||
def __bytes__(self): | ||
x = b"some bytes" | ||
return x |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
crates/ruff_linter/src/rules/pylint/rules/invalid_bytes_return.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
use ruff_diagnostics::{Diagnostic, Violation}; | ||
use ruff_macros::{derive_message_formats, violation}; | ||
use ruff_python_ast::helpers::ReturnStatementVisitor; | ||
use ruff_python_ast::visitor::Visitor; | ||
use ruff_python_ast::Stmt; | ||
use ruff_python_semantic::analyze::type_inference::{PythonType, ResolvedPythonType}; | ||
use ruff_text_size::Ranged; | ||
|
||
use crate::checkers::ast::Checker; | ||
|
||
/// ## What it does | ||
/// Checks for `__bytes__` implementations that return a type other than `bytes`. | ||
/// | ||
/// ## Why is this bad? | ||
/// The `__bytes__` method should return a `bytes` object. Returning a different | ||
/// type may cause unexpected behavior. | ||
/// | ||
/// ## Example | ||
/// ```python | ||
/// class Foo: | ||
/// def __bytes__(self): | ||
/// return 2 | ||
/// ``` | ||
/// | ||
/// Use instead: | ||
/// ```python | ||
/// class Foo: | ||
/// def __bytes__(self): | ||
/// return b"2" | ||
/// ``` | ||
/// | ||
/// ## References | ||
/// - [Python documentation: The `__bytes__` method](https://docs.python.org/3/reference/datamodel.html#object.__bytes__) | ||
#[violation] | ||
pub struct InvalidBytesReturnType; | ||
|
||
impl Violation for InvalidBytesReturnType { | ||
#[derive_message_formats] | ||
fn message(&self) -> String { | ||
format!("`__bytes__` does not return `bytes`") | ||
} | ||
} | ||
|
||
/// E0308 | ||
pub(crate) fn invalid_bytes_return(checker: &mut Checker, name: &str, body: &[Stmt]) { | ||
if name != "__bytes__" { | ||
return; | ||
} | ||
|
||
if !checker.semantic().current_scope().kind.is_class() { | ||
return; | ||
} | ||
|
||
let returns = { | ||
let mut visitor = ReturnStatementVisitor::default(); | ||
visitor.visit_body(body); | ||
visitor.returns | ||
}; | ||
|
||
for stmt in returns { | ||
if let Some(value) = stmt.value.as_deref() { | ||
if !matches!( | ||
ResolvedPythonType::from(value), | ||
ResolvedPythonType::Unknown | ResolvedPythonType::Atom(PythonType::Bytes) | ||
) { | ||
checker | ||
.diagnostics | ||
.push(Diagnostic::new(InvalidBytesReturnType, value.range())); | ||
} | ||
} else { | ||
// Disallow implicit `None`. | ||
checker | ||
.diagnostics | ||
.push(Diagnostic::new(InvalidBytesReturnType, stmt.range())); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
...nt/snapshots/ruff_linter__rules__pylint__tests__PLE0308_invalid_return_type_bytes.py.snap
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
source: crates/ruff_linter/src/rules/pylint/mod.rs | ||
--- | ||
invalid_return_type_bytes.py:5:16: PLE0308 `__bytes__` does not return `bytes` | ||
| | ||
3 | class Float: | ||
4 | def __bytes__(self): | ||
5 | return 3.05 # [invalid-bytes-return] | ||
| ^^^^ PLE0308 | ||
6 | | ||
7 | class Int: | ||
| | ||
|
||
invalid_return_type_bytes.py:9:16: PLE0308 `__bytes__` does not return `bytes` | ||
| | ||
7 | class Int: | ||
8 | def __bytes__(self): | ||
9 | return 0 # [invalid-bytes-return] | ||
| ^ PLE0308 | ||
10 | | ||
11 | class Str: | ||
| | ||
|
||
invalid_return_type_bytes.py:13:16: PLE0308 `__bytes__` does not return `bytes` | ||
| | ||
11 | class Str: | ||
12 | def __bytes__(self): | ||
13 | return "some bytes" # [invalid-bytes-return] | ||
| ^^^^^^^^^^^^ PLE0308 | ||
14 | | ||
15 | # TODO: Once Ruff has better type checking | ||
| |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.