Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,20 @@ def f(cond: bool) -> int:
return 2
```

## Invalid implicit return type always None

<!-- snapshot-diagnostics -->

If the function has no `return` statement or if it has only bare `return` statement (no variable in
the return statement), then we show a diagnostic hint that the return annotation should be
`-> None`.
Comment thread
carljm marked this conversation as resolved.
Outdated

```py
# error: [invalid-return-type] "Function always implicitly return `None`, which is not assignable to return type `int`"
Comment thread
carljm marked this conversation as resolved.
Outdated
def f() -> int:
print("hello")
```

## NotImplemented

### Default Python version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,14 @@ mdtest path: crates/ty_python_semantic/resources/mdtest/function/return_type.md
# Diagnostics

```
error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `str`
error[invalid-return-type]: Function always implicitly return `None`, which is not assignable to return type `str`
--> src/mdtest_snippet.py:7:25
|
6 | class Concrete(Abstract):
7 | def method(self) -> str: ... # error: [invalid-return-type]
| ^^^
|
info: Consider changing your return annotation to `-> None`
info: Only functions in stub files, methods on protocol classes, or methods with `@abstractmethod` are permitted to have empty bodies
info: Class `Concrete` has `typing.Protocol` in its MRO, but it is not a protocol class
info: Only classes that directly inherit from `typing.Protocol` or `typing_extensions.Protocol` are considered protocol classes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ info: rule `invalid-return-type` is enabled by default
```

```
error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `int`
error[invalid-return-type]: Function always implicitly return `None`, which is not assignable to return type `int`
--> src/mdtest_snippet.py:12:22
|
11 | # error: [invalid-return-type]
Expand All @@ -80,6 +80,7 @@ error[invalid-return-type]: Function can implicitly return `None`, which is not
13 | if cond:
14 | raise ValueError()
|
info: Consider changing your return annotation to `-> None`
info: rule `invalid-return-type` is enabled by default

```
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
source: crates/ty_test/src/lib.rs
expression: snapshot
---
---
mdtest name: return_type.md - Function return type - Invalid implicit return type always None
mdtest path: crates/ty_python_semantic/resources/mdtest/function/return_type.md
---

# Python source files

## mdtest_snippet.py

```
1 | # error: [invalid-return-type] "Function always implicitly return `None`, which is not assignable to return type `int`"
2 | def f() -> int:
3 | print("hello")
```

# Diagnostics

```
error[invalid-return-type]: Function always implicitly return `None`, which is not assignable to return type `int`
--> src/mdtest_snippet.py:2:12
|
1 | # error: [invalid-return-type] "Function always implicitly return `None`, which is not assignable to return type `int`"
2 | def f() -> int:
| ^^^
3 | print("hello")
|
info: Consider changing your return annotation to `-> None`
info: rule `invalid-return-type` is enabled by default

```
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,15 @@ mdtest path: crates/ty_python_semantic/resources/mdtest/function/return_type.md
# Diagnostics

```
error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `int`
error[invalid-return-type]: Function always implicitly return `None`, which is not assignable to return type `int`
--> src/mdtest_snippet.py:2:12
|
1 | # error: [invalid-return-type]
2 | def f() -> int:
| ^^^
3 | 1
|
info: Consider changing your return annotation to `-> None`
info: rule `invalid-return-type` is enabled by default

```
Expand Down Expand Up @@ -84,13 +85,14 @@ info: rule `invalid-return-type` is enabled by default
```

```
error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `T`
error[invalid-return-type]: Function always implicitly return `None`, which is not assignable to return type `T`
--> src/mdtest_snippet.py:18:16
|
17 | # error: [invalid-return-type]
18 | def m(x: T) -> T: ...
| ^
|
info: Consider changing your return annotation to `-> None`
info: rule `invalid-return-type` is enabled by default

```
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ info: rule `invalid-return-type` is enabled by default
```

```
error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `int`
error[invalid-return-type]: Function always implicitly return `None`, which is not assignable to return type `int`
--> src/mdtest_snippet.pyi:6:14
|
5 | # error: [invalid-return-type]
Expand All @@ -55,12 +55,13 @@ error[invalid-return-type]: Function can implicitly return `None`, which is not
7 | print("...")
8 | ...
|
info: Consider changing your return annotation to `-> None`
info: rule `invalid-return-type` is enabled by default

```

```
error[invalid-return-type]: Function can implicitly return `None`, which is not assignable to return type `int`
error[invalid-return-type]: Function always implicitly return `None`, which is not assignable to return type `int`
--> src/mdtest_snippet.pyi:11:14
|
10 | # error: [invalid-return-type]
Expand All @@ -69,6 +70,7 @@ error[invalid-return-type]: Function can implicitly return `None`, which is not
12 | f"""{foo} is a function that ..."""
13 | ...
|
info: Consider changing your return annotation to `-> None`
info: rule `invalid-return-type` is enabled by default

```
20 changes: 16 additions & 4 deletions crates/ty_python_semantic/src/types/diagnostic.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1684,15 +1684,27 @@ pub(super) fn report_implicit_return_type(
expected_ty: Type,
has_empty_body: bool,
enclosing_class_of_method: Option<ClassLiteral>,
no_return: bool,
) {
let Some(builder) = context.report_lint(&INVALID_RETURN_TYPE, range) else {
return;
};
let db = context.db();
let mut diagnostic = builder.into_diagnostic(format_args!(
"Function can implicitly return `None`, which is not assignable to return type `{}`",
expected_ty.display(db)
));

// If no return statement is defined in the function, then the function always return `None`
Comment thread
carljm marked this conversation as resolved.
Outdated
let mut diagnostic = if no_return {
let mut diag = builder.into_diagnostic(format_args!(
"Function always implicitly return `None`, which is not assignable to return type `{}`",
Comment thread
carljm marked this conversation as resolved.
Outdated
expected_ty.display(db),
));
diag.info("Consider changing your return annotation to `-> None`");
Comment thread
carljm marked this conversation as resolved.
Outdated
diag
} else {
builder.into_diagnostic(format_args!(
"Function can implicitly return `None`, which is not assignable to return type `{}`",
expected_ty.display(db),
))
};
if !has_empty_body {
return;
}
Expand Down
2 changes: 2 additions & 0 deletions crates/ty_python_semantic/src/types/infer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1853,12 +1853,14 @@ impl<'db> TypeInferenceBuilder<'db> {
if use_def.can_implicit_return(self.db())
&& !Type::none(self.db()).is_assignable_to(self.db(), declared_ty)
{
let no_return = self.return_types_and_ranges.is_empty();
report_implicit_return_type(
&self.context,
returns.range(),
declared_ty,
has_empty_body,
enclosing_class_context,
no_return,
);
}
}
Expand Down