fix marshmallow==2.x bug and optimize code.

Author: chenxl

README.md

@@ -18,6 +18,7 @@ $ pip install -U Flasgger-Marshmallow
 import logging
 
 from flasgger import Swagger
+# use basePath   from flasgger_marshmallow import Swagger
 from flask import Flask, request
 from flask_restful import Api, Resource
 from marshmallow import Schema, fields
@@ -104,7 +105,11 @@ class responseHeadersSchema(Schema):
     X_RateLimit_Limit = fields.Integer(
         required=True, default=1, doc='Request limit per hour',
         data_key='X-RateLimit-Limit'
-    )
+    )  # marshmallow 3
+    # X_RateLimit_Limit = fields.Integer(
+    #     required=True, default=1, doc='Request limit per hour',
+    #     load_from='X-RateLimit-Limit', dump_to='X-RateLimit-Limit'
+    # ) # marshmallow 2
 
     class Meta:
         strict = True
@@ -151,7 +156,7 @@ class User(Resource):
 
         # 获取校验后的数据
         logger.info('%s, %s', type(request.query_schema), request.query_schema)
-        return {'user_name': '陈小龙'}
+        return {"count": 1, "page": 1, "users": [{'username': '陈小龙'}]}
 
     @swagger_decorator(query_schema=QueryUserSchema, response_schema={302: RedirectResponseSchema})
     def put(self):
