support dump traceback anywhere

Author: cocolato

.gitignore

@@ -3,4 +3,6 @@ __pycache__
 *.pyc
 /.pytest_cache
 *.dump
-test.py
+test.py
+/my
+.vscode

README.md

@@ -3,6 +3,7 @@
 English | [简体中文](README_zh.md)
 
 It's a fork/optimized version from [elifiner/pydump](https://github.com/elifiner/pydump).The main optimization points are：
+* Save the `Python traceback` anywhere, not just when it's an exception.
 * Optimize code structure && remove redundant code
 * fix bug in python2.7 && support python3.10+
 * supported more pdb commnd
@@ -24,11 +25,33 @@ Python version：>= 2.7, >=3.6
 
 Not published in pypi，so use the `.whl` file install pydumpling in the dist path.
 ```
-pip install dist/pydumpling-0.1.0-py2.py3-none-any.whl
+pip install dist/pydumpling-0.1.1-py2.py3-none-any.whl
 ```
 
 ## How to use pydumpling
 
+
+### Save the python traceback anywhere.
+```python
+from pydumpling import dump_current_traceback
+from inspect import currentframe
+
+
+def inner():
+    a = 1
+    b = "2"
+    dump_current_traceback("test.dump")
+    c = str(a) + b
+
+
+def outer():
+    d = 4
+    inner()
+
+```
+
+### 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`.
 
 ```python

README_zh.md

@@ -1,6 +1,7 @@
 # 针对Python的异常调试器
 
 这是 [elifiner/pydump](https://github.com/elifiner/pydump) 的fork/优化版本, 主要优化点有:
+* 支持在任何地方保存`Python traceback`，而不是只在异常发生的时候
 * 优化代码结构, 去除冗余代码
 * 修复其在2.7及3.10版本中的bug
 * 支持更多的pdb命令
@@ -19,12 +20,34 @@ Python版本支持：>= 2.7, >=3.6
 
 目前还没有在Pypi上面进行发布，因此直接使用PIP安装dist目录下的whl文件
 ```
-pip install dist/pydumpling-0.1.0-py2.py3-none-any.whl
+pip install dist/pydumpling-0.1.1-py2.py3-none-any.whl
 ```
 
 ## 使用方法
 
-In the code, find the place where we need to do the exception replump and use 'save_dumpling()'. When we save the dump file, it will default to '${exception file}:${line number of the exception}.dump'.
+### 在任何地方进行`traceback`的保存
+```python
+from pydumpling import dump_current_traceback
+from inspect import currentframe
+
+
+def inner():
+    a = 1
+    b = "2"
+    dump_current_traceback("test.dump")
+    c = str(a) + b
+
+
+def outer():
+    d = 4
+    inner()
+
+```
+
+
+
+### 在异常发生时进行异常堆栈的保存
+在异常捕获的处理代码中使用`save_dumpling()`. 如过不指定文件名，默认使用：`${exception file}:${line number of the exception}.dump`.
 
 ```python
 from pydumpling import save_dumping

dist/pydumpling-0.1.0-py2.py3-none-any.whl

@@ -1,7 +1,7 @@
 from __future__ import absolute_import, division, print_function, unicode_literals
 
 from .debug_dumpling import debug_dumpling, load_dumpling
-from .pydumpling import save_dumping, __version__
+from .pydumpling import save_dumping, dump_current_traceback, __version__
 
 __version__ == __version__
-__all__ = ["debug_dumpling", "load_dumpling", "save_dumping"]
+__all__ = ["debug_dumpling", "load_dumpling", "save_dumping", "dump_current_traceback"]

dist/pydumpling-0.1.0.tar.gz

@@ -60,12 +60,12 @@ def _convert(cls, v):
 
 class FakeTraceback(FakeType):
 
-    def __init__(self, traceback):
+    def __init__(self, traceback=None):
         self.tb_frame = FakeFrame(
-            traceback.tb_frame) if traceback.tb_frame else None
-        self.tb_lineno = traceback.tb_lineno
+            traceback.tb_frame) if traceback and traceback.tb_frame else None
+        self.tb_lineno = traceback.tb_lineno if traceback else None
         self.tb_next = FakeTraceback(
-            traceback.tb_next) if traceback.tb_next else None
+            traceback.tb_next) if traceback and traceback.tb_next else None
         self.tb_lasti = 0
 
 

dist/pydumpling-0.1.1-py2.py3-none-any.whl

@@ -5,9 +5,10 @@
 import dill
 import pickle
 import warnings
-from .fake_types import FakeTraceback
+import inspect
+from .fake_types import FakeFrame, FakeTraceback
 
-__version__ = "0.0.1"
+__version__ = "0.1.1"
 
 
 def save_dumping(filename=None, tb=None):
@@ -34,3 +35,48 @@ def save_dumping(filename=None, tb=None):
     except Exception as e:
         err_msg = "Unexpected error: %s when dumping traceback" % str(e)
         warnings.warn(err_msg, RuntimeWarning)
+
+
+def dump_current_traceback(filename=None):
+    try:
+        fake_tb = gen_tb_from_frame(inspect.currentframe())
+        dumpling = {
+            "traceback": fake_tb,
+            "version": __version__,
+            "dump_type": "DILL"
+        }
+        if filename is None:
+            filename = "%s:%d.dump" % (
+                fake_tb.tb_frame.f_code.co_filename, fake_tb.tb_frame.f_lineno)
+        with gzip.open(filename, "wb") as f:
+            try:
+                dill.dump(dumpling, f, protocol=dill.HIGHEST_PROTOCOL)
+            except Exception:
+                dumpling["dump_type"] = "PICKLE"
+                pickle.dump(dumpling, f, protocol=dill.HIGHEST_PROTOCOL)
+    except Exception as e:
+        err_msg = "Unexpected error: %s when dumping traceback" % str(e)
+        warnings.warn(err_msg, RuntimeWarning)
+
+
+def gen_tb_from_frame(f):
+    tb = FakeTraceback()
+    tb.tb_frame = FakeFrame(f)
+    tb.tb_lasti = f.f_lasti
+    tb.tb_lineno = f.f_lineno
+    queue = []
+    f = f.f_back
+    if f is None:
+        return tb
+    while f and "python" not in f.f_code.co_filename.lower():
+        tb = FakeTraceback()
+        tb.tb_frame = FakeFrame(f)
+        tb.tb_lasti = f.f_lasti
+        tb.tb_lineno = f.f_lineno
+        queue.append(tb)
+        f = f.f_back
+
+    for i in range(len(queue)-1, 0, -1):
+        queue[i].tb_next = queue[i-1]
+    queue[0].tb_next = None
+    return queue[-1]