Merge pull request #118 from TTWShell/enhance/support-respone-msg-conf

support conf HOBBIT_RESPONSE_MESSAGE_MAPS

Author: TTWShell

.gitignore

@@ -20,3 +20,5 @@ build/*
 
 tests/tst_app.sqlite
 models.csv
+
+.coverage*

docs/changelog.rst

@@ -1,6 +1,11 @@
 Change history
 ==============
 
+2.0.4 (2021-07-13)
+******************
+
+* Support set `HOBBIT_RESPONSE_MESSAGE_MAPS` to use self-defined response message.
+
 2.0.3 (2021-07-08)
 ******************
 

docs/index.rst

@@ -192,6 +192,23 @@ tests
 所有的测试case. 推荐使用 `pytest <https://docs.pytest.org/en/latest/>`_ 测试，项目也会自动生成基本的pytest配置。
 
 
+配置
+====
+
+.. list-table:: Configuration
+  :widths: 25 25 50
+  :header-rows: 1
+
+  * - Key
+    - Value
+    - Description
+  * - HOBBIT_USE_CODE_ORIGIN_TYPE
+    - `True` or `False`
+    - Return origin type of code in response. Default is `False`.
+  * - HOBBIT_RESPONSE_MESSAGE_MAPS
+    -  `dict`, `{code: message}`
+    - Self-defined response message. Set to `{200: "success"}` will return `{"code": 200, "message": "success"}` in response.
+
 Others
 ======
 

hobbit_core/response.py

@@ -7,6 +7,7 @@
 
 RESP_MSGS = {
     200: 'ok',
+
     400: 'failed',
     401: '未登录',
     403: '未授权',
@@ -23,7 +24,7 @@ class RespType(TypedDict):
     detail: Any
 
 
-def gen_response(code: int, message: str = '', detail: Optional[str] = None,
+def gen_response(code: int, message: str = None, detail: Optional[str] = None,
                  data=None) -> RespType:
     """Func for generate response body.
 
@@ -40,12 +41,24 @@ def gen_response(code: int, message: str = '', detail: Optional[str] = None,
     2021-07-08 Updated:
         Default type of `code` in response is force conversion to `str`, now
         support set `HOBBIT_USE_CODE_ORIGIN_TYPE = True` to return origin type.
+
+    2021-07-13 Updated:
+        Support set `HOBBIT_RESPONSE_MESSAGE_MAPS` to use self-defined
+        response message. `HOBBIT_RESPONSE_MESSAGE_MAPS` must be dict.
     """
     use_origin_type = current_app.config.get(
         'HOBBIT_USE_CODE_ORIGIN_TYPE', False)
+
+    resp_msgs = current_app.config.get('HOBBIT_RESPONSE_MESSAGE_MAPS', {})
+    assert isinstance(resp_msgs, dict), \
+        'HOBBIT_RESPONSE_MESSAGE_MAPS must be dict type.'
+    if not message:
+        message = resp_msgs.get(code)
+        if message is None:
+            message = RESP_MSGS.get(code, 'unknown')
     return {
         'code': str(code) if use_origin_type is False else code,
-        'message': message or RESP_MSGS.get(code, '未知错误'),  # type: ignore
+        'message': message,  # type: ignore
         'data': data,
         'detail': detail,
     }

setup.py

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

tests/test_err_handler.py

@@ -10,13 +10,13 @@
 
 class TestErrHandler(BaseTest):
 
-    def test_assertion_error(self):
+    def test_assertion_error(self, app):
         resp = ErrHandler.handler(AssertionError('message'))
         assert resp.status_code == 422
         data = json.loads(resp.get_data())
         assert data['message'] == 'message'
 
-    def test_sqlalchemy_orm_exc(self):
+    def test_sqlalchemy_orm_exc(self, app):
         resp = ErrHandler.handler(orm_exc.NoResultFound())
         assert resp.status_code == 404
         data = json.loads(resp.get_data())
@@ -27,13 +27,13 @@ def test_sqlalchemy_orm_exc(self):
         data = json.loads(resp.get_data())
         assert data['message'] == u'服务器内部错误'
 
-    def test_werkzeug_exceptions(self):
+    def test_werkzeug_exceptions(self, app):
         resp = ErrHandler.handler(wkz_exc.Unauthorized())
         assert resp.status_code == 401
         data = json.loads(resp.get_data())
         assert data['message'] == u'未登录'
 
-    def test_others(self):
+    def test_others(self, app):
         resp = ErrHandler.handler(Exception('msg'))
         assert resp.status_code == 500
         data = json.loads(resp.get_data())

tests/test_response.py

@@ -12,7 +12,7 @@ class TestResponse(BaseTest):
 
     @pytest.mark.parametrize('input_, excepted', [
         ((1, ), {
-            'code': '1', 'message': '未知错误', 'detail': None, 'data': None}),
+            'code': '1', 'message': 'unknown', 'detail': None, 'data': None}),
         ((1, '测试', ['1'], {}), {
             'code': '1', 'message': '测试', 'detail': ['1'], 'data': {}}),
         ((1, '测试', ['1'], []), {
@@ -27,7 +27,7 @@ def test_result(self):
             Result({})
 
         response = {
-            'code': '1', 'message': u'未知错误', 'detail': None, 'data': None}
+            'code': '1', 'message': u'unknown', 'detail': None, 'data': None}
         result = Result(response)
         assert result.status_code == 200
 
@@ -53,6 +53,11 @@ def test_success_result(self, app):
         result = SuccessResult(code=0)
         assert b'"code":"0"' in result.data
 
+        app.config['HOBBIT_RESPONSE_MESSAGE_MAPS'] = {100: 'testmsg'}
+        result = SuccessResult(code=100)
+        assert b'"message":"testmsg"' in result.data
+        app.config['HOBBIT_RESPONSE_MESSAGE_MAPS'] = {}
+
     def test_failed_result(self):
         result = FailedResult()
         assert result.status_code == 400