graphql-python/graphene
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene.git synced 2025-07-18 12:02:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

Some improvements

Browse Source
This commit is contained in:
Jonathan Kim 2020-04-02 10:53:57 +01:00
parent 9be3922ad5
commit 31138f485f
3 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/index.rst
View File

@ -20,6 +20,8 @@ Object types
.. autoclass:: graphene.Mutation .. autoclass:: graphene.Mutation
:members: :members:
.. _fields-mounted-types:
Fields (Mounted Types) Fields (Mounted Types)
---------------------- ----------------------

6
docs/types/objecttypes.rst
View File

@ -159,16 +159,16 @@ You can then execute the following query:
} }
*Note:* There are several arguments to a field that are "reserved" by Graphene *Note:* There are several arguments to a field that are "reserved" by Graphene
(you can see the full list here: https://docs.graphene-python.org/en/latest/api/#fields-mounted-types). (see :ref:`fields-mounted-types`).
You can still define an argument that clashes with one of these fields by using You can still define an argument that clashes with one of these fields by using
the ``args`` paramter like so: the ``args`` parameter like so:
.. code:: python .. code:: python
from graphene import ObjectType, Field, String from graphene import ObjectType, Field, String
class Query(ObjectType): class Query(ObjectType):
answer = graphene.Int(args={'description': graphene.Int()}) answer = String(args={'description': String()})
def resolve_answer(parent, info, description): def resolve_answer(parent, info, description):
return description return description

7
graphene/types/field.py
View File

@ -40,11 +40,12 @@ class Field(MountedType):
last_name = graphene.Field(String, description='Surname') # explicitly mounted as Field last_name = graphene.Field(String, description='Surname') # explicitly mounted as Field
args: args:
type (class for a graphene.UnmountedType): must be a class (not an instance) of an type (class for a graphene.UnmountedType): Must be a class (not an instance) of an
unmounted graphene type (ex. scalar or object) which is used for the type of this unmounted graphene type (ex. scalar or object) which is used for the type of this
field in the GraphQL schema. field in the GraphQL schema.
args (optional, Dict[str, graphene.Argument]): arguments that can be input to the field. args (optional, Dict[str, graphene.Argument]): Arguments that can be input to the field.
Prefer to use **extra_args. Prefer to use ``**extra_args``, unless you use an argument name that clashes with one
of the Field arguments presented here (see :ref:`example<Scalars>`).
resolver (optional, Callable): A function to get the value for a Field from the parent resolver (optional, Callable): A function to get the value for a Field from the parent
value object. If not set, the default resolver method for the schema is used. value object. If not set, the default resolver method for the schema is used.
source (optional, str): attribute name to resolve for this field from the parent value source (optional, str): attribute name to resolve for this field from the parent value