1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
|
from __future__ import annotations
import dataclasses
import enum
from typing import (
TYPE_CHECKING,
Any,
Optional,
TypeVar,
cast,
)
import strawberry
from django.db.models import F, OrderBy, QuerySet
from graphql.language.ast import ObjectValueNode
from strawberry import UNSET
from strawberry.types import has_object_definition
from strawberry.types.base import WithStrawberryObjectDefinition
from strawberry.types.field import StrawberryField, field
from strawberry.types.unset import UnsetType
from strawberry.utils.str_converters import to_camel_case
from typing_extensions import Self, dataclass_transform, deprecated
from strawberry_django.fields.base import StrawberryDjangoFieldBase
from strawberry_django.fields.filter_order import (
WITH_NONE_META,
FilterOrderField,
FilterOrderFieldResolver,
)
from strawberry_django.utils.typing import is_auto, unwrap_type
from .arguments import argument
if TYPE_CHECKING:
from collections.abc import Callable, Collection, Sequence
from django.db.models import Model
from strawberry.types import Info
from strawberry.types.arguments import StrawberryArgument
_T = TypeVar("_T")
_QS = TypeVar("_QS", bound="QuerySet")
_SFT = TypeVar("_SFT", bound=StrawberryField)
ORDER_ARG = "order"
ORDERING_ARG = "ordering"
@dataclasses.dataclass
class OrderSequence:
seq: int = 0
children: dict[str, OrderSequence] | None = None
@classmethod
def get_graphql_name(cls, info: Info | None, field: StrawberryField) -> str:
if info is None:
if field.graphql_name:
return field.graphql_name
return to_camel_case(field.python_name)
return info.schema.config.name_converter.get_graphql_name(field)
@classmethod
def sorted(
cls,
info: Info | None,
sequence: dict[str, OrderSequence] | None,
fields: list[_SFT],
) -> list[_SFT]:
if info is None:
return fields
sequence = sequence or {}
def sort_key(f: _SFT) -> int:
if not (seq := sequence.get(cls.get_graphql_name(info, f))):
return 0
return seq.seq
return sorted(fields, key=sort_key)
@strawberry.enum
class Ordering(enum.Enum):
ASC = "ASC"
ASC_NULLS_FIRST = "ASC_NULLS_FIRST"
ASC_NULLS_LAST = "ASC_NULLS_LAST"
DESC = "DESC"
DESC_NULLS_FIRST = "DESC_NULLS_FIRST"
DESC_NULLS_LAST = "DESC_NULLS_LAST"
def resolve(self, value: str) -> OrderBy:
nulls_first = True if "NULLS_FIRST" in self.name else None
nulls_last = True if "NULLS_LAST" in self.name else None
if "ASC" in self.name:
return F(value).asc(nulls_first=nulls_first, nulls_last=nulls_last)
return F(value).desc(nulls_first=nulls_first, nulls_last=nulls_last)
def process_order(
order: WithStrawberryObjectDefinition,
info: Info | None,
queryset: _QS,
*,
sequence: dict[str, OrderSequence] | None = None,
prefix: str = "",
skip_object_order_method: bool = False,
) -> tuple[_QS, Collection[F | OrderBy | str]]:
sequence = sequence or {}
args = []
if not skip_object_order_method and isinstance(
order_method := getattr(order, "order", None),
FilterOrderFieldResolver,
):
return order_method(
order, info, queryset=queryset, prefix=prefix, sequence=sequence
)
for f in OrderSequence.sorted(
info, sequence, order.__strawberry_definition__.fields
):
f_value = getattr(order, f.name, UNSET)
if f_value is UNSET or (f_value is None and not f.metadata.get(WITH_NONE_META)):
continue
if isinstance(f, FilterOrderField) and f.base_resolver:
res = f.base_resolver(
order,
info,
value=f_value,
queryset=queryset,
prefix=prefix,
sequence=(
(seq := sequence.get(OrderSequence.get_graphql_name(info, f)))
and seq.children
),
)
if isinstance(res, tuple):
queryset, subargs = res
else:
subargs = res
args.extend(subargs)
elif isinstance(f_value, Ordering):
args.append(f_value.resolve(f"{prefix}{f.name}"))
else:
queryset, subargs = process_order(
f_value,
info,
queryset,
prefix=f"{prefix}{f.name}__",
sequence=(
(seq := sequence.get(OrderSequence.get_graphql_name(info, f)))
and seq.children
),
)
args.extend(subargs)
return queryset, args
def apply(
order: object | None,
queryset: _QS,
info: Info | None = None,
) -> _QS:
if order in (None, strawberry.UNSET) or not has_object_definition(order): # noqa: PLR6201
return queryset
sequence: dict[str, OrderSequence] = {}
if info is not None and info._raw_info.field_nodes:
field_node = info._raw_info.field_nodes[0]
for arg in field_node.arguments:
if arg.name.value != ORDER_ARG or not isinstance(
arg.value, ObjectValueNode
):
continue
def parse_and_fill(field: ObjectValueNode, seq: dict[str, OrderSequence]):
for i, f in enumerate(field.fields):
f_sequence: dict[str, OrderSequence] = {}
if isinstance(f.value, ObjectValueNode):
parse_and_fill(f.value, f_sequence)
seq[f.name.value] = OrderSequence(seq=i, children=f_sequence)
parse_and_fill(arg.value, sequence)
queryset, args = process_order(
cast("WithStrawberryObjectDefinition", order), info, queryset, sequence=sequence
)
if not args:
return queryset
return queryset.order_by(*args)
def process_ordering_default(
ordering: Any,
info: Info | None,
queryset: _QS,
prefix: str = "",
) -> tuple[_QS, Collection[F | OrderBy | str]]:
if ordering is None or not has_object_definition(ordering):
return queryset, ()
args = []
for f in ordering.__strawberry_definition__.fields:
f_value = getattr(ordering, f.name, UNSET)
if f_value is UNSET or (f_value is None and not f.metadata.get(WITH_NONE_META)):
continue
if isinstance(f, FilterOrderField) and f.base_resolver:
res = f.base_resolver(
ordering,
info,
value=f_value,
queryset=queryset,
prefix=prefix,
)
if isinstance(res, tuple):
queryset, subargs = res
else:
subargs = res
args.extend(subargs)
elif isinstance(f_value, Ordering):
args.append(f_value.resolve(f"{prefix}{f.name}"))
else:
ordering_cls = unwrap_type(f.type)
assert isinstance(ordering_cls, type)
assert has_object_definition(ordering_cls)
queryset, subargs = process_ordering(
ordering_cls,
(f_value,),
info,
queryset,
prefix=f"{prefix}{f.name}__",
)
args.extend(subargs)
return queryset, args
def process_ordering(
ordering_cls: type[WithStrawberryObjectDefinition],
ordering: Collection[WithStrawberryObjectDefinition] | None,
info: Info | None,
queryset: _QS,
prefix: str = "",
) -> tuple[_QS, Collection[F | OrderBy | str]]:
if not ordering:
return queryset, ()
if not isinstance(
order_method := getattr(ordering_cls, "order", None), FilterOrderFieldResolver
):
order_method = process_ordering_default
args = []
for o in ordering:
queryset, new_args = order_method(o, info, queryset=queryset, prefix=prefix)
args.extend(new_args)
return queryset, args
def apply_ordering(
ordering_cls: type[WithStrawberryObjectDefinition],
ordering: Collection[WithStrawberryObjectDefinition] | None,
info: Info | None,
queryset: _QS,
) -> _QS:
queryset, args = process_ordering(ordering_cls, ordering, info, queryset)
if args:
queryset = queryset.order_by(*args)
return queryset
class StrawberryDjangoFieldOrdering(StrawberryDjangoFieldBase):
def __init__(
self,
order: type | UnsetType | None = UNSET,
ordering: type | UnsetType | None = UNSET,
**kwargs,
):
if order and not has_object_definition(order):
raise TypeError("order needs to be a strawberry type")
if ordering and not has_object_definition(ordering):
raise TypeError("ordering needs to be a strawberry type")
self.order = order
self.ordering = ordering
super().__init__(**kwargs)
def __copy__(self) -> Self:
new_field = super().__copy__()
new_field.order = self.order
new_field.ordering = self.ordering
return new_field
@property
def arguments(self) -> list[StrawberryArgument]:
arguments = []
if self.base_resolver is None and self.is_list and not self.is_model_property:
order = self.get_order()
if order and order is not UNSET:
arguments.append(argument("order", order, is_optional=True))
if self.base_resolver is None and self.is_list and not self.is_model_property:
ordering = self.get_ordering()
if ordering is not None:
arguments.append(
argument("ordering", ordering, is_list=True, default=[])
)
return super().arguments + arguments
@arguments.setter
def arguments(self, value: list[StrawberryArgument]):
args_prop = super(StrawberryDjangoFieldOrdering, self.__class__).arguments
return args_prop.fset(self, value) # type: ignore
def get_order(self) -> type[WithStrawberryObjectDefinition] | None:
order = self.order
if order is None:
return None
if isinstance(order, UnsetType):
django_type = self.django_type
order = (
django_type.__strawberry_django_definition__.order
if django_type is not None
else None
)
return order if order is not UNSET else None
def get_ordering(self) -> type[WithStrawberryObjectDefinition] | None:
ordering = self.ordering
if ordering is None:
return None
if isinstance(ordering, UnsetType):
django_type = self.django_type
ordering = (
django_type.__strawberry_django_definition__.ordering
if django_type is not None and django_type is not UNSET
else None
)
return ordering
def get_queryset(
self,
queryset: _QS,
info: Info,
*,
order: WithStrawberryObjectDefinition | None = None,
ordering: list[WithStrawberryObjectDefinition] | None = None,
**kwargs,
) -> _QS:
if order and ordering:
raise ValueError("Only one of `ordering` or `order` must be given.")
queryset = super().get_queryset(queryset, info, **kwargs)
queryset = apply(order, queryset, info=info)
if ordering_cls := self.get_ordering():
queryset = apply_ordering(ordering_cls, ordering, info, queryset)
return queryset
@dataclass_transform(
order_default=True,
field_specifiers=(
StrawberryField,
field,
),
)
def order_type(
model: type[Model],
*,
name: str | None = None,
one_of: bool = True,
description: str | None = None,
directives: Sequence[object] | None = (),
) -> Callable[[_T], _T]:
def wrapper(cls):
try:
cls.__annotations__ # noqa: B018
except AttributeError:
# FIXME: Manual creation for python 3.9 (remove when 3.9 is dropped)
cls.__annotations__ = {}
for fname, type_ in cls.__annotations__.items():
if is_auto(type_):
type_ = Ordering # noqa: PLW2901
cls.__annotations__[fname] = Optional[type_]
field_ = cls.__dict__.get(fname)
if not isinstance(field_, StrawberryField):
setattr(cls, fname, UNSET)
return strawberry.input(
cls,
name=name,
one_of=one_of,
description=description,
directives=directives,
)
return wrapper
@dataclass_transform(
order_default=True,
field_specifiers=(
StrawberryField,
field,
),
)
@deprecated(
"strawberry_django.order is deprecated in favor of strawberry_django.ordering."
)
def order(
model: type[Model],
*,
name: str | None = None,
description: str | None = None,
directives: Sequence[object] | None = (),
) -> Callable[[_T], _T]:
def wrapper(cls):
try:
cls.__annotations__ # noqa: B018
except AttributeError:
# FIXME: Manual creation for python 3.9 (remove when 3.9 is dropped)
cls.__annotations__ = {}
for fname, type_ in cls.__annotations__.items():
if is_auto(type_):
type_ = Ordering # noqa: PLW2901
cls.__annotations__[fname] = Optional[type_]
field_ = cls.__dict__.get(fname)
if not isinstance(field_, StrawberryField):
setattr(cls, fname, UNSET)
return strawberry.input(
cls,
name=name,
description=description,
directives=directives,
)
return wrapper
|