Skip to content

Disallow mutually exclusive arguments boolean and empty_value in admin display decorator #2211

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+75 −5
Open

Disallow mutually exclusive arguments boolean and empty_value in admin display decorator #2211

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
16 changes: 16 additions & 0 deletions django-stubs/contrib/admin/decorators.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ def display(
boolean: bool | None = ...,
ordering: str | Combinable | BaseExpression | None = ...,
description: _StrOrPromise | None = ...,
empty_value: None = ...,
) -> _F: ...
@overload
def display(
function: _F,
boolean: None = ...,
ordering: str | Combinable | BaseExpression | None = ...,
description: _StrOrPromise | None = ...,
empty_value: str | None = ...,
) -> _F: ...
@overload
Expand All @@ -36,6 +44,14 @@ def display(
boolean: bool | None = ...,
ordering: str | Combinable | BaseExpression | None = ...,
description: _StrOrPromise | None = ...,
empty_value: None = ...,
) -> Callable[[_F], _F]: ...
@overload
def display(
*,
boolean: None = ...,
ordering: str | Combinable | BaseExpression | None = ...,
description: _StrOrPromise | None = ...,
empty_value: str | None = ...,
) -> Callable[[_F], _F]: ...
def register(
Expand Down
64 changes: 59 additions & 5 deletions tests/typecheck/contrib/admin/test_decorators.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@
@admin.display
def display_bare(self) -> str: ...

@admin.display(boolean=True, ordering="field", description="Something", empty_value="...")
@admin.display(ordering="field", description="Something", empty_value="...")
def display_fancy(self) -> bool: ...

# Can also be a property
@property
@admin.display
def display_property(self) -> str: ...

@admin.display # E: Decorators on top of @property are not supported [misc]
@admin.display # E: Decorators on top of @property are not supported \[misc\]
@property
def incorrect_property(self) -> str: ...

def method(self) -> None:
reveal_type(self.display_bare) # N: Revealed type is "def () -> builtins.str"
reveal_type(self.display_fancy) # N: Revealed type is "def () -> builtins.bool"
reveal_type(self.display_bare) # N: Revealed type is "def \(\) -> builtins.str"
reveal_type(self.display_fancy) # N: Revealed type is "def \(\) -> builtins.bool"
reveal_type(self.display_fancy()) # N: Revealed type is "builtins.bool"
reveal_type(self.display_property) # N: Revealed type is "builtins.str"

Expand Down Expand Up @@ -51,9 +51,63 @@
@admin.display
def admin_display_bare(self, obj: MyModel) -> str: ...

@admin.display(boolean=True, ordering="field", description="Something", empty_value="Nuf")
@admin.display(boolean=True, ordering="field", description="Something")
def admin_display_fancy(self, obj: MyModel) -> bool: ...

# 'boolean' and 'empty_value' are mutually exclusive arguments
# Erroneous
admin.display(lambda: 1, boolean=True, empty_value="str")
admin.display(lambda: 1, boolean=False, empty_value="str")
# Valid
admin.display(lambda: 1, boolean=True, empty_value=None)
admin.display(lambda: 1, boolean=False, empty_value=None)
admin.display(lambda: 1, boolean=True)
admin.display(lambda: 1, boolean=False)
admin.display(lambda: 1, boolean=None, empty_value="str")
admin.display(lambda: 1, boolean=None, empty_value=None)
admin.display(lambda: 1, empty_value="str")
admin.display(lambda: 1, empty_value=None)
admin.display(lambda: 1)
# Erroneous
admin.display(boolean=True, empty_value="str")
admin.display(boolean=False, empty_value="str")
# Valid
admin.display(boolean=True, empty_value=None)
admin.display(boolean=False, empty_value=None)
admin.display(boolean=True)
admin.display(boolean=False)
admin.display(boolean=None, empty_value="str")
admin.display(boolean=None, empty_value=None)
admin.display(empty_value="str")
admin.display(empty_value=None)
admin.display()
regex: true
out: |
main:57: error: No overload variant of "display" matches argument types "Callable\[\[\], int\]", "bool", "str" \[call-overload\]
main:57: note: Possible overload variants:
main:57: note: .*
main:57: note: .*
main:57: note: .*
main:57: note: .*
main:58: error: No overload variant of "display" matches argument types "Callable\[\[\], int\]", "bool", "str" \[call-overload\]
main:58: note: Possible overload variants:
main:58: note: .*
main:58: note: .*
main:58: note: .*
main:58: note: .*
main:70: error: No overload variant of "display" matches argument types "bool", "str" \[call-overload\]
main:70: note: Possible overload variants:
main:70: note: .*
main:70: note: .*
main:70: note: .*
main:70: note: .*
main:71: error: No overload variant of "display" matches argument types "bool", "str" \[call-overload\]
main:71: note: Possible overload variants:
main:71: note: .*
main:71: note: .*
main:71: note: .*
main:71: note: .*

- case: test_admin_decorators_action
main: |
from django.db import models
Expand Down