Merge pull request #84 from graphql-python/feat-support-file-field

Feat support file field

Author: abawchen

graphene_mongo/advanced_types.py

@@ -1,16 +1,49 @@
+import base64
 import graphene
 
 
-__all__ = [
-    'PointFieldType',
-    'MultiPolygonFieldType'
-]
-
-
 def _resolve_type_coordinates(self, info):
     return self['coordinates']
 
 
+def _resolve_fs_field(field, name, default_value=None):
+    v = getattr(field.instance, field.key)
+    return getattr(v, name, default_value)
+
+
+def _resolve_content_type(self, info):
+    return _resolve_fs_field(self, 'content_type')
+
+
+def _resolve_md5(self, info):
+    return _resolve_fs_field(self, 'md5')
+
+
+def _resolve_chunk_size(self, info):
+    return _resolve_fs_field(self, 'chunk_size', 0)
+
+
+def _resolve_length(self, info):
+    return _resolve_fs_field(self, 'length', 0)
+
+
+def _resolve_data(self, info):
+    v = getattr(self.instance, self.key)
+    data = v.read()
+    if data is not None:
+        return base64.b64encode(data)
+    return None
+
+
+class FileFieldType(graphene.ObjectType):
+
+    content_type = graphene.String(resolver=_resolve_content_type)
+    md5 = graphene.String(resolver=_resolve_md5)
+    chunk_size = graphene.Int(resolver=_resolve_chunk_size)
+    length = graphene.Int(resolver=_resolve_length)
+    data = graphene.String(resolver=_resolve_data)
+
+
 class _TypeField(graphene.ObjectType):
 
     type = graphene.String()

graphene_mongo/converter.py

@@ -66,19 +66,24 @@ def convert_field_to_float(field, registry=None):
     return Float(description=get_field_description(field, registry), required=field.required)
 
 
+@convert_mongoengine_field.register(mongoengine.DateTimeField)
+def convert_field_to_datetime(field, registry=None):
+    return DateTime(description=get_field_description(field, registry), required=field.required)
+
+
 @convert_mongoengine_field.register(mongoengine.DictField)
 @convert_mongoengine_field.register(mongoengine.MapField)
-def convert_dict_to_jsonstring(field, registry=None):
+def convert_field_to_jsonstring(field, registry=None):
     return JSONString(description=get_field_description(field, registry), required=field.required)
 
 
 @convert_mongoengine_field.register(mongoengine.PointField)
-def convert_point_to_field(field, register=None):
+def convert_point_to_field(field, registry=None):
     return Field(advanced_types.PointFieldType)
 
 
 @convert_mongoengine_field.register(mongoengine.PolygonField)
-def convert_polygon_to_field(field, register=None):
+def convert_polygon_to_field(field, registry=None):
     return Field(advanced_types.PolygonFieldType)
 
 
@@ -87,9 +92,9 @@ def convert_multipolygon_to_field(field, register=None):
     return Field(advanced_types.MultiPolygonFieldType)
 
 
-@convert_mongoengine_field.register(mongoengine.DateTimeField)
-def convert_field_to_datetime(field, registry=None):
-    return DateTime(description=get_field_description(field, registry), required=field.required)
+@convert_mongoengine_field.register(mongoengine.FileField)
+def convert_file_to_field(field, registry=None):
+    return Field(advanced_types.FileFieldType)
 
 
 @convert_mongoengine_field.register(mongoengine.ListField)

graphene_mongo/fields.py

@@ -11,7 +11,9 @@
 from graphene.types.structures import Structure
 from graphql_relay.connection.arrayconnection import connection_from_list_slice
 
-from .advanced_types import PointFieldType, MultiPolygonFieldType
+from .advanced_types import (
+    FileFieldType, PointFieldType, MultiPolygonFieldType
+)
 from .converter import convert_mongoengine_field, MongoEngineConversionError
 from .registry import get_global_registry
 from .utils import get_model_reference_fields, get_node_from_global_id
@@ -64,6 +66,7 @@ def args(self, args):
         self._base_args = args
 
     def _field_args(self, items):
