Skip to content

Document intentional discrepancies in allowlist & code comments #833

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 2 commits into from
Sep 27, 2025
Merged

Document intentional discrepancies in allowlist & code comments #833

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99406f3
Document intentional discrepancies in allowlist & code comments
intgr Sep 27, 2025
6c6e355
Document also `rest_framework.fields.empty`
intgr Sep 27, 2025
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
4 changes: 3 additions & 1 deletion rest_framework-stubs/relations.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ class SlugRelatedField(RelatedField[_MT, str, str]):
slug_field: str
def __init__(
self,
# DISCREPANCY: signature defaults `slug_field=None`, but actually crashes when `None` is provided.
slug_field: str,
*,
many: bool = ...,
Expand Down Expand Up @@ -169,7 +170,8 @@ class ManyRelatedField(Field[Sequence[Any], Sequence[Any], list[Any], Any]):
allow_empty: bool
def __init__(
self,
child_relation: RelatedField = ...,
# DISCREPANCY: signature defaults `child_relation=None`, but actually crashes when `None` is provided.
child_relation: RelatedField,
Copy link
Contributor Author

@intgr intgr Sep 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only functional change here -- removed the default value = ...

*,
read_only: bool = ...,
write_only: bool = ...,
Expand Down
2 changes: 2 additions & 0 deletions rest_framework-stubs/renderers.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ from rest_framework.views import APIView
def zero_as_none(value: Any) -> Any | None: ...

class BaseRenderer:
# DISCREPANCY: `media_type`, `format` cannot be None.
# None is a placeholder, but all subclasses must override this to `str`.
media_type: str
format: str
charset: str | None
Expand Down
1 change: 1 addition & 0 deletions rest_framework-stubs/validators.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ class ProhibitSurrogateCharactersValidator:
def __call__(self, value: Any) -> None: ...

class BaseUniqueForValidator:
# DISCREPANCY: `message` cannot be None -- None is a placeholder, but subclasses must override this to StrOrPromise
message: StrOrPromise
missing_message: StrOrPromise
requires_context: bool
Expand Down
5 changes: 5 additions & 0 deletions scripts/stubtest/allowlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ rest_framework.relations.SlugRelatedField.__init__
rest_framework.serializers.ManyRelatedField.__init__
rest_framework.serializers.SlugRelatedField.__init__

# None is used as a placeholder, but not valid in actual usage
rest_framework.renderers.BaseRenderer.format
rest_framework.renderers.BaseRenderer.media_type
rest_framework.validators.BaseUniqueForValidator.message

# Migrations are omitted
rest_framework.authtoken.migrations
rest_framework.authtoken.migrations.0001_initial
Expand Down
3 changes: 0 additions & 3 deletions scripts/stubtest/allowlist_todo.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@ rest_framework.parsers.BaseParser.media_type
rest_framework.parsers.FileUploadParser.get_encoded_filename
rest_framework.relations.ManyRelatedField.initial
rest_framework.relations.ManyRelatedField.to_representation
rest_framework.renderers.BaseRenderer.format
rest_framework.renderers.BaseRenderer.media_type
rest_framework.renderers.BrowsableAPIRenderer.get_extra_actions
rest_framework.renderers.CoreJSONRenderer.render
rest_framework.renderers._BaseOpenAPIRenderer.render
Expand Down Expand Up @@ -99,7 +97,6 @@ rest_framework.test.APIClient.options
rest_framework.test.RequestsClient.__init__
rest_framework.throttling.SimpleRateThrottle.cache
rest_framework.utils.encoders.JSONEncoder.default
rest_framework.validators.BaseUniqueForValidator.message
rest_framework.validators.ContextValidator
rest_framework.validators.Validator
rest_framework.views.APIView.metadata_class
Expand Down