Skip to content
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

Jump to bottom

Improve types for django.db.models.enums.* #1819

Merged
merged 1 commit into from
Nov 7, 2023
Merged

Improve types for django.db.models.enums.* #1819

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
57 changes: 37 additions & 20 deletions django-stubs/db/models/enums.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,62 @@
import enum
import sys
from typing import Any
from typing import Any, TypeVar

from typing_extensions import Self

_Self = TypeVar("_Self")

if sys.version_info >= (3, 11):
enum_property = enum.property
_enum_property = enum.property
else:
enum_property = property
_enum_property = property

class ChoicesMeta(enum.EnumMeta):
names: list[str]
choices: list[tuple[Any, str]]
labels: list[str]
values: list[Any]
# There's a contradiction between mypy and PYI019 regarding metaclasses. Where mypy
# disallows 'typing_extensions.Self' on metaclasses, while PYI019 try to enforce
# 'typing_extensions.Self' for '__new__' methods.. We've chosen to ignore the
# linter and trust mypy.
def __new__(
metacls: type[_Self], classname: str, bases: tuple[type, ...], classdict: enum._EnumDict, **kwds: Any
) -> _Self: ... # noqa: PYI019
def __contains__(self, member: Any) -> bool: ...
@property
def names(self) -> list[str]: ...
@property
def choices(self) -> list[tuple[Any, str]]: ...
@property
def labels(self) -> list[str]: ...
@property
def values(self) -> list[Any]: ...

class Choices(enum.Enum, metaclass=ChoicesMeta):
@property
def label(self) -> str: ...
@enum_property
@_enum_property
def value(self) -> Any: ...
@property
def do_not_call_in_templates(self) -> bool: ...

# fake
# fake, to keep simulate class properties
class _IntegerChoicesMeta(ChoicesMeta):
names: list[str]
choices: list[tuple[int, str]]
labels: list[str]
values: list[int]
@property
def choices(self) -> list[tuple[int, str]]: ...
@property
def values(self) -> list[int]: ...

class IntegerChoices(int, Choices, metaclass=_IntegerChoicesMeta):
@enum_property
def __new__(cls, value: int) -> Self: ...
@_enum_property
def value(self) -> int: ...

# fake
# fake, to keep simulate class properties
class _TextChoicesMeta(ChoicesMeta):
names: list[str]
choices: list[tuple[str, str]]
labels: list[str]
values: list[str]
@property
def choices(self) -> list[tuple[str, str]]: ...
@property
def values(self) -> list[str]: ...

class TextChoices(str, Choices, metaclass=_TextChoicesMeta):
@enum_property
def __new__(cls, value: str) -> Self: ...
@_enum_property
def value(self) -> str: ...
12 changes: 0 additions & 12 deletions scripts/stubtest/allowlist_todo.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,6 @@ django.contrib.gis.db.models.ImageField.attr_class
django.contrib.gis.db.models.ImageField.contribute_to_class
django.contrib.gis.db.models.ImageField.descriptor_class
django.contrib.gis.db.models.ImageField.formfield
django.contrib.gis.db.models.IntegerChoices.__new__
django.contrib.gis.db.models.IntegerField.class_lookups
django.contrib.gis.db.models.IntegerField.formfield
django.contrib.gis.db.models.IntegerField.validators
Expand Down Expand Up @@ -512,7 +511,6 @@ django.contrib.gis.db.models.Subquery.empty_result_set_value
django.contrib.gis.db.models.Subquery.external_aliases
django.contrib.gis.db.models.Subquery.get_external_cols
django.contrib.gis.db.models.Subquery.subquery
django.contrib.gis.db.models.TextChoices.__new__
django.contrib.gis.db.models.TextField.formfield
django.contrib.gis.db.models.TimeField.class_lookups
django.contrib.gis.db.models.TimeField.formfield
Expand Down Expand Up @@ -1149,7 +1147,6 @@ django.db.models.ImageField.attr_class
django.db.models.ImageField.contribute_to_class
django.db.models.ImageField.descriptor_class
django.db.models.ImageField.formfield
django.db.models.IntegerChoices.__new__
django.db.models.IntegerField.class_lookups
django.db.models.IntegerField.formfield
django.db.models.IntegerField.validators
Expand Down Expand Up @@ -1224,7 +1221,6 @@ django.db.models.Subquery.empty_result_set_value
django.db.models.Subquery.external_aliases
django.db.models.Subquery.get_external_cols
django.db.models.Subquery.subquery
django.db.models.TextChoices.__new__
django.db.models.TextField.formfield
django.db.models.TimeField.class_lookups
django.db.models.TimeField.formfield
Expand Down Expand Up @@ -1268,14 +1264,6 @@ django.db.models.constraints.UniqueConstraint.__init__
django.db.models.constraints.UniqueConstraint.contains_expressions
django.db.models.constraints.UniqueConstraint.validate
django.db.models.deletion.Collector.__init__
django.db.models.enums.ChoicesMeta.__new__
django.db.models.enums.ChoicesMeta.choices
django.db.models.enums.ChoicesMeta.labels
django.db.models.enums.ChoicesMeta.names
django.db.models.enums.ChoicesMeta.values
django.db.models.enums.IntegerChoices.__new__
django.db.models.enums.TextChoices.__new__
django.db.models.enums.enum_property
django.db.models.expressions.BaseExpression.contains_aggregate
django.db.models.expressions.BaseExpression.contains_column_references
django.db.models.expressions.BaseExpression.contains_over_clause
Expand Down