+
         def is_filterable(k):
             """
             Args:
@@ -85,7 +88,7 @@ def is_filterable(k):
             if callable(getattr(converted, 'type', None)) \
                     and isinstance(
                         converted.type(),
-                        (PointFieldType, MultiPolygonFieldType, graphene.Union)):
+                        (FileFieldType, PointFieldType, MultiPolygonFieldType, graphene.Union)):
                 return False
             return True
 
@@ -102,6 +105,7 @@ def field_args(self):
 
     @property
     def reference_args(self):
+
         def get_reference_field(r, kv):
             field = kv[1]
             mongo_field = getattr(self.model, kv[0], None)
@@ -111,7 +115,7 @@ def get_reference_field(r, kv):
                 _type = field.get_type()
                 if _type:
                     node = _type._type._meta
-                    if 'id' in node.fields and not issubclass(node.model, mongoengine.EmbeddedDocument):
+                    if 'id' in node.fields and not issubclass(node.model, (mongoengine.EmbeddedDocument,)):
                         r.update({kv[0]: node.fields['id']._type.of_type()})
             return r
 

graphene_mongo/tests/fixtures/image.jpg

@@ -1,7 +1,10 @@
 import mongoengine
 from datetime import datetime
+from mongomock import gridfs
 
+gridfs.enable_gridfs_integration()
 mongoengine.connect('graphene-mongo-test', host='mongomock://localhost', alias='default')
+# mongoengine.connect('graphene-mongo-test', host='mongodb://192.168.15.91/graphene-mongo-dev')
 
 
 class Publisher(mongoengine.Document):
@@ -28,6 +31,7 @@ class Editor(mongoengine.Document):
     last_name = mongoengine.StringField(required=True, help_text="Editor's last name.")
     metadata = mongoengine.MapField(field=mongoengine.StringField(), help_text="Arbitrary metadata.")
     company = mongoengine.LazyReferenceField(Publisher)
+    avatar = mongoengine.FileField()
 
 
 class Article(mongoengine.Document):

graphene_mongo/tests/models.py

@@ -1,3 +1,4 @@
+import os
 import pytest
 
 from datetime import datetime
@@ -8,6 +9,13 @@
     ParentWithRelationship, CellTower,
     Publisher)
 
+current_dirname = os.path.dirname(os.path.abspath(__file__))
+
+
+@pytest.fixture()
+def fixtures_dirname():
+    return os.path.join(current_dirname, 'fixtures')
+
 
 @pytest.fixture(scope='module')
 def fixtures():
@@ -23,7 +31,12 @@ def fixtures():
         metadata={'age': '20', 'nickname': '$1'},
         company=publisher1
     )
+    image_filename = os.path.join(
+        current_dirname, 'fixtures', 'image.jpg')
+    with open(image_filename, 'rb') as f:
+        editor1.avatar.put(f, content_type='image/jpeg')
     editor1.save()
+
     editor2 = Editor(
         id='2',
         first_name='Grant',

graphene_mongo/tests/setup.py

@@ -6,6 +6,7 @@
     Article, Editor, EmbeddedArticle, Player, Reporter,
     ProfessorMetadata, ProfessorVector, Publisher)
 from .. import registry
+from .. import advanced_types
 from ..converter import convert_mongoengine_field
 from ..fields import MongoengineConnectionField
 from ..types import MongoengineObjectType
@@ -80,24 +81,33 @@ def test_should_map_convert_json():
 def test_should_point_convert_field():
     graphene_type = convert_mongoengine_field(mongoengine.PointField())
     assert isinstance(graphene_type, graphene.Field)
+    assert graphene_type.type == advanced_types.PointFieldType
     assert isinstance(graphene_type.type.type, graphene.String)
     assert isinstance(graphene_type.type.coordinates, graphene.List)
 
 
 def test_should_polygon_covert_field():
     graphene_type = convert_mongoengine_field(mongoengine.PolygonField())
     assert isinstance(graphene_type, graphene.Field)
+    assert graphene_type.type == advanced_types.PolygonFieldType
     assert isinstance(graphene_type.type.type, graphene.String)
     assert isinstance(graphene_type.type.coordinates, graphene.List)
 
 
 def test_should_multipolygon_convert_field():
     graphene_type = convert_mongoengine_field(mongoengine.MultiPolygonField())
     assert isinstance(graphene_type, graphene.Field)
+    assert graphene_type.type == advanced_types.MultiPolygonFieldType
     assert isinstance(graphene_type.type.type, graphene.String)
     assert isinstance(graphene_type.type.coordinates, graphene.List)
 
 
+def test_should_file_convert_field():
+    graphene_type = convert_mongoengine_field(mongoengine.FileField())
+    assert isinstance(graphene_type, graphene.Field)
+    assert graphene_type.type == advanced_types.FileFieldType
+
+
 def test_should_field_convert_list():
     assert_conversion(mongoengine.ListField, graphene.List, field=mongoengine.StringField())
 
@@ -297,8 +307,6 @@ class Meta:
 
 
 def test_should_generic_reference_convert_union():
-    pass
-    """
     class A(MongoengineObjectType):
 
         class Meta:
@@ -318,4 +326,3 @@ class Meta:
         Reporter._fields['generic_reference'], registry.get_global_registry())
     assert isinstance(generic_reference_field, graphene.Field)
     assert isinstance(generic_reference_field.type(), graphene.Union)
-    """

graphene_mongo/tests/test_converter.py

@@ -6,22 +6,29 @@
 def test_article_field_args():
     field = MongoengineConnectionField(nodes.ArticleNode)
 
-    field_args = ['id', 'headline', 'pub_date']
-    assert set(field.field_args.keys()) == set(field_args)
+    field_args = {'id', 'headline', 'pub_date'}
+    assert set(field.field_args.keys()) == field_args
 
-    reference_args = ['editor', 'reporter']
-    assert set(field.reference_args.keys()) == set(reference_args)
+    reference_args = {'editor', 'reporter'}
+    assert set(field.reference_args.keys()) == reference_args
 
-    default_args = ['after', 'last', 'first', 'before']
-    args = field_args + reference_args + default_args
-    assert set(field.args) == set(args)
+    default_args = {'after', 'last', 'first', 'before'}
+    args = field_args | reference_args | default_args
+    assert set(field.args) == args
 
 
 def test_reporter_field_args():
     field = MongoengineConnectionField(nodes.ReporterNode)
 
-    field_args = ['id', 'first_name', 'last_name', 'email', 'awards']
-    assert set(field.field_args.keys()) == set(field_args)
+    field_args = {'id', 'first_name', 'last_name', 'email', 'awards'}
+    assert set(field.field_args.keys()) == field_args
+
+
+def test_editor_field_args():
+    field = MongoengineConnectionField(nodes.EditorNode)
+
+    field_args = {'id', 'first_name', 'last_name', 'metadata'}
+    assert set(field.field_args.keys()) == field_args
 
 
 def test_field_args_with_property():