Merge pull request #31 from cocolato/dev

support catch_any_exception

Author: cocolato

README.md

@@ -53,7 +53,7 @@ def outer():
 
 ### Save the exception traceback.
 
-In the code, find the place where we need to do the `try ... except ...` and use `save_dumpling()`. When we save the dump file, it will default to `${exception filename}:${error lineno}.dump`.
+In the code, find the place where we need to do the `try ... except ...` and use `save_dumpling()`. When we save the dump file, it will default to `${exception filename}-${error lineno}.dump`.
 
 ```python
 from pydumpling import save_dumping
@@ -160,5 +160,25 @@ It will open the debugger on port 4444, then we can access pdb using telnet、ne
 `nc 127.0.0.1 4444`
 ![alt text](static/rpdb.png)
 
+#### Enable global exception catching:
+```python
+from pydumpling import catch_any_exception
+
+catch_any_exception()
+
+def inner():
+    a = 1
+    b = "2"
+    c = a + b  # noqa: F841
+
+
+def outer():
+    inner()
+    
+if __name__ == "__main__":
+    outer()
+   
+```
+
 ## TODO
 - []

README_zh.md

@@ -48,7 +48,7 @@ def outer():
 
 
 ### 在异常发生时进行异常堆栈的保存
-在异常捕获的处理代码中使用`save_dumpling()`. 如果不指定文件名，默认使用：`${exception file}:${line number of the exception}.dump`.
+在异常捕获的处理代码中使用`save_dumpling()`. 如果不指定文件名，默认使用：`${exception file}-${line number of the exception}.dump`.
 
 ```python
 from pydumpling import save_dumping
@@ -156,5 +156,25 @@ TypeError: unsupported operand type(s) for +: 'int' and 'str'
 `nc 127.0.0.1 4444`
 ![alt text](static/rpdb.png)
 
+#### 开启全局异常捕获:
+```python
+from pydumpling import catch_any_exception
+
+catch_any_exception()
+
+def inner():
+    a = 1
+    b = "2"
+    c = a + b  # noqa: F841
+
+
+def outer():
+    inner()
+    
+if __name__ == "__main__":
+    outer()
+   
+```
+
 ## TODO
 - []

docs/source/tutorial.rst

@@ -122,6 +122,7 @@ help message
       -h, --help  show this help message and exit
       --print     print traceback information
       --debug     enter pdb debugging interface
+      --rdebug    enter rpdb debugging interface
 
 Print the traceback
 ###################
@@ -164,4 +165,27 @@ It will open the debugger on port 4444, then we can access pdb using `telnet`_,
 .. _netcat: https://netcat.sourceforge.net/
 
 
-.. image:: _static/rpdb.png
+.. image:: _static/rpdb.png
+
+
+Enable global exception catching
+################################
+
+.. code-block:: python
+
+    from pydumpling import catch_any_exception
+
+    catch_any_exception()
+
+    def inner():
+        a = 1
+        b = "2"
+        c = a + b  # noqa: F841
+
+
+    def outer():
+        inner()
+        
+    if __name__ == "__main__":
+        outer()
+

pydumpling/__init__.py

@@ -1,9 +1,11 @@
-from __future__ import absolute_import, division, print_function, unicode_literals
+from __future__ import (absolute_import, division, print_function,
+                        unicode_literals)
 
-from .rpdb import r_post_mortem
 from .debug_dumpling import debug_dumpling, load_dumpling
-from .pydumpling import save_dumping, dump_current_traceback, __version__
-
+from .helpers import catch_any_exception
+from .pydumpling import __version__, dump_current_traceback, save_dumping
+from .rpdb import r_post_mortem
 
 __version__ == __version__
-__all__ = ["debug_dumpling", "load_dumpling", "save_dumping", "dump_current_traceback", "r_post_mortem"]
+__all__ = ["debug_dumpling", "load_dumpling", "save_dumping",
+           "dump_current_traceback", "r_post_mortem", "catch_any_exception"]

pydumpling/cli.py

@@ -1,8 +1,9 @@
 import argparse
 import os.path
+
 from .debug_dumpling import debug_dumpling, load_dumpling
-from .rpdb import r_post_mortem
 from .helpers import print_traceback_and_except
+from .rpdb import r_post_mortem
 
 DUMP_FILE_EXTENSION: str = ".dump"
 

pydumpling/debug_dumpling.py

@@ -1,13 +1,16 @@
-from __future__ import absolute_import, division, print_function, unicode_literals
+from __future__ import (absolute_import, division, print_function,
+                        unicode_literals)
 
 import gzip
+import inspect
 import pdb
-import dill
 import pickle
-from packaging.version import parse
-import inspect
 import types
-from .fake_types import FakeFrame, FakeTraceback, FakeCode
+
+import dill
+from packaging.version import parse
+
+from .fake_types import FakeCode, FakeFrame, FakeTraceback
 
 
 def load_dumpling(filename):

pydumpling/fake_types.py

@@ -1,7 +1,9 @@
-from __future__ import absolute_import, division, print_function, unicode_literals
+from __future__ import (absolute_import, division, print_function,
+                        unicode_literals)
 
 import os
 import sys
+
 import dill
 
 
@@ -41,7 +43,7 @@ def _convert(cls, v):
             except Exception:
                 return cls._safe_repr(v)
         else:
-            from datetime import date, time, datetime, timedelta
+            from datetime import date, datetime, time, timedelta
 
             BUILTIN = (str, unicode, int, long, float, date, time, datetime, timedelta) if sys.version_info.major == 2 \
                 else (str, int, float, date, time, datetime, timedelta)  # noqa: F821

pydumpling/helpers.py

@@ -1,5 +1,6 @@
 import sys
-from traceback import print_tb, print_exception
+from traceback import print_exception, print_tb
+
 from .pydumpling import save_dumping
 
 

pydumpling/pydumpling.py

@@ -1,11 +1,14 @@
-from __future__ import absolute_import, division, print_function, unicode_literals
+from __future__ import (absolute_import, division, print_function,
+                        unicode_literals)
 
 import gzip
-import sys
-import dill
+import inspect
 import pickle
+import sys
 import warnings
-import inspect
+
+import dill
+
 from .fake_types import FakeFrame, FakeTraceback
 
 __version__ = "0.1.5"

pydumpling/rpdb.py

@@ -1,7 +1,8 @@
 import pdb
 import socket
-import threading
 import sys
+import threading
+
 from .debug_dumpling import load_dumpling, mock_inspect
 
 DEFAULT_ADDR = "127.0.0.1"