graphql-python/graphene
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene.git synced 2024-11-13 13:16:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improved docs

Browse Source
This commit is contained in:
Syrus Akbary 2016-06-15 21:00:06 -07:00
parent b91e10ef8a
commit 2172edc033
2 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
graphene/types/structures.py
View File

@ -6,7 +6,10 @@ from .unmountedtype import UnmountedType
class Structure(UnmountedType): class Structure(UnmountedType):
'''
A structure is a GraphQL type instance that
wraps a main type with certain structure.
'''
def __init__(self, of_type, *args, **kwargs): def __init__(self, of_type, *args, **kwargs):
super(Structure, self).__init__(*args, **kwargs) super(Structure, self).__init__(*args, **kwargs)
self.of_type = of_type self.of_type = of_type

24
graphene/types/unmountedtype.py
View File

@ -3,22 +3,18 @@ from .argument import Argument
from .field import Field, InputField from .field import Field, InputField
# UnmountedType ?
class UnmountedType(OrderedType): class UnmountedType(OrderedType):
''' '''
This class acts a proxy for a Graphene Type, so it can be mounted This class acts a proxy for a Graphene Type, so it can be mounted
as Field, InputField or Argument. as Field, InputField or Argument.
Instead of doing Instead of writing
>>> class MyObjectType(ObjectType): >>> class MyObjectType(ObjectType):
>>> my_field = Field(String(), description='Description here') >>> my_field = Field(String(), description='Description here')
You can actually do It let you write
>>> class MyObjectType(ObjectType): >>> class MyObjectType(ObjectType):
>>> my_field = String(description='Description here') >>> my_field = String(description='Description here')
So is simpler to use.
''' '''
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
@ -30,6 +26,9 @@ class UnmountedType(OrderedType):
return self._meta.graphql_type return self._meta.graphql_type
def as_field(self): def as_field(self):
'''
Mount the UnmountedType as Field
'''
return Field( return Field(
self.get_type(), self.get_type(),
*self.args, *self.args,
@ -38,6 +37,9 @@ class UnmountedType(OrderedType):
) )
def as_inputfield(self): def as_inputfield(self):
'''
Mount the UnmountedType as InputField
'''
return InputField( return InputField(
self.get_type(), self.get_type(),
*self.args, *self.args,
@ -46,6 +48,9 @@ class UnmountedType(OrderedType):
) )
def as_argument(self): def as_argument(self):
'''
Mount the UnmountedType as Argument
'''
return Argument( return Argument(
self.get_type(), self.get_type(),
*self.args, *self.args,
@ -54,6 +59,13 @@ class UnmountedType(OrderedType):
) )
def as_mounted(self, cls): def as_mounted(self, cls):
'''
Mount the UnmountedType dinamically as Field or InputField
depending on the class is mounted in.
ObjectType -> Field
InputObjectType -> InputField
'''
from .inputobjecttype import InputObjectType from .inputobjecttype import InputObjectType
from .objecttype import ObjectType from .objecttype import ObjectType
from .interface import Interface from .interface import Interface