Skip to content

Suggest typing.Literal for exit-return error messages #18541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Suggest typing.Literal for exit-return error messages #18541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion mypy/messages.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1992,7 +1992,7 @@ def incorrect__exit__return(self, context: Context) -> None:
code=codes.EXIT_RETURN,
)
self.note(
'Use "typing_extensions.Literal[False]" as the return type or change it to "None"',
'Use "typing.Literal[False]" as the return type or change it to "None"',
context,
code=codes.EXIT_RETURN,
)
Expand Down
2 changes: 1 addition & 1 deletion test-data/unit/check-errorcodes.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -729,7 +729,7 @@ main:2: error: Syntax error in type comment "int" [syntax]
[case testErrorCode__exit__Return]
class InvalidReturn:
def __exit__(self, x, y, z) -> bool: # E: "bool" is invalid as return type for "__exit__" that always returns False [exit-return] \
# N: Use "typing_extensions.Literal[False]" as the return type or change it to "None" \
# N: Use "typing.Literal[False]" as the return type or change it to "None" \
# N: If return type of "__exit__" implies that it may return True, the context manager may swallow exceptions
return False
[builtins fixtures/bool.pyi]
Expand Down
6 changes: 3 additions & 3 deletions test-data/unit/check-statements.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1527,13 +1527,13 @@ from typing import Optional

class InvalidReturn1:
def __exit__(self, x, y, z) -> bool: # E: "bool" is invalid as return type for "__exit__" that always returns False \
# N: Use "typing_extensions.Literal[False]" as the return type or change it to "None" \
# N: Use "typing.Literal[False]" as the return type or change it to "None" \
# N: If return type of "__exit__" implies that it may return True, the context manager may swallow exceptions
return False

class InvalidReturn2:
def __exit__(self, x, y, z) -> Optional[bool]: # E: "bool" is invalid as return type for "__exit__" that always returns False \
# N: Use "typing_extensions.Literal[False]" as the return type or change it to "None" \
# N: Use "typing.Literal[False]" as the return type or change it to "None" \
# N: If return type of "__exit__" implies that it may return True, the context manager may swallow exceptions
if int():
return False
Expand All @@ -1542,7 +1542,7 @@ class InvalidReturn2:

class InvalidReturn3:
def __exit__(self, x, y, z) -> bool: # E: "bool" is invalid as return type for "__exit__" that always returns False \
# N: Use "typing_extensions.Literal[False]" as the return type or change it to "None" \
# N: Use "typing.Literal[False]" as the return type or change it to "None" \
# N: If return type of "__exit__" implies that it may return True, the context manager may swallow exceptions
def nested() -> bool:
return True
Expand Down
Loading