mirror of
				https://github.com/graphql-python/graphene.git
				synced 2025-10-31 07:57:26 +03:00 
			
		
		
		
	Added docs for List and NonNull types. Fixed #326
This commit is contained in:
		
							parent
							
								
									81a2ed0bfe
								
							
						
					
					
						commit
						e2cdd80a5c
					
				|  | @ -7,6 +7,7 @@ Types Reference | |||
| 
 | ||||
|    enums | ||||
|    scalars | ||||
|    list-and-nonnull | ||||
|    interfaces | ||||
|    abstracttypes | ||||
|    objecttypes | ||||
|  |  | |||
							
								
								
									
										50
									
								
								docs/types/list-and-nonnull.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										50
									
								
								docs/types/list-and-nonnull.rst
									
									
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,50 @@ | |||
| Lists and Non-Null | ||||
| ================== | ||||
| 
 | ||||
| Object types, scalars, and enums are the only kinds of types you can | ||||
| define in Graphene. But when you use the types in other parts of the | ||||
| schema, or in your query variable declarations, you can apply additional | ||||
| type modifiers that affect validation of those values. | ||||
| 
 | ||||
| NonNull | ||||
| ------- | ||||
| 
 | ||||
| .. code:: python | ||||
| 
 | ||||
|     import graphene | ||||
| 
 | ||||
|     class Character(graphene.ObjectType): | ||||
|         name = graphene.NonNull(graphene.String) | ||||
| 
 | ||||
| 
 | ||||
| Here, we're using a ``String`` type and marking it as Non-Null by wrapping | ||||
| it using the ``NonNull`` class. This means that our server always expects | ||||
| to return a non-null value for this field, and if it ends up getting a | ||||
| null value that will actually trigger a GraphQL execution error, | ||||
| letting the client know that something has gone wrong. | ||||
| 
 | ||||
| 
 | ||||
| The previous ``NonNull`` code snippet is also equivalent to: | ||||
| 
 | ||||
| .. code:: python | ||||
| 
 | ||||
|     import graphene | ||||
| 
 | ||||
|     class Character(graphene.ObjectType): | ||||
|         name = graphene.String(required=True) | ||||
| 
 | ||||
| 
 | ||||
| List | ||||
| ---- | ||||
| 
 | ||||
| .. code:: python | ||||
| 
 | ||||
|     import graphene | ||||
| 
 | ||||
|     class Character(graphene.ObjectType): | ||||
|         appears_in = graphene.List(graphene.String) | ||||
| 
 | ||||
| Lists work in a similar way: We can use a type modifier to mark a type as a | ||||
| ``List``, which indicates that this field will return a list of that type. | ||||
| It works the same for arguments, where the validation step will expect a list | ||||
| for that value. | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user