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

Update for StrOrPromise in typeddjango/django-stubs relation fields #405

Merged
merged 1 commit into from
May 4, 2023
Merged

Update for StrOrPromise in typeddjango/django-stubs relation fields #405

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
29 changes: 15 additions & 14 deletions rest_framework-stubs/relations.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ from typing import Any, Generic, TypeVar

from _typeshed import Self
from django.db.models import Manager, Model, QuerySet
from django_stubs_ext import StrOrPromise
from rest_framework.fields import Field, Option
from rest_framework.request import Request
from rest_framework.validators import Validator
Expand Down Expand Up @@ -48,11 +49,11 @@ class RelatedField(Generic[_MT, _DT, _PT], Field[_MT, _DT, _PT, Any]):
default: Any = ...,
initial: Any = ...,
source: Callable | str = ...,
label: str | None = ...,
help_text: str = ...,
label: StrOrPromise | None = ...,
help_text: StrOrPromise = ...,
allow_null: bool = ...,
validators: Sequence[Validator[_MT]] | None = ...,
error_messages: dict[str, str] | None = ...,
error_messages: dict[str, StrOrPromise] | None = ...,
style: dict[str, str] | None = ...,
): ...
# mypy doesn't accept the typing below, although its accurate to what this class is doing, hence the ignore
Expand Down Expand Up @@ -87,11 +88,11 @@ class PrimaryKeyRelatedField(RelatedField[_MT, _MT, Any]):
default: Any = ...,
initial: Any = ...,
source: Callable | str = ...,
label: str | None = ...,
help_text: str = ...,
label: StrOrPromise | None = ...,
help_text: StrOrPromise = ...,
allow_null: bool = ...,
validators: Sequence[Validator[_MT]] | None = ...,
error_messages: dict[str, str] | None = ...,
error_messages: dict[str, StrOrPromise] | None = ...,
style: dict[str, str] | None = ...,
pk_field: str | Field | None = ...,
): ...
Expand All @@ -115,11 +116,11 @@ class HyperlinkedRelatedField(RelatedField[_MT, str, Hyperlink]):
default: Any = ...,
initial: Any = ...,
source: Callable | str = ...,
label: str | None = ...,
help_text: str = ...,
label: StrOrPromise | None = ...,
help_text: StrOrPromise = ...,
allow_null: bool = ...,
validators: Sequence[Validator[_MT]] | None = ...,
error_messages: dict[str, str] | None = ...,
error_messages: dict[str, StrOrPromise] | None = ...,
style: dict[str, str] | None = ...,
view_name: str | None = ...,
lookup_field: str | None = ...,
Expand All @@ -146,11 +147,11 @@ class SlugRelatedField(RelatedField[_MT, str, str]):
default: _DT = ...,
initial: _MT | Callable[[Any], _MT] = ...,
source: Callable | str = ...,
label: str | None = ...,
help_text: str = ...,
label: StrOrPromise | None = ...,
help_text: StrOrPromise = ...,
allow_null: bool = ...,
validators: Sequence[Validator[_MT]] | None = ...,
error_messages: dict[str, str] | None = ...,
error_messages: dict[str, StrOrPromise] | None = ...,
style: dict[str, str] | None = ...,
slug_field: str | None = ...,
): ...
Expand All @@ -171,10 +172,10 @@ class ManyRelatedField(Field[Sequence[Any], Sequence[Any], list[Any], Any]):
default: Sequence[Any] = ...,
initial: Sequence[Any] | Callable[[Any], Sequence[Any]] = ...,
source: Callable | str = ...,
label: str | None = ...,
label: StrOrPromise | None = ...,
help_text: str | None = ...,
style: dict[str, str] | None = ...,
error_messages: dict[str, str] | None = ...,
error_messages: dict[str, StrOrPromise] | None = ...,
validators: Sequence[Validator[Sequence[Any]]] | None = ...,
allow_null: bool = ...,
allow_empty: bool = ...,
Expand Down