Skip to content

feat(dto-schema-name): add __schema_name__ to dto base #4131

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

feat(dto-schema-name): add __schema_name__ to dto base #4131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
20dd419
fix(litestar): improve schema key equality check && add schema name t…
Jannchie Apr 19, 2025
a72f45c
style(backend): fix line wrapping && trailing commas in function call
Jannchie Apr 19, 2025
1d88b18
style(base-dto): add typing to __schema_name__ attribute
Jannchie Apr 19, 2025
2f249d1
style(dto-backend): reformat code for improved readability
Jannchie Apr 19, 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
3 changes: 1 addition & 2 deletions litestar/_openapi/datastructures.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,7 @@ def get_reference_for_field_definition(self, field: FieldDefinition) -> Referenc
key = _get_normalized_schema_key(field)
if key not in self._schema_key_map:
return None

if (existing_type := self._component_type_map[key]) != field:
if (existing_type := self._component_type_map[key]) != field and f"{field.raw!r}" != f"{existing_type.raw!r}":
# TODO: This should check for strict equality, e.g. changes in type metadata
# However, this is currently not possible to do without breaking things, as
# we allow to define metadata on a type annotation in one place to be used
Expand Down
2 changes: 1 addition & 1 deletion litestar/dto/_backend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ def create_transfer_model_type(
Returns:
A ``BackendT`` class.
"""
struct_name = self._create_transfer_model_name(model_name)
struct_name = self.dto_factory.__schema_name__ or self._create_transfer_model_name(model_name)

struct = _create_struct_for_field_definitions(
model_name=struct_name,
Expand Down
1 change: 1 addition & 0 deletions litestar/dto/base_dto.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ class AbstractDTO(Generic[T]):
"""If ``annotation`` is an iterable, this is the inner type, otherwise will be the same as ``annotation``."""

_dto_backends: ClassVar[dict[str, _BackendDict]] = {}
__schema_name__: ClassVar[None | str] = None

def __init__(self, asgi_connection: ASGIConnection) -> None:
"""Create an AbstractDTOFactory type.
Expand Down
Loading