Merge pull request #113 from TTWShell/feature/response

response: Result: add data field & fix tpl test.teardown_method err

Author: TTWShell

docs/changelog.rst

@@ -1,6 +1,12 @@
 Change history
 ==============
 
+2.0.1 (2021-06-21)
+******************
+
+* Add data field for response.Result: return Real response payload.
+* Bugfix: tests.BaseTest.teardown_method miss `app.app_context()`.
+
 2.0.0 (2021-06-20)
 ******************
 

hobbit/static/bootstrap/rivendell/tests/__init__.py.jinja2

@@ -24,8 +24,9 @@ class BaseTest:
         pass
 
     def teardown_method(self, method):
-        for m in [m for m in db.Model._decl_class_registry.values()
-                  if isinstance(m, model.DefaultMeta)]:
-            db.session.query(m).delete()
-            db.session.commit()
+        with app.app_context():
+            for m in [m for m in db.Model._decl_class_registry.values()
+                      if isinstance(m, model.DefaultMeta)]:
+                db.session.query(m).delete()
+                db.session.commit()
 

hobbit/static/bootstrap/shire/tests/__init__.py.jinja2

@@ -24,8 +24,9 @@ class BaseTest:
         pass
 
     def teardown_method(self, method):
-        for m in [m for m in db.Model._decl_class_registry.values()
-                  if isinstance(m, model.DefaultMeta)]:
-            db.session.query(m).delete()
-        db.session.commit()
+        with app.app_context():
+            for m in [m for m in db.Model._decl_class_registry.values()
+                      if isinstance(m, model.DefaultMeta)]:
+                db.session.query(m).delete()
+            db.session.commit()
 

hobbit_core/response.py

@@ -20,14 +20,15 @@ class RespType(TypedDict):
     detail: Any
 
 
-def gen_response(code: int, message: str = '', detail: Optional[str] = None) \
-        -> RespType:
+def gen_response(code: int, message: str = '', detail: Optional[str] = None,
+                 data=None) -> RespType:
     """Func for generate response body.
 
     Args:
         code (string, int): Extension to interact with web pages. Default is \
             http response ``status_code`` like 200、404.
         message (string): For popup windows.
+        data (object): Real response payload.
         detail (object): For debug, detail server error msg.
 
     Returns:
@@ -37,6 +38,7 @@ def gen_response(code: int, message: str = '', detail: Optional[str] = None) \
     return {
         'code': str(code),
         'message': message or RESP_MSGS.get(code, '未知错误'),  # type: ignore
+        'data': data,
         'detail': detail,
     }
 
@@ -49,8 +51,9 @@ class Result(Response):
     def __init__(self, response=None, status=None, headers=None,
                  mimetype='application/json', content_type=None,
                  direct_passthrough=False):
-        assert sorted(response.keys()) == ['code', 'detail', 'message'], \
-            'Error response, must include keys: code, detail, message'
+        assert sorted(response.keys()) == [
+            'code', 'data', 'detail', 'message'], \
+            'Error response, must include keys: code, data, detail, message'
         super(Result, self).__init__(
             response=dumps(response, indent=0, separators=(',', ':')) + '\n',
             status=status or self.status, headers=headers, mimetype=mimetype,
@@ -63,9 +66,9 @@ class SuccessResult(Result):
     status = 200
 
     def __init__(self, message: str = '', code: Optional[int] = None,
-                 detail: Any = None, status: Optional[int] = None):
+                 detail: Any = None, status: Optional[int] = None, data=None):
         super(SuccessResult, self).__init__(
-            gen_response(code or self.status, message, detail),
+            gen_response(code or self.status, message, detail, data),
             status or self.status)
 
 

setup.py

@@ -32,7 +32,7 @@ def gen_data(data_root='static'):
 
 setup(
     name='hobbit-core',
-    version='2.0.0',
+    version='2.0.1',
     python_requires='>=3.6, <4',
     description='Hobbit - A flask project generator.',
     long_description=long_description,

tests/test_response.py

@@ -11,18 +11,23 @@
 class TestResponse(BaseTest):
 
     @pytest.mark.parametrize('input_, excepted', [
-        ((1, ), {'code': '1', 'message': '未知错误', 'detail': None}),
-        ((1, '测试', ['1']), {'code': '1', 'message': '测试', 'detail': ['1']})
+        ((1, ), {
+            'code': '1', 'message': '未知错误', 'detail': None, 'data': None}),
+        ((1, '测试', ['1'], {}), {
+            'code': '1', 'message': '测试', 'detail': ['1'], 'data': {}}),
+        ((1, '测试', ['1'], []), {
+            'code': '1', 'message': '测试', 'detail': ['1'], 'data': []}),
     ])
     def test_gen_response(self, input_, excepted):
         assert excepted == gen_response(*input_)
 
     def test_result(self):
-        msg = 'Error response, must include keys: code, detail, message'
+        msg = 'Error response, must include keys: code, data, detail, message'
         with pytest.raises(AssertionError, match=msg):
             Result({})
 
-        response = {'code': '1', 'message': u'未知错误', 'detail': None}
+        response = {
+            'code': '1', 'message': u'未知错误', 'detail': None, 'data': None}
         result = Result(response)
         assert result.status_code == 200
 
@@ -31,7 +36,7 @@ def test_result(self):
 
     def test_success_result(self):
         # assert status can rewrite
-        excepted = b'{\n"code":"200",\n"detail":null,\n"message":"message"\n}\n'  # NOQA
+        excepted = b'{\n"code":"200",\n"data":null,\n"detail":null,\n"message":"message"\n}\n'  # NOQA
         result = SuccessResult('message', status=301)
         assert result.status_code == 301
         assert excepted == result.data