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 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
|
from typing import Annotated
import pytest
import strawberry
from strawberry import UNSET
from strawberry.exceptions import (
InvalidArgumentTypeError,
MultipleStrawberryArgumentsError,
)
from strawberry.types.base import StrawberryList, StrawberryOptional
def test_basic_arguments():
@strawberry.type
class Query:
@strawberry.field
def name(
self, argument: str, optional_argument: str | None
) -> str: # pragma: no cover
return "Name"
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument1, argument2] = definition.fields[0].arguments
assert argument1.python_name == "argument"
assert argument1.graphql_name is None
assert argument1.type is str
assert argument2.python_name == "optional_argument"
assert argument2.graphql_name is None
assert isinstance(argument2.type, StrawberryOptional)
assert argument2.type.of_type is str
def test_input_type_as_argument():
@strawberry.input
class Input:
name: str
@strawberry.type
class Query:
@strawberry.field
def name(
self, input: Input, optional_input: Input | None
) -> str: # pragma: no cover
return input.name
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument1, argument2] = definition.fields[0].arguments
assert argument1.python_name == "input"
assert argument1.graphql_name is None
assert argument1.type is Input
assert argument2.python_name == "optional_input"
assert argument2.graphql_name is None
assert isinstance(argument2.type, StrawberryOptional)
assert argument2.type.of_type is Input
def test_arguments_lists():
@strawberry.input
class Input:
name: str
@strawberry.type
class Query:
@strawberry.field
def names(self, inputs: list[Input]) -> list[str]: # pragma: no cover
return [input.name for input in inputs]
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument] = definition.fields[0].arguments
assert argument.python_name == "inputs"
assert argument.graphql_name is None
assert isinstance(argument.type, StrawberryList)
assert argument.type.of_type is Input
def test_arguments_lists_of_optionals():
@strawberry.input
class Input:
name: str
@strawberry.type
class Query:
@strawberry.field
def names(self, inputs: list[Input | None]) -> list[str]: # pragma: no cover
return [input_.name for input_ in inputs if input_ is not None]
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument] = definition.fields[0].arguments
assert argument.python_name == "inputs"
assert argument.graphql_name is None
assert isinstance(argument.type, StrawberryList)
assert isinstance(argument.type.of_type, StrawberryOptional)
assert argument.type.of_type.of_type is Input
def test_basic_arguments_on_resolver():
def name_resolver( # pragma: no cover
id: strawberry.ID, argument: str, optional_argument: str | None
) -> str:
return "Name"
@strawberry.type
class Query:
name: str = strawberry.field(resolver=name_resolver)
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument1, argument2, argument3] = definition.fields[0].arguments
assert argument1.python_name == "id"
assert argument1.type is strawberry.ID
assert argument2.python_name == "argument"
assert argument2.type is str
assert argument3.python_name == "optional_argument"
assert isinstance(argument3.type, StrawberryOptional)
assert argument3.type.of_type is str
def test_arguments_when_extending_a_type():
def name_resolver(
id: strawberry.ID, argument: str, optional_argument: str | None
) -> str: # pragma: no cover
return "Name"
@strawberry.type
class NameQuery:
name: str = strawberry.field(resolver=name_resolver)
@strawberry.type
class Query(NameQuery):
pass
definition = Query.__strawberry_definition__
assert definition.name == "Query"
assert len(definition.fields) == 1
[argument1, argument2, argument3] = definition.fields[0].arguments
assert argument1.python_name == "id"
assert argument1.type is strawberry.ID
assert argument2.python_name == "argument"
assert argument2.type is str
assert argument3.python_name == "optional_argument"
assert isinstance(argument3.type, StrawberryOptional)
assert argument3.type.of_type is str
def test_arguments_when_extending_multiple_types():
def name_resolver(id: strawberry.ID) -> str: # pragma: no cover
return "Name"
def name_2_resolver(id: strawberry.ID) -> str: # pragma: no cover
return "Name 2"
@strawberry.type
class NameQuery:
name: str = strawberry.field(permission_classes=[], resolver=name_resolver)
@strawberry.type
class ExampleQuery:
name_2: str = strawberry.field(permission_classes=[], resolver=name_2_resolver)
@strawberry.type
class RootQuery(NameQuery, ExampleQuery):
pass
definition = RootQuery.__strawberry_definition__
assert definition.name == "RootQuery"
assert len(definition.fields) == 2
[argument1] = definition.fields[0].arguments
assert argument1.python_name == "id"
assert argument1.graphql_name is None
assert argument1.type is strawberry.ID
[argument2] = definition.fields[1].arguments
assert argument2.python_name == "id"
assert argument2.graphql_name is None
assert argument2.type is strawberry.ID
def test_argument_with_default_value_none():
@strawberry.type
class Query:
@strawberry.field
def name(self, argument: str | None = None) -> str: # pragma: no cover
return "Name"
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument] = definition.fields[0].arguments
assert argument.python_name == "argument"
assert argument.graphql_name is None
assert argument.default is None
assert argument.description is None
assert isinstance(argument.type, StrawberryOptional)
assert argument.type.of_type is str
def test_argument_with_default_value_undefined():
@strawberry.type
class Query:
@strawberry.field
def name(self, argument: str | None) -> str: # pragma: no cover
return "Name"
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument] = definition.fields[0].arguments
assert argument.python_name == "argument"
assert argument.graphql_name is None
assert argument.default is UNSET
assert argument.description is None
assert isinstance(argument.type, StrawberryOptional)
assert argument.type.of_type is str
def test_annotated_argument_on_resolver():
@strawberry.type
class Query:
@strawberry.field
def name( # type: ignore
argument: Annotated[
str,
strawberry.argument(description="This is a description"),
],
) -> str: # pragma: no cover
return "Name"
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument] = definition.fields[0].arguments
assert argument.python_name == "argument"
assert argument.graphql_name is None
assert argument.description == "This is a description"
assert argument.type is str
def test_annotated_optional_arguments_on_resolver():
@strawberry.type
class Query:
@strawberry.field
def name( # type: ignore
argument: Annotated[
str | None,
strawberry.argument(description="This is a description"),
],
) -> str: # pragma: no cover
return "Name"
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument] = definition.fields[0].arguments
assert argument.python_name == "argument"
assert argument.graphql_name is None
assert argument.description == "This is a description"
assert isinstance(argument.type, StrawberryOptional)
assert argument.type.of_type is str
def test_annotated_argument_with_default_value():
@strawberry.type
class Query:
@strawberry.field
def name(
self,
argument: Annotated[
str,
strawberry.argument(description="This is a description"),
] = "Patrick",
) -> str: # pragma: no cover
return "Name"
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument] = definition.fields[0].arguments
assert argument.python_name == "argument"
assert argument.graphql_name is None
assert argument.description == "This is a description"
assert argument.type is str
assert argument.default == "Patrick"
def test_annotated_argument_with_rename():
@strawberry.type
class Query:
@strawberry.field
def name(
self,
arg: Annotated[
str,
strawberry.argument(name="argument"),
] = "Patrick",
) -> str: # pragma: no cover
return "Name"
definition = Query.__strawberry_definition__
assert definition.name == "Query"
assert len(definition.fields[0].arguments) == 1
argument = definition.fields[0].arguments[0]
assert argument.python_name == "arg"
assert argument.graphql_name == "argument"
assert argument.type is str
assert argument.description is None
assert argument.default == "Patrick"
def test_annotated_argument_with_graphql_type_override():
BigInt = strawberry.scalar(int, name="BigInt", serialize=str, parse_value=int)
@strawberry.type
class Query:
@strawberry.field
def name(
self,
arg: Annotated[
list[int],
strawberry.argument(graphql_type=list[BigInt]),
],
) -> str: # pragma: no cover
return "Name"
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument] = definition.fields[0].arguments
assert argument.python_name == "arg"
assert isinstance(argument.type, StrawberryList)
assert argument.type.of_type is BigInt
@pytest.mark.xfail(reason="Can't get field name from argument")
def test_multiple_annotated_arguments_exception():
with pytest.raises(MultipleStrawberryArgumentsError) as error:
@strawberry.field
def name(
argument: Annotated[
str,
strawberry.argument(description="This is a description"),
strawberry.argument(description="Another description"),
],
) -> str: # pragma: no cover
return "Name"
assert str(error.value) == (
"Annotation for argument `argument` "
"on field `name` cannot have multiple "
"`strawberry.argument`s"
)
def test_annotated_with_other_information():
@strawberry.type
class Query:
@strawberry.field
def name(
self, argument: Annotated[str, "Some other info"]
) -> str: # pragma: no cover
return "Name"
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument] = definition.fields[0].arguments
assert argument.python_name == "argument"
assert argument.graphql_name is None
assert argument.description is None
assert argument.type is str
def test_annotated_python_39():
from typing import Annotated
@strawberry.type
class Query:
@strawberry.field
def name(
self,
argument: Annotated[
str,
strawberry.argument(description="This is a description"),
],
) -> str: # pragma: no cover
return "Name"
definition = Query.__strawberry_definition__
assert definition.name == "Query"
[argument] = definition.fields[0].arguments
assert argument.python_name == "argument"
assert argument.graphql_name is None
assert argument.type is str
assert argument.description == "This is a description"
assert argument.type is str
@pytest.mark.raises_strawberry_exception(
InvalidArgumentTypeError,
'Argument "word" on field "add_word" cannot be of type "Union"',
)
def test_union_as_an_argument_type():
@strawberry.type
class Noun:
text: str
@strawberry.type
class Verb:
text: str
Word = Annotated[Noun | Verb, strawberry.argument("Word")]
@strawberry.field
def add_word(word: Word) -> bool:
return True
@pytest.mark.raises_strawberry_exception(
InvalidArgumentTypeError,
'Argument "adjective" on field "add_adjective" cannot be of type "Interface"',
)
def test_interface_as_an_argument_type():
@strawberry.interface
class Adjective:
text: str
@strawberry.field
def add_adjective(adjective: Adjective) -> bool:
return True
@pytest.mark.raises_strawberry_exception(
InvalidArgumentTypeError,
(
'Argument "adjective" on field "add_adjective_resolver" cannot be '
'of type "Interface"'
),
)
def test_resolver_with_invalid_field_argument_type():
@strawberry.interface
class Adjective:
text: str
def add_adjective_resolver(adjective: Adjective) -> bool: # pragma: no cover
return True
@strawberry.type
class Mutation:
add_adjective: bool = strawberry.field(resolver=add_adjective_resolver)
|