Skip to content

Fix SlugRelatedField.slug_field type: cannot be None #830

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 23, 2025
Merged

Fix SlugRelatedField.slug_field type: cannot be None #830

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
36f8d34
fix slug_field typing according to match the implementation
lev-blit Sep 22, 2025
ab78dae
only change the attribute typing
lev-blit Sep 23, 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: 2 additions & 2 deletions rest_framework-stubs/relations.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,10 @@ class HyperlinkedRelatedField(RelatedField[_MT, str, Hyperlink]):
class HyperlinkedIdentityField(HyperlinkedRelatedField): ...

class SlugRelatedField(RelatedField[_MT, str, str]):
slug_field: str | None
slug_field: str
Copy link
Contributor

@intgr intgr Sep 23, 2025

Choose a reason for hiding this comment

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

Changing the attribute is good 👍

def __init__(
self,
slug_field: str,
slug_field: str | None = None,
Copy link
Contributor

@intgr intgr Sep 23, 2025

Choose a reason for hiding this comment

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

But the parameter isn't really | None if there's an assert prohibiting it.

I'd suggest opening a PR to upstream https://github.com/encode/django-rest-framework instead to remove the default value.

Copy link
Contributor

@intgr intgr Sep 27, 2025

Choose a reason for hiding this comment

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

Documented in https://github.com/typeddjango/djangorestframework-stubs/pull/833/files

*,
many: bool = ...,
allow_empty: bool = ...,
Expand Down
Loading