move FileData to spyne.model.relational

plq · plq · commit 37297fc9fc8c · 2020-07-07T10:25:45.000+03:00
also make its "hidden" fields (those that don't get written
to the database) explicit

fix its serialization to bytes
diff --git a/spyne/model/relational.py b/spyne/model/relational.py
@@ -0,0 +1,46 @@
+
+#
+# spyne - Copyright (C) Spyne contributors.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+#
+
+from spyne.model.complex import ComplexModel
+from spyne.model.primitive import Unicode
+
+
+class FileData(ComplexModel):
+    _type_info = [
+        ('name', Unicode),
+        ('type', Unicode),
+        ('path', Unicode),
+    ]
+
+    @property
+    def data(self):
+        return self._data
+
+    @data.setter
+    def data(self, data):
+        self._data = data
+
+    @property
+    def handle(self):
+        return self._handle
+
+    @handle.setter
+    def handle(self, handle):
+        self._handle = handle
+
diff --git a/spyne/protocol/_outbase.py b/spyne/protocol/_outbase.py
@@ -45,6 +45,8 @@
     ByteArray, File, ComplexModelBase, AnyXml, AnyHtml, Unicode, Decimal, \
     Double, Integer, Time, DateTime, Uuid, Duration, Boolean, AnyDict, \
     AnyUri, PushBase, Date
+from spyne.model.relational import FileData
+
 from spyne.const.http import HTTP_400, HTTP_401, HTTP_404, HTTP_405, HTTP_413, \
     HTTP_500
 from spyne.error import Fault, InternalError, ResourceNotFoundError, \
@@ -547,8 +549,13 @@ def file_to_bytes(self, cls, value, suggested_encoding=None):
 
             assert False, "Unhandled file type"
 
-        if value is None:
-            return b''
+        if isinstance(value, FileData):
+            try:
+                return binary_encoding_handlers[encoding](value.data)
+            except Exception as e:
+                logger.error("Error encoding value to binary. Error: %r, Value: %r",
+                                                                           e, value)
+                raise
 
         try:
             return binary_encoding_handlers[encoding](value)
diff --git a/spyne/store/relational/document.py b/spyne/store/relational/document.py
@@ -48,21 +48,14 @@ def get_xml_as_object(*_, **__):
 
 from sqlalchemy.sql.type_api import UserDefinedType
 
-from spyne import ComplexModel, ValidationError, Unicode
+from spyne import ValidationError
+from spyne.model.relational import FileData
 
 from spyne.util import six
 from spyne.util.six import binary_type, text_type, BytesIO, StringIO
 from spyne.util.fileproxy import SeekableFileProxy
 
 
-class FileData(ComplexModel):
-    _type_info = [
-        ('name', Unicode),
-        ('type', Unicode),
-        ('path', Unicode),
-    ]
-
-
 class PGXml(UserDefinedType):
     def __init__(self, pretty_print=False, xml_declaration=False,
                                                               encoding='UTF-8'):
@@ -311,12 +304,11 @@ def process(value):
                 value.store = self.store
                 value.abspath = join(self.store, value.path)
 
-                retval = self.get_object_as_json(value, self.cls,
-                        ignore_wrappers=self.ignore_wrappers,
-                        complex_as=self.complex_as,
-                    )
+                return self.get_object_as_json(value, self.cls,
+                    ignore_wrappers=self.ignore_wrappers,
+                    complex_as=self.complex_as,
+                )
 
-                return retval
         return process
 
     def result_processor(self, dialect, col_type):
