Merge branch 'master' into fix-integer-index

Author: arajkumar

doc/index.rst

@@ -4,19 +4,36 @@
    contain the root `toctree` directive.
 
 Welcome to Flask-RESTX's documentation!
-==========================================
+=======================================
 
 Flask-RESTX is an extension for Flask that adds support for quickly building REST APIs.
 Flask-RESTX encourages best practices with minimal setup.
 If you are familiar with Flask, Flask-RESTX should be easy to pick up.
 It provides a coherent collection of decorators and tools to describe your API
 and expose its documentation properly (using Swagger).
 
+Flask-RESTX is a community driven fork of `Flask-RESTPlus
+<https://github.com/noirbizarre/flask-restplus>`_
+
+
+Why did we fork?
+================
+
+The community has decided to fork the project due to lack of response from the
+original author @noirbizarre. We have been discussing this eventuality for
+`a long time <https://github.com/noirbizarre/flask-restplus/issues/593>`_.
+
+Things evolved a bit since that discussion and a few of us have been granted
+maintainers access to the github project, but only the original author has
+access rights on the PyPi project. As such, we been unable to make any actual
+releases. To prevent this project from dying out, we have forked it to continue
+development and to support our users.
+
 
 Compatibility
 =============
 
-flask-restx requires Python 2.7+.
+flask-restx requires Python 2.7+ or 3.4+.
 
 
 Installation

doc/quickstart.rst

@@ -10,6 +10,29 @@ and that you have already installed both Flask and Flask-RESTX.
 If not, then follow the steps in the :ref:`installation` section.
 
 
+Migrate from Flask-RESTPlus
+---------------------------
+
+.. warning:: The *migration* commands provided below are for illustration
+             purposes.
+             You may need to adapt them to properly fit your needs.
+             We also recommend you make a backup of your project prior running them.
+
+At this point, Flask-RESTX remains 100% compatible with Flask-RESTPlus' API.
+All you need to do is update your requirements to use Flask-RESTX instead of
+Flask-RESTPlus. Then you need to update all your imports.
+This can be done using something like:
+
+::
+   find . -type f -name "*.py" | xargs sed -i "s/flask_restplus/flask_restx/g"
+
+Finally, you will need to update your configuration options (described `here
+<quickstart.html#configuration>`_). Example:
+
+::
+   find . -type f -name "*.py" | xargs sed -i "s/RESTPLUS_/RESTX_/g"
+
+
 Initialization
 --------------
 

doc/swagger.rst

@@ -536,14 +536,13 @@ For ``POST`` and ``PUT`` methods, use the ``body`` keyword argument to specify t
 
 .. code-block:: python
 
-    fields = api.model('MyModel', {
+    my_model = api.model('MyModel', {
         'name': fields.String(description='The name', required=True),
         'type': fields.String(description='The object type', enum=['A', 'B']),
         'age': fields.Integer(min=0),
     })
 
 
-    @api.model(fields={'name': fields.String, 'age': fields.Integer})
     class Person(fields.Raw):
         def format(self, value):
             return {'name': value.name, 'age': value.age}
@@ -552,11 +551,11 @@ For ``POST`` and ``PUT`` methods, use the ``body`` keyword argument to specify t
     @api.route('/my-resource/<id>', endpoint='my-resource')
     @api.doc(params={'id': 'An ID'})
     class MyResource(Resource):
-        @api.doc(model=fields)
+        @api.doc(model=my_model)
         def get(self, id):
             return {}
 
-        @api.doc(model='MyModel', body=Person)
+        @api.doc(model=my_model, body=Person)
         def post(self, id):
             return {}
 

flask_restx/fields.py

@@ -468,7 +468,7 @@ def format(self, value):
             if value is None:
                 return self.default
             return int(value)
-        except ValueError as ve:
+        except (ValueError, TypeError) as ve:
             raise MarshallingError(ve)
 
 
@@ -482,7 +482,7 @@ class Float(NumberMixin, Raw):
     def format(self, value):
         try:
             return float(value)
-        except ValueError as ve:
+        except (ValueError, TypeError) as ve:
             raise MarshallingError(ve)
 
 

tests/test_fields.py

@@ -276,10 +276,14 @@ def test_with_default(self):
     def test_value(self, value, expected):
         self.assert_field(fields.Integer(), value, expected)
 
-    def test_decode_error(self):
+    def test_decode_error_on_invalid_value(self):
         field = fields.Integer()
         self.assert_field_raises(field, "an int")
 
+    def test_decode_error_on_invalid_type(self):
+        field = fields.Integer()
+        self.assert_field_raises(field, {"a": "dict"})
+
 
 class BooleanFieldTest(BaseFieldTestMixin, FieldTestCase):
     field_class = fields.Boolean
@@ -330,10 +334,14 @@ def test_value(self, value, expected):
     def test_raises(self):
         self.assert_field_raises(fields.Float(), "bar")
 
-    def test_decode_error(self):
+    def test_decode_error_on_invalid_value(self):
         field = fields.Float()
         self.assert_field_raises(field, "not a float")
 
+    def test_decode_error_on_invalid_type(self):
+        field = fields.Float()
+        self.assert_field_raises(field, {"a": "dict"})
+
 
 PI_STR = (
     "3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117"