Document passing file arguments

Author: alvarolopez

deepaas/model/v2/wrapper.py

@@ -35,10 +35,23 @@
 CONF = cfg.CONF
 
 
-UploadedField = collections.namedtuple("UploadedField", ("name",
-                                                         "filename",
-                                                         "file",
-                                                         "content_type"))
+UploadedFile = collections.namedtuple("UploadedFile", ("name",
+                                                       "filename",
+                                                       "content_type"))
+"""Class to hold uploaded field metadata when passed to model's methods
+
+.. py:attribute:: name
+
+   Name of the argument where this file is being sent.
+
+.. py:attribute:: filename
+
+   Complete file path to the temporary file in the filesyste,
+
+.. py:attribute:: content_type
+
+   Content-type of the uploaded file.
+"""
 
 
 class ModelWrapper(object):
@@ -249,15 +262,14 @@ def predict(self, *args, **kwargs):
             error, already wrapped as a HTTPException
         """
         for key, val in kwargs.items():
-            if isinstance(val, web.FileField):
+            if isinstance(val, web.FileFile):
                 fd, name = tempfile.mkstemp()
                 fd = os.fdopen(fd, "w+b")
                 fd.write(val.file.read())
                 fd.close()
-                aux = UploadedField(
+                aux = UploadedFile(
                     name=val.name,
-                    filename=val.filename,
-                    file=name,
+                    filename=name,
                     content_type=val.content_type,
                 )
                 kwargs[key] = aux

doc/source/user/v2-api.rst

@@ -127,6 +127,12 @@ field created as follows::
   do not forget to add the ``location="form"`` and ``type="file"`` to the
   argument definition, otherwise it will not work as expected.
 
+Once defined, you will receive an object of the class described below for each
+of the file arguments you declare. You can open and read the file stored in the
+``filename`` attribute.
+
+.. autoclass:: deepaas.model.v2.wrapper.UploadedFile
+
 Then you should define the ``predict`` function as indicated below. You will
 receive all the arguments that have been parsed as keyword arguments: