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 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
|
import logging
import re
from abc import ABC, abstractmethod
from math import isfinite
from typing import Any, Dict, Iterable, Mapping, Optional, Tuple, Union, cast
from graphql import (
ArgumentNode,
BooleanValueNode,
DocumentNode,
EnumValueNode,
FieldNode,
FloatValueNode,
FragmentDefinitionNode,
FragmentSpreadNode,
GraphQLArgument,
GraphQLEnumType,
GraphQLError,
GraphQLField,
GraphQLID,
GraphQLInputObjectType,
GraphQLInputType,
GraphQLInterfaceType,
GraphQLList,
GraphQLNamedType,
GraphQLNonNull,
GraphQLObjectType,
GraphQLScalarType,
GraphQLSchema,
GraphQLString,
InlineFragmentNode,
IntValueNode,
ListTypeNode,
ListValueNode,
NamedTypeNode,
NameNode,
NonNullTypeNode,
NullValueNode,
ObjectFieldNode,
ObjectValueNode,
OperationDefinitionNode,
OperationType,
SelectionSetNode,
StringValueNode,
TypeNode,
Undefined,
ValueNode,
VariableDefinitionNode,
VariableNode,
get_named_type,
introspection_types,
is_enum_type,
is_input_object_type,
is_leaf_type,
is_list_type,
is_non_null_type,
is_wrapping_type,
print_ast,
)
from graphql.pyutils import inspect
from .graphql_request import GraphQLRequest
from .utils import to_camel_case
log = logging.getLogger(__name__)
_re_integer_string = re.compile("^-?(?:0|[1-9][0-9]*)$")
def ast_from_serialized_value_untyped(serialized: Any) -> Optional[ValueNode]:
"""Given a serialized value, try our best to produce an AST.
Anything ressembling an array (instance of Mapping) will be converted
to an ObjectFieldNode.
Anything ressembling a list (instance of Iterable - except str)
will be converted to a ListNode.
In some cases, a custom scalar can be serialized differently in the query
than in the variables. In that case, this function will not work."""
if serialized is None or serialized is Undefined:
return NullValueNode()
if isinstance(serialized, Mapping):
field_items = (
(key, ast_from_serialized_value_untyped(value))
for key, value in serialized.items()
)
field_nodes = tuple(
ObjectFieldNode(name=NameNode(value=field_name), value=field_value)
for field_name, field_value in field_items
if field_value
)
return ObjectValueNode(fields=field_nodes)
if isinstance(serialized, Iterable) and not isinstance(serialized, str):
maybe_nodes = (ast_from_serialized_value_untyped(item) for item in serialized)
nodes = tuple(node for node in maybe_nodes if node)
return ListValueNode(values=nodes)
if isinstance(serialized, bool):
return BooleanValueNode(value=serialized)
if isinstance(serialized, int):
return IntValueNode(value=str(serialized))
if isinstance(serialized, float) and isfinite(serialized):
value = str(serialized)
if value.endswith(".0"):
value = value[:-2]
return FloatValueNode(value=value)
if isinstance(serialized, str):
return StringValueNode(value=serialized)
raise TypeError(f"Cannot convert value to AST: {inspect(serialized)}.")
def ast_from_value(value: Any, type_: GraphQLInputType) -> Optional[ValueNode]:
"""
This is a partial copy paste of the ast_from_value function in
graphql-core utilities/ast_from_value.py
Overwrite the if blocks that use recursion and add a new case to return a
VariableNode when value is a DSLVariable
Produce a GraphQL Value AST given a Python object.
Raises a GraphQLError instead of returning None if we receive an Undefined
of if we receive a Null value for a Non-Null type.
"""
if isinstance(value, DSLVariable):
return value.set_type(type_).ast_variable_name
if is_non_null_type(type_):
type_ = cast(GraphQLNonNull, type_)
inner_type = type_.of_type
ast_value = ast_from_value(value, inner_type)
if isinstance(ast_value, NullValueNode):
raise GraphQLError(
"Received Null value for a Non-Null type " f"{inspect(inner_type)}."
)
return ast_value
# only explicit None, not Undefined or NaN
if value is None:
return NullValueNode()
# undefined
if value is Undefined:
raise GraphQLError(f"Received Undefined value for type {inspect(type_)}.")
# Convert Python list to GraphQL list. If the GraphQLType is a list, but the value
# is not a list, convert the value using the list's item type.
if is_list_type(type_):
type_ = cast(GraphQLList, type_)
item_type = type_.of_type
if isinstance(value, Iterable) and not isinstance(value, str):
maybe_value_nodes = (ast_from_value(item, item_type) for item in value)
value_nodes = tuple(node for node in maybe_value_nodes if node)
return ListValueNode(values=value_nodes)
return ast_from_value(value, item_type)
# Populate the fields of the input object by creating ASTs from each value in the
# Python dict according to the fields in the input type.
if is_input_object_type(type_):
if value is None or not isinstance(value, Mapping):
return None
type_ = cast(GraphQLInputObjectType, type_)
field_items = (
(field_name, ast_from_value(value[field_name], field.type))
for field_name, field in type_.fields.items()
if field_name in value
)
field_nodes = tuple(
ObjectFieldNode(name=NameNode(value=field_name), value=field_value)
for field_name, field_value in field_items
if field_value
)
return ObjectValueNode(fields=field_nodes)
if is_leaf_type(type_):
# Since value is an internally represented value, it must be serialized to an
# externally represented value before converting into an AST.
serialized = type_.serialize(value) # type: ignore
# if the serialized value is a string, then we should use the
# type to determine if it is an enum, an ID or a normal string
if isinstance(serialized, str):
# Enum types use Enum literals.
if is_enum_type(type_):
return EnumValueNode(value=serialized)
# ID types can use Int literals.
if type_ is GraphQLID and _re_integer_string.match(serialized):
return IntValueNode(value=serialized)
return StringValueNode(value=serialized)
# Some custom scalars will serialize to dicts or lists
# Providing here a default conversion to AST using our best judgment
# until graphql-js issue #1817 is solved
# https://github.com/graphql/graphql-js/issues/1817
return ast_from_serialized_value_untyped(serialized)
# Not reachable. All possible input types have been considered.
raise TypeError(f"Unexpected input type: {inspect(type_)}.")
def dsl_gql(
*operations: "DSLExecutable", **operations_with_name: "DSLExecutable"
) -> GraphQLRequest:
r"""Given arguments instances of :class:`DSLExecutable`
containing GraphQL operations or fragments,
generate a Document which can be executed later in a
gql client or a gql session.
Similar to the :func:`gql.gql` function but instead of parsing a python
string to describe the request, we are using operations which have been generated
dynamically using instances of :class:`DSLField`, generated
by instances of :class:`DSLType` which themselves originated from
a :class:`DSLSchema` class.
:param \*operations: the GraphQL operations and fragments
:type \*operations: DSLQuery, DSLMutation, DSLSubscription, DSLFragment
:param \**operations_with_name: the GraphQL operations with an operation name
:type \**operations_with_name: DSLQuery, DSLMutation, DSLSubscription
:return: a :class:`GraphQLRequest <gql.GraphQLRequest>`
which can be later executed or subscribed by a
:class:`Client <gql.client.Client>`, by an
:class:`async session <gql.client.AsyncClientSession>` or by a
:class:`sync session <gql.client.SyncClientSession>`
:raises TypeError: if an argument is not an instance of :class:`DSLExecutable`
:raises AttributeError: if a type has not been provided in a :class:`DSLFragment`
"""
# Concatenate operations without and with name
all_operations: Tuple["DSLExecutable", ...] = (
*operations,
*(operation for operation in operations_with_name.values()),
)
# Set the operation name
for name, operation in operations_with_name.items():
operation.name = name
# Check the type
for operation in all_operations:
if not isinstance(operation, DSLExecutable):
raise TypeError(
"Operations should be instances of DSLExecutable "
"(DSLQuery, DSLMutation, DSLSubscription or DSLFragment).\n"
f"Received: {type(operation)}."
)
document = DocumentNode(
definitions=[operation.executable_ast for operation in all_operations]
)
return GraphQLRequest(document)
class DSLSchema:
"""The DSLSchema is the root of the DSL code.
Attributes of the DSLSchema class are generated automatically
with the `__getattr__` dunder method in order to generate
instances of :class:`DSLType`
"""
def __init__(self, schema: GraphQLSchema):
"""Initialize the DSLSchema with the given schema.
:param schema: a GraphQL Schema provided locally or fetched using
an introspection query. Usually `client.schema`
:type schema: GraphQLSchema
:raises TypeError: if the argument is not an instance of :class:`GraphQLSchema`
"""
if not isinstance(schema, GraphQLSchema):
raise TypeError(
f"DSLSchema needs a schema as parameter. Received: {type(schema)}"
)
self._schema: GraphQLSchema = schema
def __getattr__(self, name: str) -> "DSLType":
type_def: Optional[GraphQLNamedType] = self._schema.get_type(name)
if type_def is None:
raise AttributeError(f"Type '{name}' not found in the schema!")
if not isinstance(type_def, (GraphQLObjectType, GraphQLInterfaceType)):
raise AttributeError(
f'Type "{name} ({type_def!r})" is not valid as an attribute of'
" DSLSchema. Only Object types or Interface types are accepted."
)
return DSLType(type_def, self)
class DSLSelector(ABC):
"""DSLSelector is an abstract class which defines the
:meth:`select <gql.dsl.DSLSelector.select>` method to select
children fields in the query.
Inherited by
:class:`DSLRootFieldSelector <gql.dsl.DSLRootFieldSelector>`,
:class:`DSLFieldSelector <gql.dsl.DSLFieldSelector>`
:class:`DSLFragmentSelector <gql.dsl.DSLFragmentSelector>`
"""
selection_set: SelectionSetNode
def __init__(
self,
*fields: "DSLSelectable",
**fields_with_alias: "DSLSelectableWithAlias",
):
""":meta private:"""
self.selection_set = SelectionSetNode(selections=())
if fields or fields_with_alias:
self.select(*fields, **fields_with_alias)
@abstractmethod
def is_valid_field(self, field: "DSLSelectable") -> bool:
raise NotImplementedError(
"Any DSLSelector subclass must have a is_valid_field method"
) # pragma: no cover
def select(
self,
*fields: "DSLSelectable",
**fields_with_alias: "DSLSelectableWithAlias",
) -> Any:
r"""Select the fields which should be added.
:param \*fields: fields or fragments
:type \*fields: DSLSelectable
:param \**fields_with_alias: fields or fragments with alias as key
:type \**fields_with_alias: DSLSelectable
:raises TypeError: if an argument is not an instance of :class:`DSLSelectable`
:raises graphql.error.GraphQLError: if an argument is not a valid field
"""
# Concatenate fields without and with alias
added_fields: Tuple["DSLSelectable", ...] = DSLField.get_aliased_fields(
fields, fields_with_alias
)
# Check that each field is valid
for field in added_fields:
if not isinstance(field, DSLSelectable):
raise TypeError(
"Fields should be instances of DSLSelectable. "
f"Received: {type(field)}"
)
if not self.is_valid_field(field):
raise GraphQLError(f"Invalid field for {self!r}: {field!r}")
# Get a list of AST Nodes for each added field
added_selections: Tuple[
Union[FieldNode, InlineFragmentNode, FragmentSpreadNode], ...
] = tuple(field.ast_field for field in added_fields)
# Update the current selection list with new selections
self.selection_set.selections = self.selection_set.selections + added_selections
log.debug(f"Added fields: {added_fields} in {self!r}")
class DSLExecutable(DSLSelector):
"""Interface for the root elements which can be executed
in the :func:`dsl_gql <gql.dsl.dsl_gql>` function
Inherited by
:class:`DSLOperation <gql.dsl.DSLOperation>` and
:class:`DSLFragment <gql.dsl.DSLFragment>`
"""
variable_definitions: "DSLVariableDefinitions"
name: Optional[str]
selection_set: SelectionSetNode
@property
@abstractmethod
def executable_ast(self):
"""Generates the ast for :func:`dsl_gql <gql.dsl.dsl_gql>`."""
raise NotImplementedError(
"Any DSLExecutable subclass must have executable_ast property"
) # pragma: no cover
def __init__(
self,
*fields: "DSLSelectable",
**fields_with_alias: "DSLSelectableWithAlias",
):
r"""Given arguments of type :class:`DSLSelectable` containing GraphQL requests,
generate an operation which can be converted to a Document
using the :func:`dsl_gql <gql.dsl.dsl_gql>`.
The fields arguments should be either be fragments or
fields of root GraphQL types
(Query, Mutation or Subscription) and correspond to the
operation_type of this operation.
:param \*fields: root fields or fragments
:type \*fields: DSLSelectable
:param \**fields_with_alias: root fields or fragments with alias as key
:type \**fields_with_alias: DSLSelectable
:raises TypeError: if an argument is not an instance of :class:`DSLSelectable`
:raises AssertionError: if an argument is not a field which correspond
to the operation type
"""
self.name = None
self.variable_definitions = DSLVariableDefinitions()
DSLSelector.__init__(self, *fields, **fields_with_alias)
class DSLRootFieldSelector(DSLSelector):
"""Class used to define the
:meth:`is_valid_field <gql.dsl.DSLRootFieldSelector.is_valid_field>` method
for root fields for the :meth:`select <gql.dsl.DSLSelector.select>` method.
Inherited by
:class:`DSLOperation <gql.dsl.DSLOperation>`
"""
def is_valid_field(self, field: "DSLSelectable") -> bool:
"""Check that a field is valid for a root field.
For operations, the fields arguments should be fields of root GraphQL types
(Query, Mutation or Subscription) and correspond to the
operation_type of this operation.
the :code:`__typename` field can only be added to Query or Mutation.
the :code:`__schema` and :code:`__type` field can only be added to Query.
"""
assert isinstance(self, DSLOperation)
operation_name = self.operation_type.name
if isinstance(field, DSLMetaField):
if field.name in ["__schema", "__type"]:
return operation_name == "QUERY"
if field.name == "__typename":
return operation_name != "SUBSCRIPTION"
elif isinstance(field, DSLField):
assert field.dsl_type is not None
schema = field.dsl_type._dsl_schema._schema
root_type = None
if operation_name == "QUERY":
root_type = schema.query_type
elif operation_name == "MUTATION":
root_type = schema.mutation_type
elif operation_name == "SUBSCRIPTION":
root_type = schema.subscription_type
if root_type is None:
log.error(
f"Root type of type {operation_name} not found in the schema!"
)
return False
return field.parent_type.name == root_type.name
return False
class DSLOperation(DSLExecutable, DSLRootFieldSelector):
"""Interface for GraphQL operations.
Inherited by
:class:`DSLQuery <gql.dsl.DSLQuery>`,
:class:`DSLMutation <gql.dsl.DSLMutation>` and
:class:`DSLSubscription <gql.dsl.DSLSubscription>`
"""
operation_type: OperationType
@property
def executable_ast(self) -> OperationDefinitionNode:
"""Generates the ast for :func:`dsl_gql <gql.dsl.dsl_gql>`."""
return OperationDefinitionNode(
operation=OperationType(self.operation_type),
selection_set=self.selection_set,
variable_definitions=self.variable_definitions.get_ast_definitions(),
**({"name": NameNode(value=self.name)} if self.name else {}),
directives=(),
)
def __repr__(self) -> str:
return f"<{self.__class__.__name__}>"
class DSLQuery(DSLOperation):
operation_type = OperationType.QUERY
class DSLMutation(DSLOperation):
operation_type = OperationType.MUTATION
class DSLSubscription(DSLOperation):
operation_type = OperationType.SUBSCRIPTION
class DSLVariable:
"""The DSLVariable represents a single variable defined in a GraphQL operation
Instances of this class are generated for you automatically as attributes
of the :class:`DSLVariableDefinitions`
The type of the variable is set by the :class:`DSLField` instance that receives it
in the :meth:`args <gql.dsl.DSLField.args>` method.
"""
def __init__(self, name: str):
""":meta private:"""
self.name = name
self.ast_variable_type: Optional[TypeNode] = None
self.ast_variable_name = VariableNode(name=NameNode(value=self.name))
self.default_value = None
self.type: Optional[GraphQLInputType] = None
def to_ast_type(self, type_: GraphQLInputType) -> TypeNode:
if is_wrapping_type(type_):
if isinstance(type_, GraphQLList):
return ListTypeNode(type=self.to_ast_type(type_.of_type))
elif isinstance(type_, GraphQLNonNull):
return NonNullTypeNode(type=self.to_ast_type(type_.of_type))
assert isinstance(
type_, (GraphQLScalarType, GraphQLEnumType, GraphQLInputObjectType)
)
return NamedTypeNode(name=NameNode(value=type_.name))
def set_type(self, type_: GraphQLInputType) -> "DSLVariable":
self.type = type_
self.ast_variable_type = self.to_ast_type(type_)
return self
def default(self, default_value: Any) -> "DSLVariable":
self.default_value = default_value
return self
class DSLVariableDefinitions:
"""The DSLVariableDefinitions represents variable definitions in a GraphQL operation
Instances of this class have to be created and set as the `variable_definitions`
attribute of a DSLOperation instance
Attributes of the DSLVariableDefinitions class are generated automatically
with the `__getattr__` dunder method in order to generate
instances of :class:`DSLVariable`, that can then be used as values
in the :meth:`args <gql.dsl.DSLField.args>` method.
"""
def __init__(self):
""":meta private:"""
self.variables: Dict[str, DSLVariable] = {}
def __getattr__(self, name: str) -> "DSLVariable":
if name not in self.variables:
self.variables[name] = DSLVariable(name)
return self.variables[name]
def get_ast_definitions(self) -> Tuple[VariableDefinitionNode, ...]:
"""
:meta private:
Return a list of VariableDefinitionNodes for each variable with a type
"""
return tuple(
VariableDefinitionNode(
type=var.ast_variable_type,
variable=var.ast_variable_name,
default_value=(
None
if var.default_value is None
else ast_from_value(var.default_value, var.type)
),
directives=(),
)
for var in self.variables.values()
if var.type is not None # only variables used
)
class DSLType:
"""The DSLType represents a GraphQL type for the DSL code.
It can be a root type (Query, Mutation or Subscription).
Or it can be any other object type (Human in the StarWars schema).
Or it can be an interface type (Character in the StarWars schema).
Instances of this class are generated for you automatically as attributes
of the :class:`DSLSchema`
Attributes of the DSLType class are generated automatically
with the `__getattr__` dunder method in order to generate
instances of :class:`DSLField`
"""
def __init__(
self,
graphql_type: Union[GraphQLObjectType, GraphQLInterfaceType],
dsl_schema: DSLSchema,
):
"""Initialize the DSLType with the GraphQL type.
.. warning::
Don't instantiate this class yourself.
Use attributes of the :class:`DSLSchema` instead.
:param graphql_type: the GraphQL type definition from the schema
:param dsl_schema: reference to the DSLSchema which created this type
"""
self._type: Union[GraphQLObjectType, GraphQLInterfaceType] = graphql_type
self._dsl_schema = dsl_schema
log.debug(f"Creating {self!r})")
def __getattr__(self, name: str) -> "DSLField":
camel_cased_name = to_camel_case(name)
if name in self._type.fields:
formatted_name = name
field = self._type.fields[name]
elif camel_cased_name in self._type.fields:
formatted_name = camel_cased_name
field = self._type.fields[camel_cased_name]
else:
raise AttributeError(
f"Field {name} does not exist in type {self._type.name}."
)
return DSLField(formatted_name, self._type, field, self)
def __repr__(self) -> str:
return f"<{self.__class__.__name__} {self._type!r}>"
class DSLSelectable(ABC):
"""DSLSelectable is an abstract class which indicates that
the subclasses can be used as arguments of the
:meth:`select <gql.dsl.DSLSelector.select>` method.
Inherited by
:class:`DSLField <gql.dsl.DSLField>`,
:class:`DSLFragment <gql.dsl.DSLFragment>`
:class:`DSLInlineFragment <gql.dsl.DSLInlineFragment>`
"""
ast_field: Union[FieldNode, InlineFragmentNode, FragmentSpreadNode]
@staticmethod
def get_aliased_fields(
fields: Iterable["DSLSelectable"],
fields_with_alias: Dict[str, "DSLSelectableWithAlias"],
) -> Tuple["DSLSelectable", ...]:
"""
:meta private:
Concatenate all the fields (with or without alias) in a Tuple.
Set the requested alias for the fields with alias.
"""
return (
*fields,
*(field.alias(alias) for alias, field in fields_with_alias.items()),
)
def __str__(self) -> str:
return print_ast(self.ast_field)
class DSLFragmentSelector(DSLSelector):
"""Class used to define the
:meth:`is_valid_field <gql.dsl.DSLFragmentSelector.is_valid_field>` method
for fragments for the :meth:`select <gql.dsl.DSLSelector.select>` method.
Inherited by
:class:`DSLFragment <gql.dsl.DSLFragment>`,
:class:`DSLInlineFragment <gql.dsl.DSLInlineFragment>`
"""
def is_valid_field(self, field: DSLSelectable) -> bool:
"""Check that a field is valid."""
assert isinstance(self, (DSLFragment, DSLInlineFragment))
if isinstance(field, (DSLFragment, DSLInlineFragment)):
return True
assert isinstance(field, DSLField)
if isinstance(field, DSLMetaField):
return field.name == "__typename"
fragment_type = self._type
assert fragment_type is not None
if field.name in fragment_type.fields.keys():
return fragment_type.fields[field.name].type == field.field.type
return False
class DSLFieldSelector(DSLSelector):
"""Class used to define the
:meth:`is_valid_field <gql.dsl.DSLFieldSelector.is_valid_field>` method
for fields for the :meth:`select <gql.dsl.DSLSelector.select>` method.
Inherited by
:class:`DSLField <gql.dsl.DSLField>`,
"""
def is_valid_field(self, field: DSLSelectable) -> bool:
"""Check that a field is valid."""
assert isinstance(self, DSLField)
if isinstance(field, (DSLFragment, DSLInlineFragment)):
return True
assert isinstance(field, DSLField)
if isinstance(field, DSLMetaField):
return field.name == "__typename"
parent_type = get_named_type(self.field.type)
if not isinstance(parent_type, (GraphQLInterfaceType, GraphQLObjectType)):
return False
if field.name in parent_type.fields.keys():
return parent_type.fields[field.name].type == field.field.type
return False
class DSLSelectableWithAlias(DSLSelectable):
"""DSLSelectableWithAlias is an abstract class which indicates that
the subclasses can be selected with an alias.
"""
ast_field: FieldNode
def alias(self, alias: str) -> "DSLSelectableWithAlias":
"""Set an alias
.. note::
You can also pass the alias directly at the
:meth:`select <gql.dsl.DSLSelector.select>` method.
:code:`ds.Query.human.select(my_name=ds.Character.name)` is equivalent to:
:code:`ds.Query.human.select(ds.Character.name.alias("my_name"))`
:param alias: the alias
:type alias: str
:return: itself
"""
self.ast_field.alias = NameNode(value=alias)
return self
class DSLField(DSLSelectableWithAlias, DSLFieldSelector):
"""The DSLField represents a GraphQL field for the DSL code.
Instances of this class are generated for you automatically as attributes
of the :class:`DSLType`
If this field contains children fields, then you need to select which ones
you want in the request using the :meth:`select <gql.dsl.DSLField.select>`
method.
"""
_type: Union[GraphQLObjectType, GraphQLInterfaceType]
ast_field: FieldNode
field: GraphQLField
def __init__(
self,
name: str,
parent_type: Union[GraphQLObjectType, GraphQLInterfaceType],
field: GraphQLField,
dsl_type: Optional[DSLType] = None,
):
"""Initialize the DSLField.
.. warning::
Don't instantiate this class yourself.
Use attributes of the :class:`DSLType` instead.
:param name: the name of the field
:param parent_type: the GraphQL type definition from the schema of the
parent type of the field
:param field: the GraphQL field definition from the schema
:param dsl_type: reference of the DSLType instance which created this field
"""
self.parent_type = parent_type
self.field = field
self.ast_field = FieldNode(
name=NameNode(value=name),
arguments=(),
directives=(),
)
self.dsl_type = dsl_type
log.debug(f"Creating {self!r}")
DSLSelector.__init__(self)
@property
def name(self):
""":meta private:"""
return self.ast_field.name.value
def __call__(self, **kwargs: Any) -> "DSLField":
return self.args(**kwargs)
def args(self, **kwargs: Any) -> "DSLField":
r"""Set the arguments of a field
The arguments are parsed to be stored in the AST of this field.
.. note::
You can also call the field directly with your arguments.
:code:`ds.Query.human(id=1000)` is equivalent to:
:code:`ds.Query.human.args(id=1000)`
:param \**kwargs: the arguments (keyword=value)
:return: itself
:raises KeyError: if any of the provided arguments does not exist
for this field.
"""
assert self.ast_field.arguments is not None
self.ast_field.arguments = self.ast_field.arguments + tuple(
ArgumentNode(
name=NameNode(value=name),
value=ast_from_value(value, self._get_argument(name).type),
)
for name, value in kwargs.items()
)
log.debug(f"Added arguments {kwargs} in field {self!r})")
return self
def _get_argument(self, name: str) -> GraphQLArgument:
"""Method used to return the GraphQLArgument definition
of an argument from its name.
:raises KeyError: if the provided argument does not exist
for this field.
"""
arg = self.field.args.get(name)
if arg is None:
raise KeyError(f"Argument {name} does not exist in {self.field}.")
return arg
def select(
self, *fields: "DSLSelectable", **fields_with_alias: "DSLSelectableWithAlias"
) -> "DSLField":
"""Calling :meth:`select <gql.dsl.DSLSelector.select>` method with
corrected typing hints
"""
super().select(*fields, **fields_with_alias)
self.ast_field.selection_set = self.selection_set
return self
def __repr__(self) -> str:
return f"<{self.__class__.__name__} {self.parent_type.name}" f"::{self.name}>"
class DSLMetaField(DSLField):
"""DSLMetaField represents a GraphQL meta-field for the DSL code.
meta-fields are reserved field in the GraphQL type system prefixed with
"__" two underscores and used for introspection.
"""
meta_type = GraphQLObjectType(
"meta_field",
fields={
"__typename": GraphQLField(GraphQLString),
"__schema": GraphQLField(
cast(GraphQLObjectType, introspection_types["__Schema"])
),
"__type": GraphQLField(
cast(GraphQLObjectType, introspection_types["__Type"]),
args={"name": GraphQLArgument(type_=GraphQLNonNull(GraphQLString))},
),
},
)
def __init__(self, name: str):
"""Initialize the meta-field.
:param name: the name between __typename, __schema or __type
"""
try:
field = self.meta_type.fields[name]
except KeyError:
raise GraphQLError(f'Invalid meta-field "{name}"')
super().__init__(name, self.meta_type, field)
class DSLInlineFragment(DSLSelectable, DSLFragmentSelector):
"""DSLInlineFragment represents an inline fragment for the DSL code."""
_type: Union[GraphQLObjectType, GraphQLInterfaceType]
ast_field: InlineFragmentNode
def __init__(
self,
*fields: "DSLSelectable",
**fields_with_alias: "DSLSelectableWithAlias",
):
r"""Initialize the DSLInlineFragment.
:param \*fields: new children fields
:type \*fields: DSLSelectable (DSLField, DSLFragment or DSLInlineFragment)
:param \**fields_with_alias: new children fields with alias as key
:type \**fields_with_alias: DSLField
"""
log.debug(f"Creating {self!r}")
self.ast_field = InlineFragmentNode(directives=())
DSLSelector.__init__(self, *fields, **fields_with_alias)
def select(
self, *fields: "DSLSelectable", **fields_with_alias: "DSLSelectableWithAlias"
) -> "DSLInlineFragment":
"""Calling :meth:`select <gql.dsl.DSLSelector.select>` method with
corrected typing hints
"""
super().select(*fields, **fields_with_alias)
self.ast_field.selection_set = self.selection_set
return self
def on(self, type_condition: DSLType) -> "DSLInlineFragment":
"""Provides the GraphQL type of this inline fragment."""
self._type = type_condition._type
self.ast_field.type_condition = NamedTypeNode(
name=NameNode(value=self._type.name)
)
return self
def __repr__(self) -> str:
type_info = ""
try:
type_info += f" on {self._type.name}"
except AttributeError:
pass
return f"<{self.__class__.__name__}{type_info}>"
class DSLFragment(DSLSelectable, DSLFragmentSelector, DSLExecutable):
"""DSLFragment represents a named GraphQL fragment for the DSL code."""
_type: Optional[Union[GraphQLObjectType, GraphQLInterfaceType]]
ast_field: FragmentSpreadNode
name: str
def __init__(
self,
name: str,
):
r"""Initialize the DSLFragment.
:param name: the name of the fragment
:type name: str
"""
DSLExecutable.__init__(self)
self.name = name
self._type = None
log.debug(f"Creating {self!r}")
@property # type: ignore
def ast_field(self) -> FragmentSpreadNode: # type: ignore
"""ast_field property will generate a FragmentSpreadNode with the
provided name.
Note: We need to ignore the type because of
`issue #4125 of mypy <https://github.com/python/mypy/issues/4125>`_.
"""
spread_node = FragmentSpreadNode(directives=())
spread_node.name = NameNode(value=self.name)
return spread_node
def select(
self, *fields: "DSLSelectable", **fields_with_alias: "DSLSelectableWithAlias"
) -> "DSLFragment":
"""Calling :meth:`select <gql.dsl.DSLSelector.select>` method with
corrected typing hints
"""
if self._type is None:
raise AttributeError(
"Missing type condition. Please use .on(type_condition) method"
)
super().select(*fields, **fields_with_alias)
return self
def on(self, type_condition: DSLType) -> "DSLFragment":
"""Provides the GraphQL type of this fragment.
:param type_condition: the provided type
:type type_condition: DSLType
"""
self._type = type_condition._type
return self
@property
def executable_ast(self) -> FragmentDefinitionNode:
"""Generates the ast for :func:`dsl_gql <gql.dsl.dsl_gql>`.
:raises AttributeError: if a type has not been provided
"""
assert self.name is not None
if self._type is None:
raise AttributeError(
"Missing type condition. Please use .on(type_condition) method"
)
fragment_variable_definitions = self.variable_definitions.get_ast_definitions()
if len(fragment_variable_definitions) == 0:
"""Fragment variable definitions are obsolete and only supported on
graphql-core if the Parser is initialized with:
allow_legacy_fragment_variables=True.
We will not provide variable_definitions instead of providing an empty
tuple to be coherent with how it works by default on graphql-core.
"""
variable_definition_kwargs = {}
else:
variable_definition_kwargs = {
"variable_definitions": fragment_variable_definitions
}
return FragmentDefinitionNode(
type_condition=NamedTypeNode(name=NameNode(value=self._type.name)),
selection_set=self.selection_set,
**variable_definition_kwargs,
name=NameNode(value=self.name),
directives=(),
)
def __repr__(self) -> str:
return f"<{self.__class__.__name__} {self.name!s}>"
|