support HOBBIT_RESPONSE_DETAIL config

Author: legolas.zhan

docs/index.rst

@@ -208,6 +208,9 @@ tests
   * - HOBBIT_RESPONSE_MESSAGE_MAPS
     -  `dict`, `{code: message}`
     - Self-defined response message. Set to `{200: "success"}` will return `{"code": 200, "message": "success"}` in response.
+  * - HOBBIT_RESPONSE_DETAIL
+    - `True` or `False`
+    - Default return detail and must set to `False` in production env. Default is `True`. Only used in 500 server error response.
 
 Others
 ======

hobbit_core/response.py

@@ -55,6 +55,11 @@ def gen_response(code: int, message: str = None, detail: Optional[str] = None,
         message = resp_msgs.get(code)
         if message is None:
             message = RESP_MSGS.get(code, 'unknown')
+
+    if current_app.config.get("HOBBIT_RESPONSE_DETAIL", True) is False \
+            and code == 500:
+        detail = None
+
     return {
         'code': str(code) if use_origin_type is False else code,
         'message': message,  # type: ignore

setup.py

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

tests/test_response.py

@@ -59,6 +59,17 @@ def test_success_result(self, app):
         assert b'"message":"testmsg"' in result.data
         app.config['HOBBIT_RESPONSE_MESSAGE_MAPS'] = {}
 
+    def test_500_result(self, app):
+        result = ServerErrorResult('message', detail='detail')
+        assert result.status_code == 500
+        excepted = b'{\n"code":"500",\n"data":null,\n"detail":"detail",\n"message":"message"\n}\n'  # NOQA
+        assert excepted == result.data
+
+        app.config['HOBBIT_RESPONSE_DETAIL'] = False
+        result = ServerErrorResult('message', detail='detail')
+        excepted = b'{\n"code":"500",\n"data":null,\n"detail":null,\n"message":"message"\n}\n'  # NOQA
+        assert excepted == result.data
+
     def test_failed_result(self):
         result = FailedResult()
         assert result.status_code == 400