Merge pull request #479 from weakish/engine-error

fix(engine): LeanEngineError status

Author: weakish

README.md

@@ -50,7 +50,13 @@ pip install -e .'[test]'
 Run tests:
 
 ```sh
-nosetests
+python -m nose
+```
+
+Run a single test:
+
+```sh
+python -m nose tests/test_engine.py:test_lean_engine_error
 ```
 
 ## Linter and Formatter

leancloud/__init__.py

@@ -29,7 +29,7 @@
 from .errors import LeanCloudWarning
 from .file_ import File
 from .geo_point import GeoPoint
-from .message import Message    # noqa: F401
+from .message import Message  # noqa: F401
 from .object_ import Object
 from .push import Installation
 from .query import FriendshipQuery

leancloud/engine/leanengine.py

@@ -30,12 +30,31 @@
 
 
 class LeanEngineError(Exception):
-    def __init__(self, code=400, message="error"):
-        if isinstance(code, six.string_types):
-            message = code
-            code = 400
-        self.code = code
-        self.message = message
+    def __init__(
+        self,
+        code=None,  # for backward compatibility, should be 400
+        message="error",  # for backward compatibility, should be required
+        status=None,  # for backward compatibility, should be 400
+    ):
+        if status is None:
+            if isinstance(code, six.string_types):
+                self.message = code
+                self.code = 400  # for backward compatibility, should be 1
+                self.status = 400
+            else:
+                self.message = message
+                # for backward compatibility, should be 1
+                self.code = 400 if code is None else code
+                self.status = self.code
+        else:
+            if isinstance(code, six.string_types):
+                self.message = code
+                self.code = 400
+                self.status = status
+            else:
+                self.status = status
+                self.code = 1 if code is None else code
+                self.message = message
 
 
 class LeanEngineApplication(object):
@@ -186,7 +205,7 @@ def dispatch_request(self, environ):
         except LeanEngineError as e:
             return Response(
                 json.dumps({"code": e.code, "error": e.message}),  # noqa: B306
-                status=e.code if e.code else 400,
+                status=e.status,
                 mimetype="application/json",
             )
         except Exception:

leancloud/query.py

@@ -30,6 +30,7 @@ class CQLResult(object):
 
         class_name: 查询的 class 名称
     """
+
     __slots__ = ["results", "count", "class_name"]
 
     def __init__(self, results, count, class_name):

leancloud/role.py

@@ -68,8 +68,10 @@ def validate(self, attrs):
                 raise TypeError("role name must be string_types")
             r = re.compile(r"^[0-9a-zA-Z\-_]+$")
             if not r.match(new_name):
-                raise TypeError("""
+                raise TypeError(
+                    """
                 role's name can only contain alphanumeric characters, _, -, and spaces.
-                """)
+                """
+                )
 
         return super(Role, self).validate(attrs)

tests/test_engine.py

@@ -93,12 +93,27 @@ def test_ping():  # type: () -> None
 
 
 def test_lean_engine_error():
+    err = leancloud.LeanEngineError(status=404, code=1234567, message="nowhere")
+    assert err.status == 404
+    assert err.code == 1234567
+    assert err.message == "nowhere"
+    # backward compatibility tests
+    err = leancloud.LeanEngineError(code=2020, message="eanCloud")
+    assert err.status == 2020
+    assert err.code == 2020
+    assert err.message == "eanCloud"
     err = leancloud.LeanEngineError(233, "llllleancloud")
+    assert err.status == 233
     assert err.code == 233
     assert err.message == "llllleancloud"
     err = leancloud.LeanEngineError("error messages")
+    assert err.status == 400
     assert err.code == 400
     assert err.message == "error messages"
+    err = leancloud.LeanEngineError()
+    assert err.status == 400
+    assert err.code == 400
+    assert err.message == "error"
 
 
 def test_origin_response():  # type: () -> None
@@ -309,6 +324,7 @@ def _messageReceived():
     try:
         cloud.run.local("_messageReceived")
     except leancloud.LeanEngineError as e:
+        assert_equal(e.status, 401)
         assert_equal(e.code, 401)
     else:
         raise AssertionError