Skip to content

Commit

Permalink
Add note about the use of args (#1170)
Browse files Browse the repository at this point in the history
* Add note about the use of `args`

Closes #1037

* Some improvements

* Link to correct place
  • Loading branch information
jkimbo committed Apr 2, 2020
1 parent 9fdab03 commit a2fe8dd
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Object types
.. autoclass:: graphene.Mutation
:members:

.. _fields-mounted-types:

Fields (Mounted Types)
----------------------

Expand Down
16 changes: 16 additions & 0 deletions docs/types/objecttypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,22 @@ You can then execute the following query:
}
}
*Note:* There are several arguments to a field that are "reserved" by Graphene
(see :ref:`fields-mounted-types`).
You can still define an argument that clashes with one of these fields by using
the ``args`` parameter like so:
.. code:: python
from graphene import ObjectType, Field, String
class Query(ObjectType):
answer = String(args={'description': String()})
def resolve_answer(parent, info, description):
return description
Convenience Features of Graphene Resolvers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
7 changes: 4 additions & 3 deletions graphene/types/field.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,12 @@ class Person(ObjectType):
last_name = graphene.Field(String, description='Surname') # explicitly mounted as Field
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
field in the GraphQL schema.
args (optional, Dict[str, graphene.Argument]): arguments that can be input to the field.
Prefer to use **extra_args.
args (optional, Dict[str, graphene.Argument]): Arguments that can be input to the field.
Prefer to use ``**extra_args``, unless you use an argument name that clashes with one
of the Field arguments presented here (see :ref:`example<ResolverParamGraphQLArguments>`).
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.
source (optional, str): attribute name to resolve for this field from the parent value
Expand Down

0 comments on commit a2fe8dd

Please sign in to comment.