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
|
import functools
import inspect
from collections.abc import Iterable
from typing import (
Callable,
Optional,
TypeVar,
Union,
cast,
overload,
)
import strawberry
from asgiref.sync import sync_to_async
from django.db import models
from strawberry import relay
from strawberry.relay.exceptions import NodeIDAnnotationError
from strawberry.types.info import Info
from strawberry.utils.await_maybe import AwaitableOrValue
from typing_extensions import Literal
from strawberry_django.queryset import run_type_get_queryset
from strawberry_django.resolvers import django_getattr, django_resolver
from strawberry_django.utils.typing import (
WithStrawberryDjangoObjectDefinition,
get_django_definition,
)
_T = TypeVar("_T")
_M = TypeVar("_M", bound=models.Model)
__all__ = [
"resolve_model_id",
"resolve_model_id_attr",
"resolve_model_node",
"resolve_model_nodes",
]
def get_node_caster(origin: Optional[type]) -> Callable[[_T], _T]:
if origin is None:
return lambda node: node
return functools.partial(strawberry.cast, origin)
@overload
def resolve_model_nodes(
source: Union[
type[WithStrawberryDjangoObjectDefinition],
type[relay.Node],
type[_M],
],
*,
info: Optional[Info] = None,
node_ids: Iterable[Union[str, relay.GlobalID]],
required: Literal[True],
filter_perms: bool = False,
) -> AwaitableOrValue[Iterable[_M]]: ...
@overload
def resolve_model_nodes(
source: Union[
type[WithStrawberryDjangoObjectDefinition],
type[relay.Node],
type[_M],
],
*,
info: Optional[Info] = None,
node_ids: None = None,
required: Literal[True],
filter_perms: bool = False,
) -> AwaitableOrValue[models.QuerySet[_M]]: ...
@overload
def resolve_model_nodes(
source: Union[
type[WithStrawberryDjangoObjectDefinition],
type[relay.Node],
type[_M],
],
*,
info: Optional[Info] = None,
node_ids: Iterable[Union[str, relay.GlobalID]],
required: Literal[False],
filter_perms: bool = False,
) -> AwaitableOrValue[Iterable[Optional[_M]]]: ...
@overload
def resolve_model_nodes(
source: Union[
type[WithStrawberryDjangoObjectDefinition],
type[relay.Node],
type[_M],
],
*,
info: Optional[Info] = None,
node_ids: None = None,
required: Literal[False],
filter_perms: bool = False,
) -> AwaitableOrValue[Optional[models.QuerySet[_M]]]: ...
@overload
def resolve_model_nodes(
source: Union[
type[WithStrawberryDjangoObjectDefinition],
type[relay.Node],
type[_M],
],
*,
info: Optional[Info] = None,
node_ids: Optional[Iterable[Union[str, relay.GlobalID]]] = None,
required: bool = False,
filter_perms: bool = False,
) -> AwaitableOrValue[
Union[
Iterable[_M],
models.QuerySet[_M],
Iterable[Optional[_M]],
Optional[models.QuerySet[_M]],
]
]: ...
def resolve_model_nodes(
source,
*,
info=None,
node_ids=None,
required=False,
filter_perms=False,
) -> AwaitableOrValue[
Union[
Iterable[_M],
models.QuerySet[_M],
Iterable[Optional[_M]],
Optional[models.QuerySet[_M]],
]
]:
"""Resolve model nodes, ensuring those are prefetched in a sync context.
Args:
----
source:
The source model or the model type that implements the `Node` interface
info:
Optional gql execution info. Make sure to always provide this or
otherwise, the queryset cannot be optimized in case DjangoOptimizerExtension
is enabled. This will also be used for `is_awaitable` check.
node_ids:
Optional filter by those node_ids instead of retrieving everything
required:
If `True`, all `node_ids` requested must exist. If they don't,
an error must be raised. If `False`, missing nodes should be
returned as `None`. It only makes sense when passing a list of
`node_ids`, otherwise it will should ignored.
Returns:
-------
The resolved queryset, already prefetched from the database
"""
from strawberry_django import optimizer # avoid circular import
from strawberry_django.permissions import filter_with_perms
if issubclass(source, models.Model):
origin = None
else:
origin = source
django_type = get_django_definition(source, strict=True)
source = cast("type[_M]", django_type.model)
qs = cast("models.QuerySet[_M]", source._default_manager.all())
qs = run_type_get_queryset(qs, origin, info)
id_attr = cast("relay.Node", origin).resolve_id_attr()
if node_ids is not None:
qs = qs.filter(
**{
f"{id_attr}__in": [
i.node_id if isinstance(i, relay.GlobalID) else i for i in node_ids
],
},
)
extra_args = {}
if info is not None:
if filter_perms:
qs = filter_with_perms(qs, info)
# Connection will filter the results when its is being resolved.
# We don't want to fetch everything before it does that
return_type = info.return_type
if isinstance(return_type, type) and issubclass(return_type, relay.Connection):
extra_args["qs_hook"] = lambda qs: qs
ext = optimizer.optimizer.get()
if ext is not None:
# If optimizer extension is enabled, optimize this queryset
qs = ext.optimize(qs, info=info)
retval = cast(
"AwaitableOrValue[models.QuerySet[_M]]",
django_resolver(lambda _qs: _qs, **extra_args)(qs),
)
if not node_ids:
return retval
def map_results(results: models.QuerySet[_M]) -> list[_M]:
node_caster = get_node_caster(origin)
results_map = {str(getattr(obj, id_attr)): node_caster(obj) for obj in results}
retval: list[Optional[_M]] = []
for node_id in node_ids:
if required:
retval.append(results_map[str(node_id)])
else:
retval.append(results_map.get(str(node_id), None))
return retval # type: ignore
if inspect.isawaitable(retval):
async def async_resolver():
return await sync_to_async(map_results)(await retval)
return async_resolver()
return map_results(retval)
@overload
def resolve_model_node(
source: Union[
type[WithStrawberryDjangoObjectDefinition],
type[relay.Node],
type[_M],
],
node_id: Union[str, relay.GlobalID],
*,
info: Optional[Info] = ...,
required: Literal[False] = ...,
filter_perms: bool = False,
) -> AwaitableOrValue[Optional[_M]]: ...
@overload
def resolve_model_node(
source: Union[
type[WithStrawberryDjangoObjectDefinition],
type[relay.Node],
type[_M],
],
node_id: Union[str, relay.GlobalID],
*,
info: Optional[Info] = ...,
required: Literal[True],
filter_perms: bool = False,
) -> AwaitableOrValue[_M]: ...
def resolve_model_node(
source,
node_id,
*,
info: Optional[Info] = None,
required=False,
filter_perms=False,
):
"""Resolve model nodes, ensuring it is retrieved in a sync context.
Args:
----
source:
The source model or the model type that implements the `Node` interface
node_id:
The node it to retrieve the model from
info:
Optional gql execution info. Make sure to always provide this or
otherwise, the queryset cannot be optimized in case DjangoOptimizerExtension
is enabled. This will also be used for `is_awaitable` check.
required:
If the return value is required to exist. If true, `qs.get()` will be
used, which might raise `model.DoesNotExist` error if the node doesn't
exist. Otherwise, `qs.first()` will be used, which might return None.
Returns:
-------
The resolved node, already prefetched from the database
"""
from strawberry_django import optimizer # avoid circular import
from strawberry_django.permissions import filter_with_perms
if issubclass(source, models.Model):
origin = None
else:
origin = source
django_type = get_django_definition(source, strict=True)
source = cast("type[models.Model]", django_type.model)
if isinstance(node_id, relay.GlobalID):
node_id = node_id.node_id
id_attr = cast("relay.Node", origin).resolve_id_attr()
qs = source._default_manager.all()
qs = run_type_get_queryset(qs, origin, info)
qs = qs.filter(**{id_attr: node_id})
if info is not None:
if filter_perms:
qs = filter_with_perms(qs, info)
ext = optimizer.optimizer.get()
if ext is not None:
# If optimizer extension is enabled, optimize this queryset
qs = ext.optimize(qs, info=info)
node_caster = get_node_caster(origin)
return django_resolver(lambda: node_caster(qs.get() if required else qs.first()))()
def resolve_model_id_attr(source: type) -> str:
"""Resolve the model id, ensuring it is retrieved in a sync context.
Args:
----
source:
The source model type that implements the `Node` interface
Returns:
-------
The resolved id attr
"""
try:
id_attr = super(source, source).resolve_id_attr() # type: ignore
except NodeIDAnnotationError:
id_attr = "pk"
return id_attr
def resolve_model_id(
source: Union[
type[WithStrawberryDjangoObjectDefinition],
type[relay.Node],
type[_M],
],
root: models.Model,
*,
info: Optional[Info] = None,
) -> AwaitableOrValue[str]:
"""Resolve the model id, ensuring it is retrieved in a sync context.
Args:
----
source:
The source model or the model type that implements the `Node` interface
root:
The source model object.
Returns:
-------
The resolved object id
"""
id_attr = cast("relay.Node", source).resolve_id_attr()
assert isinstance(root, models.Model)
if id_attr == "pk":
pk = root.__class__._meta.pk
assert pk
id_attr = pk.attname
assert id_attr
try:
# Prefer to retrieve this from the cache
return str(root.__dict__[id_attr])
except KeyError:
return django_getattr(root, id_attr)
|