Merge pull request #17 from cocolato/dev

[ENH] Provides command line tool for pydumpling

Author: cocolato

.gitignore

@@ -5,4 +5,5 @@ __pycache__
 *.dump
 test.py
 /my
-.vscode
+.vscode
+.idea

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

@@ -0,0 +1,3 @@
+from .cli import main
+
+main()

dist/pydumpling-0.1.1.tar.gz

@@ -0,0 +1,53 @@
+import argparse
+import os.path
+from .debug_dumpling import debug_dumpling, load_dumpling
+from .helpers import print_traceback_and_except
+
+DUMP_FILE_EXTENSION: str = ".dump"
+
+
+def validate_file_name(file_name: str) -> str:
+    """check file extension name and exists"""
+    if not file_name.endswith(DUMP_FILE_EXTENSION):
+        raise argparse.ArgumentTypeError("File must be .dump file")
+    if not os.path.exists(file_name):
+        raise argparse.ArgumentTypeError(f"File {file_name}  not found")
+    return file_name
+
+
+parser = argparse.ArgumentParser(
+    description="pydumpling cli tools",
+    prog="pydumpling",
+    usage="%(prog)s [options] filename"
+)
+
+# print or debug
+pydumpling_cli_action_group = parser.add_mutually_exclusive_group(required=True)
+
+pydumpling_cli_action_group.add_argument(
+    "--print",
+    action="store_true",
+    help="print traceback information"
+)
+
+pydumpling_cli_action_group.add_argument(
+    "--debug",
+    action="store_true",
+    help="enter pdb debugging interface"
+)
+
+parser.add_argument(
+    "filename",
+    type=validate_file_name,
+    help="the .dump file"
+)
+
+
+def main() -> None:
+    args = parser.parse_args()
+    file_name = args.filename
+    if args.print:
+        dumpling_ = load_dumpling(file_name)
+        print_traceback_and_except(dumpling_)
+    elif args.debug:
+        debug_dumpling(file_name)

poetry.lock

@@ -66,7 +66,7 @@ def __init__(self, traceback=None):
         self.tb_lineno = traceback.tb_lineno if traceback else None
         self.tb_next = FakeTraceback(
             traceback.tb_next) if traceback and traceback.tb_next else None
-        self.tb_lasti = 0
+        self.tb_lasti = traceback.tb_lasti if traceback else 0
 
 
 class FakeFrame(FakeType):
@@ -78,6 +78,8 @@ def __init__(self, frame):
         self.f_globals = self._convert_dict(frame.f_globals)
         self.f_lineno = frame.f_lineno
         self.f_back = FakeFrame(frame.f_back) if frame.f_back else None
+        self.f_lasti = frame.f_lasti
+        self.f_builtins = frame.f_builtins
 
 
 class FakeClass(FakeType):
@@ -107,6 +109,8 @@ def __init__(self, code):
             code, "co_lines") else []
         if hasattr(code, "co_kwonlyargcount"):
             self.co_kwonlyargcount = code.co_kwonlyargcount
+        if hasattr(code, "co_positions"):
+            self.co_positions = code.co_positions
 
     def co_lines(self):
         return iter(self._co_lines)

pydumpling/__main__.py

@@ -0,0 +1,26 @@
+import linecache
+
+
+def print_traceback_and_except(dumpling_result):
+    traceback_obj = dumpling_result["traceback"]
+    except_extra = dumpling_result["exc_extra"]
+    except_type = except_extra["exc_type"]
+    except_value = except_extra["exc_value"]
+
+    print("Traceback (most recent call last):")
+    while traceback_obj:
+        frame = traceback_obj.tb_frame
+        lineno = traceback_obj.tb_lineno
+        filename = frame.f_code.co_filename
+        function_name = frame.f_code.co_name
+        line = linecache.getline(filename, lineno).strip()
+        mid_index = len(line) // 2
+
+        print(f"File \"{filename}\", line {lineno}, in {function_name}")
+        print(f"  {line}")
+        print(" " * 4 + "~" * mid_index + "^" + "~" * mid_index)
+        traceback_obj = traceback_obj.tb_next
+
+        if traceback_obj is None:
+            break
+    print(f"{except_type.__name__}: {except_value}")

pydumpling/cli.py

@@ -14,16 +14,20 @@
 def save_dumping(filename=None, tb=None):
     try:
         if tb is None:
-            tb = sys.exc_info()[2]
+            exc_type, exc_value, exc_tb = sys.exc_info()
 
         if filename is None:
             filename = "%s:%d.dump" % (
-                tb.tb_frame.f_code.co_filename, tb.tb_frame.f_lineno)
+                exc_tb.tb_frame.f_code.co_filename, exc_tb.tb_frame.f_lineno)
 
-        fake_tb = FakeTraceback(tb)
+        fake_tb = FakeTraceback(exc_tb)
         dumpling = {
             "traceback": fake_tb,
             "version": __version__,
+            "exc_extra": {
+                "exc_type": exc_type,
+                "exc_value": exc_value,
+            },
             "dump_type": "DILL"
         }
         with gzip.open(filename, "wb") as f:
@@ -68,7 +72,7 @@ def gen_tb_from_frame(f):
     f = f.f_back
     if f is None:
         return tb
-    while f and "python" not in f.f_code.co_filename.lower():
+    while f:
         tb = FakeTraceback()
         tb.tb_frame = FakeFrame(f)
         tb.tb_lasti = f.f_lasti