Merge pull request #141 from TTWShell/bugfix/response

fixed response inheritance: status is property and use with setter

Author: TTWShell

hobbit_core/response.py

@@ -2,8 +2,7 @@
 from mypy_extensions import TypedDict
 
 from flask.json import dumps
-from flask import current_app
-from werkzeug import Response
+from flask import current_app, Response
 
 RESP_MSGS = {
     200: 'ok',
@@ -67,58 +66,59 @@ def gen_response(code: int, message: str = None, detail: Optional[str] = None,
 class Result(Response):
     """Base json response.
     """
-    status = 200  # type: ignore
+    _hobbit_status = 200  # type: ignore
 
     def __init__(self, response=None, status=None, headers=None,
                  mimetype='application/json', content_type=None,
                  direct_passthrough=False):
         assert sorted(response.keys()) == [
             'code', 'data', 'detail', 'message'], \
             'Error response, must include keys: code, data, detail, message'
-        super(Result, self).__init__(
+        super().__init__(
             response=dumps(response, indent=0, separators=(',', ':')) + '\n',
-            status=status if status is not None else self.status,
+            status=status if status is not None else self._hobbit_status,
             headers=headers, mimetype=mimetype,
             content_type=content_type, direct_passthrough=direct_passthrough)
 
 
 class SuccessResult(Result):
     """Success response. Default status is 200, you can cover it by status arg.
     """
-    status = 200
+    _hobbit_status = 200
 
     def __init__(self, message: str = '', code: Optional[int] = None,
                  detail: Any = None, status: Optional[int] = None, data=None):
-        super(SuccessResult, self).__init__(
-            gen_response(code if code is not None else self.status,
+        super().__init__(
+            gen_response(code if code is not None else self._hobbit_status,
                          message, detail, data),
-            status or self.status)
+            status or self._hobbit_status)
 
 
 class FailedResult(Result):
     """Failed response. status always 400.
     """
-    status = 400
+    _hobbit_status = 400
 
     def __init__(self, message: str = '', code: Optional[int] = None,
                  detail: Any = None):
-        super(FailedResult, self).__init__(
+        super().__init__(
             gen_response(
-                code if code is not None else self.status, message, detail),
-            self.status)
+                code if code is not None else self._hobbit_status,
+                message, detail),
+            self._hobbit_status)
 
 
 class UnauthorizedResult(FailedResult):
-    status = 401
+    _hobbit_status = 401
 
 
 class ForbiddenResult(FailedResult):
-    status = 403
+    _hobbit_status = 403
 
 
 class ValidationErrorResult(FailedResult):
-    status = 422
+    _hobbit_status = 422
 
 
 class ServerErrorResult(FailedResult):
-    status = 500
+    _hobbit_status = 500

setup.py

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

tests/test_err_handler.py

@@ -12,30 +12,30 @@ class TestErrHandler(BaseTest):
 
     def test_assertion_error(self, app):
         resp = ErrHandler.handler(AssertionError('message'))
-        assert resp.status == 422
+        assert resp.status_code == 422
         data = json.loads(resp.get_data())
         assert data['message'] == 'message'
 
     def test_sqlalchemy_orm_exc(self, app):
         resp = ErrHandler.handler(orm_exc.NoResultFound())
-        assert resp.status == 404, resp.get_json()
+        assert resp.status_code == 404, resp.get_json()
         data = json.loads(resp.get_data())
         assert data['message'] == u'源数据未找到'
 
         resp = ErrHandler.handler(orm_exc.UnmappedError())
-        assert resp.status == 500
+        assert resp.status_code == 500
         data = json.loads(resp.get_data())
         assert data['message'] == u'服务器内部错误'
 
     def test_werkzeug_exceptions(self, app):
         resp = ErrHandler.handler(wkz_exc.Unauthorized())
-        assert resp.status == 401
+        assert resp.status_code == 401
         data = json.loads(resp.get_data())
         assert data['message'] == u'未登录'
 
     def test_hobbit_exception(self, app):
         resp = ErrHandler.handler(HobbitException('msg'))
-        assert resp.status == 400
+        assert resp.status_code == 400
         data = json.loads(resp.get_data())
         assert data['message'] == 'msg'
         # py27,py36 == "Exception('msg',)"
@@ -44,7 +44,7 @@ def test_hobbit_exception(self, app):
 
     def test_others(self, app):
         resp = ErrHandler.handler(Exception('msg'))
-        assert resp.status == 500
+        assert resp.status_code == 500
         data = json.loads(resp.get_data())
         assert data['message'] == u'服务器内部错误'
         # py27,py36 == "Exception('msg',)"

tests/test_response.py

@@ -30,21 +30,21 @@ def test_result(self):
             'code': '1', 'message': u'unknown', 'detail': None, 'data': None}
         result = Result(response)
         print(result.__dict__)
-        assert result.status == 200
+        assert result.status_code == 200
 
         result = Result(response, status=201)
-        assert result.status == 201
+        assert result.status_code == 201
 
     def test_success_result(self, app):
         # assert status can rewrite
         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 == 301
+        assert result.status_code == 301
         assert excepted == result.data
 
         # assert default is 200
         result = SuccessResult()
-        assert result.status == 200
+        assert result.status_code == 200
 
         app.config['HOBBIT_USE_CODE_ORIGIN_TYPE'] = True
         result = SuccessResult(code=0)
@@ -61,7 +61,7 @@ def test_success_result(self, app):
 
     def test_failed_result(self):
         result = FailedResult()
-        assert result.status == 400
+        assert result.status_code == 400
 
     @pytest.mark.parametrize('result, excepted_status', [
         (UnauthorizedResult, 401),
@@ -70,4 +70,4 @@ def test_failed_result(self):
         (ServerErrorResult, 500),
     ])
     def test_results(self, result, excepted_status):
-        assert result().status == excepted_status
+        assert result().status_code == excepted_status