File: language.rst

package info (click to toggle)
graphql-core 3.2.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 5,384 kB
  • sloc: python: 45,812; makefile: 26; sh: 13
file content (168 lines) | stat: -rw-r--r-- 4,305 bytes parent folder | download
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
Language
========

.. currentmodule:: graphql.language

.. automodule:: graphql.language
   :no-members:
   :no-inherited-members:

AST
---

.. autoclass:: Location
.. autoclass:: Node

Each kind of AST node has its own class:

.. autoclass:: ArgumentNode
.. autoclass:: BooleanValueNode
.. autoclass:: ConstArgumentNode
.. autoclass:: ConstDirectiveNode
.. autoclass:: ConstListValueNode
.. autoclass:: ConstObjectFieldNode
.. autoclass:: ConstObjectValueNode
.. autoclass:: ConstValueNode
.. autoclass:: DefinitionNode
.. autoclass:: DirectiveDefinitionNode
.. autoclass:: DirectiveNode
.. autoclass:: DocumentNode
.. autoclass:: EnumTypeDefinitionNode
.. autoclass:: EnumTypeExtensionNode
.. autoclass:: EnumValueDefinitionNode
.. autoclass:: EnumValueNode
.. autoclass:: ExecutableDefinitionNode
.. autoclass:: FieldDefinitionNode
.. autoclass:: FieldNode
.. autoclass:: FloatValueNode
.. autoclass:: FragmentDefinitionNode
.. autoclass:: FragmentSpreadNode
.. autoclass:: InlineFragmentNode
.. autoclass:: InputObjectTypeDefinitionNode
.. autoclass:: InputObjectTypeExtensionNode
.. autoclass:: InputValueDefinitionNode
.. autoclass:: IntValueNode
.. autoclass:: InterfaceTypeDefinitionNode
.. autoclass:: InterfaceTypeExtensionNode
.. autoclass:: ListTypeNode
.. autoclass:: ListValueNode
.. autoclass:: NameNode
.. autoclass:: NamedTypeNode
.. autoclass:: NonNullTypeNode
.. autoclass:: NullValueNode
.. autoclass:: ObjectFieldNode
.. autoclass:: ObjectTypeDefinitionNode
.. autoclass:: ObjectTypeExtensionNode
.. autoclass:: ObjectValueNode
.. autoclass:: OperationDefinitionNode
.. autoclass:: OperationType
.. autoclass:: OperationTypeDefinitionNode
.. autoclass:: ScalarTypeDefinitionNode
.. autoclass:: ScalarTypeExtensionNode
.. autoclass:: SchemaDefinitionNode
.. autoclass:: SchemaExtensionNode
.. autoclass:: SelectionNode
.. autoclass:: SelectionSetNode
.. autoclass:: StringValueNode
.. autoclass:: TypeDefinitionNode
.. autoclass:: TypeExtensionNode
.. autoclass:: TypeNode
.. autoclass:: TypeSystemDefinitionNode
.. autoclass:: TypeSystemExtensionNode
.. autoclass:: UnionTypeDefinitionNode
.. autoclass:: UnionTypeExtensionNode
.. autoclass:: ValueNode
.. autoclass:: VariableDefinitionNode
.. autoclass:: VariableNode

Directive locations are specified using the following enumeration:

.. autoclass:: DirectiveLocation

You can also check the type of nodes with the following predicates:

.. autofunction:: is_definition_node
.. autofunction:: is_executable_definition_node
.. autofunction:: is_selection_node
.. autofunction:: is_value_node
.. autofunction:: is_const_value_node
.. autofunction:: is_type_node
.. autofunction:: is_type_system_definition_node
.. autofunction:: is_type_definition_node
.. autofunction:: is_type_system_extension_node
.. autofunction:: is_type_extension_node

Lexer
-----

.. autoclass:: Lexer
.. autoclass:: TokenKind
.. autoclass:: Token

Location
--------

.. autofunction:: get_location
.. autoclass:: SourceLocation
.. autofunction:: print_location
.. autoclass:: FormattedSourceLocation
   :no-inherited-members:


Parser
------

.. autofunction:: parse
.. autofunction:: parse_type
.. autofunction:: parse_value
.. autofunction:: parse_const_value

Printer
-------

.. autofunction:: print_ast

Source
------

.. autoclass:: Source
.. autofunction:: print_source_location

Visitor
-------

.. autofunction:: visit
.. autoclass:: Visitor
.. autoclass:: ParallelVisitor

The module also exports the following enumeration that can be used as the return type
for :class:`Visitor` methods:

.. currentmodule:: graphql.language.visitor

.. autoclass:: VisitorActionEnum

.. currentmodule:: graphql.language

The module also exports the values of this enumeration directly. These can be used as
return values of :class:`Visitor` methods to signal particular actions:

.. data:: BREAK
   :annotation: (same as ``True``)

   This return value signals that no further nodes shall be visited.

.. data:: SKIP
   :annotation: (same as ``False``)

   This return value signals that the current node shall be skipped.

.. data:: REMOVE
   :annotation: (same as``Ellipsis``)

   This return value signals that the current node shall be deleted.

.. data:: IDLE
   :annotation: = None

   This return value signals that no additional action shall take place.