@@ -192,7 +197,9 @@ class Username(Resource):
 
     @swagger_decorator(path_schema=UsernamePathSchema,
                        form_schema=UpdateUserSchema,
-                       response_schema={200: UserDetailResponseSchema})
+                       response_schema={200: UserDetailResponseSchema},
+                       tags=["AAA"]
+                       )
     def put(self, username):
         """
         更新用户信息

example/flask_swagger.py

@@ -1,6 +1,7 @@
 import logging
 
 from flasgger import Swagger
+# use basePath   from flasgger_marshmallow import Swagger
 from flask import Flask, request
 from flask_restful import Api, Resource
 from marshmallow import Schema, fields
@@ -87,7 +88,11 @@ class responseHeadersSchema(Schema):
     X_RateLimit_Limit = fields.Integer(
         required=True, default=1, doc='Request limit per hour',
         data_key='X-RateLimit-Limit'
-    )
+    )  # marshmallow 3
+    # X_RateLimit_Limit = fields.Integer(
+    #     required=True, default=1, doc='Request limit per hour',
+    #     load_from='X-RateLimit-Limit', dump_to='X-RateLimit-Limit'
+    # ) # marshmallow 2
 
     class Meta:
         strict = True
@@ -134,7 +139,7 @@ def get(self):
 
         # 获取校验后的数据
         logger.info('%s, %s', type(request.query_schema), request.query_schema)
-        return {'user_name': '陈小龙'}
+        return {"count": 1, "page": 1, "users": [{'username': '陈小龙'}]}
 
     @swagger_decorator(query_schema=QueryUserSchema, response_schema={302: RedirectResponseSchema})
     def put(self):

flasgger_marshmallow/__init__.py

@@ -7,7 +7,12 @@
 import yaml
 from flasgger.base import Swagger as FSwagger
 from flasgger.constants import OPTIONAL_FIELDS
-from flasgger.constants import OPTIONAL_OAS3_FIELDS
+try:
+    from flasgger.constants import OPTIONAL_OAS3_FIELDS
+except :
+    OPTIONAL_OAS3_FIELDS = [
+        'components', 'servers'
+    ]
 from flasgger.utils import extract_definitions
 from flasgger.utils import get_specs
 from flasgger.utils import get_vendor_extension_fields
@@ -44,14 +49,27 @@
     fields.Int: 'number',
 }
 
-if int(marshmallow.__version__.split('.')[1]) == 3:
+if int(marshmallow.__version__.split('.')[0]) == 3:
     FIELDS_JSON_TYPE_MAP.update({
         fields.NaiveDateTime: 'string',
         fields.AwareDateTime: 'string',
         fields.Tuple: 'array',
     })
 
 
+def is_marsh_v3():
+    return int(marshmallow.__version__.split('.')[0]) == 3
+
+
+def data_schema(schema, data):
+    data = schema().load(data or {})
+    if not is_marsh_v3():
+        data = schema().dump(data.data).data
+    else:
+        data = schema().dump(data)
+    return data
+
+
 class Swagger(FSwagger):
 
     def get_apispecs(self, endpoint='apispec_1'):
@@ -323,9 +341,13 @@ def parse_simple_schema(c_schema, location):
                 values_real_types.sort(key=value.__class__.__mro__.index)
                 if not values_real_types:
                     raise '不支持的%s类型' % str(type(value))
+                if is_marsh_v3():
+                    name = getattr(value, 'data_key', None) or key
+                else:
+                    name = getattr(value, 'load_from', None) or key
                 tmp = {
                     'in': location,
-                    'name': getattr(value, 'data_key', None) or key,
+                    'name': name,
                     'type': FIELDS_JSON_TYPE_MAP.get(values_real_types[0]),
                     'required': value.required if location != 'path' else True,
                     'description': value.metadata.get('doc', '')
@@ -339,7 +361,10 @@ def parse_json_schema(r_s):
             tmp = {}
             for key, value in (
                     r_s.__dict__.get('_declared_fields') or r_s.__dict__.get('declared_fields') or {}).items():
-                key = getattr(value, 'data_key', None) or key
+                if is_marsh_v3():
+                    key = getattr(value, 'data_key', None) or key
+                else:
+                    key = getattr(value, 'load_from', None) or key
                 if isinstance(value, fields.Nested):
                     if value.many:
                         tmp[key] = {
@@ -453,19 +478,11 @@ def wrapper(*args, **kw):
             request.path_schema, request.path_schema, request.form_schema = [None] * 3
             request.json_schema, request.headers_schema = [None] * 2
             try:
-                if __version__.startswith('3.'):
-                    path_schema and setattr(request, 'path_schema', path_schema().load(path_params or {}))
-                    query_schema and setattr(request, 'query_schema', query_schema().load(query_params or {}))
-                    form_schema and setattr(request, 'form_schema', form_schema().load(form_params or {}))
-                    json_schema and setattr(request, 'json_schema', json_schema().load(json_params or {}))
-                    headers_schema and setattr(request, 'headers_schema', headers_schema().load(dict(header_params)))
-                else:
-                    path_schema and setattr(request, 'path_schema', path_schema().load(path_params or {}).data)
-                    query_schema and setattr(request, 'query_schema', query_schema().load(query_params or {}).data)
-                    form_schema and setattr(request, 'form_schema', form_schema().load(form_params or {}).data)
-                    json_schema and setattr(request, 'json_schema', json_schema().load(json_params or {}).data)
-                    headers_schema and setattr(request, 'headers_schema',
-                                               headers_schema().load(dict(header_params)).data)
+                path_schema and setattr(request, 'path_schema', data_schema(path_schema, path_params))
+                query_schema and setattr(request, 'query_schema', data_schema(query_schema, query_params))
+                form_schema and setattr(request, 'form_schema', data_schema(form_schema, form_params))
+                json_schema and setattr(request, 'json_schema', data_schema(json_schema, json_params))
+                headers_schema and setattr(request, 'headers_schema', data_schema(headers_schema, dict(header_params)))
             except Exception as e:
                 return 'request error: %s' % ''.join(
                     [('%s: %s; ' % (x, ''.join(y))) for x, y in e.messages.items()]), 400
@@ -474,12 +491,10 @@ def wrapper(*args, **kw):
             logger.info('response data\ndata: %s\ncode: %s\nheaders: %s\n', data, code, headers)
             try:
                 if response_schema and response_schema.get(code):
-                    data = response_schema.get(code)().load(data or {})
-                    if not __version__.startswith('3.'):
-                        data = data.data
+                    data = data_schema(response_schema.get(code), data)
                     r_headers_schema = getattr(response_schema.get(code).Meta, 'headers', None)
                     if r_headers_schema:
-                        headers = r_headers_schema().load(headers or {})
+                        headers = data_schema(r_headers_schema, headers)
             except Exception as e:
                 return 'response error: %s' % ''.join(
                     [('%s: %s; ' % (x, ''.join(y))) for x, y in e.messages.items()]), 400

setup.py

@@ -27,11 +27,11 @@
 
 URL = 'https://github.com/flask-rabmq/Flasgger-Marshmallow'
 
-VERSION = "0.0.7"
+VERSION = "0.0.8"
 
 LICENSE = "MIT"
 
-INSTALL_REQUIRES = ["flask>=1.0.0", "flasgger>=0.9.5", "marshmallow>=2.18.1", "PyYAML"]
+INSTALL_REQUIRES = ["flask>=1.0.0, <2.0.0", "Jinja2>=2.10.1, <3.0", "flasgger>=0.9.3", "marshmallow>=2.18.1", "PyYAML"]
 
 setup(
     name=NAME,