feature/enhancement: new more developer friendly API, and consistent with js-mybad

Author: grimen

Makefile

@@ -44,7 +44,7 @@ install:
 .PHONY: install-ci
 install-ci:
 	PYTHON_USER_FLAG=$(shell python -c "import sys; print('' if hasattr(sys, 'real_prefix') or hasattr(sys, 'base_prefix') else '--user')") && \
-	pip install $(PYTHON_USER_FLAG) -U setuptools setuptools-git tox tox-travis && \
+	pip install $(PYTHON_USER_FLAG) -U setuptools setuptools-git setupextras tox tox-travis && \
 	pip install $(PYTHON_USER_FLAG) -r requirements.txt
 
 

README.md

@@ -72,21 +72,70 @@ PRINT $$$$$$$$$$
 PRINT $$$$$$$$$$$
 PRINT $$$$$$$$$$$$
 PRINT $$$$$$$$$$$$$
-Out of money printing ink... - { stash: '$$$$$$$$$$$$$$' }
-
+===============================
+     str(error)
+---------------------------
+Out of money printing ink... - {'stash': '$$$$$$$$$$$$$$'}
+
+===============================
+     error.stack
+---------------------------
 Traceback (most recent call last):
-  File "examples/basic.py", line 25, in print_money
+  File "examples/basic.py", line 27, in print_money
     raise Exception('Too much money to print: {0}'.format(stash))
 Exception: Too much money to print: $$$$$$$$$$$$$$
 
-During handling of the above exception, another exception occurred:
+===============================
+     error.inspect()
+---------------------------
+{   'code': 400,
+    'details': {'stash': '$$$$$$$$$$$$$$'},
+    'id': 3563898309523127190,
+    'key': 'too_much',
+    'message': 'Out of money printing ink...',
+    'stack': [   {   'code': ['stash = stash,'],
+                     'file': 'examples/basic.py',
+                     'function': 'print_money',
+                     'line': 38},
+                 {   'code': ['print_money(amount)'],
+                     'file': 'examples/basic.py',
+                     'function': '<module>',
+                     'line': 48}],
+    'type': 'ToMuchError'}
+
+
+===============================
+     error.json()
+---------------------------
+{
+    "type": "ToMuchError",
+    "id": 3563898309523127190,
+    "code": 400,
+    "key": "too_much",
+    "message": "Out of money printing ink...",
+    "details": {
+        "stash": "$$$$$$$$$$$$$$"
+    },
+    "stack": [
+        {
+            "file": "examples/basic.py",
+            "function": "print_money",
+            "line": 38,
+            "code": [
+                "stash = stash,"
+            ]
+        },
+        {
+            "file": "examples/basic.py",
+            "function": "<module>",
+            "line": 48,
+            "code": [
+                "print_money(amount)"
+            ]
+        }
+    ]
+}
 
-Traceback (most recent call last):
-  File "examples/basic.py", line 45, in <module>
-    print_money(amount)
-  File "examples/basic.py", line 36, in print_money
-    stash = stash,
-__main__.ToMuchError: Out of money printing ink... - {'stash': '$$$$$$$$$$$$$$'}
 ```
 
 

examples/basic.py

@@ -7,6 +7,8 @@
 
 rootpath.append()
 
+import json
+
 
 # =========================================
 #       EXAMPLE
@@ -46,7 +48,27 @@ def print_money(stash):
         print_money(amount)
 
     except Exception as error:
+        print('===============================')
+        print('     str(error)')
+        print('---------------------------')
         print(str(error))
-
-        raise error
-
+        print()
+
+        print('===============================')
+        print('     error.stack')
+        print('---------------------------')
+        print(error.stack)
+
+        print('===============================')
+        print('     error.inspect()')
+        print('---------------------------')
+        print(error.inspect(colors = True, verbose = True))
+        print()
+
+        print('===============================')
+        print('     error.json()')
+        print('---------------------------')
+        print(error.json())
+        print()
+
+        break