Add set/show tempdir...

Allows us to set a tempdir which is useful in remote
debugging so decompiled files can share a directory.

Author: rocky

trepan/cli.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: iso-8859-1 -*-
-#   Copyright (C) 2008-2010, 2013-2014, 2016-2017
+#   Copyright (C) 2008-2010, 2013-2014, 2016-2017, 2021
 #   Rocky Bernstein <rocky@gnu.org>
 #
 #   This program is free software: you can redistribute it and/or modify
@@ -118,19 +118,20 @@ def main(dbg=None, sys_argv=list(sys.argv)):
                     raise IOError("Python file name embedded in code %s not found" % try_file)
             except:
                 try:
-                    from uncompyle6 import uncompyle_file
+                    from uncompyle6 import decompile_file
                 except ImportError:
                     print("%s: Compiled python file '%s', but uncompyle6 not found"
                         % (__title__, mainpyfile), file=sys.stderr)
                     sys.exit(1)
                     return
 
-                short_name = osp.basename(mainpyfile).strip('.pyc')
+                short_name = osp.basename(mainpyfile).strip(".pyc")
                 fd = tempfile.NamedTemporaryFile(suffix='.py',
                                                  prefix=short_name + "_",
+                                                 dir=dbg.settings["tempdir"],
                                                  delete=False)
                 try:
-                    uncompyle_file(mainpyfile, fd)
+                    decompile_file(mainpyfile, outstream=fd)
                     mainpyfile = fd.name
                     fd.close()
                 except:

trepan/lib/default.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2008-2009, 2013, 2015, 2017, 2020 Rocky Bernstein <rocky@gnu.org>
+#   Copyright (C) 2008-2009, 2013, 2015, 2017, 2020-2021 Rocky Bernstein
+#   <rocky@gnu.org>
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -98,6 +99,9 @@
     "reload": False,
     # Stop at 'def' and 'class' statements?
     "skip": True,
+    # Location to put temporary decompiled python files.
+    # If value is None, use Python's defaults
+    "tempdir": None,
     # print trace output?
     "trace": False,
     # The target maximum print length. Used for example in listing

trepan/lib/deparse.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-'''Deparsing Routines'''
+"""Deparsing Routines"""
 
 import sys, tempfile
 from StringIO import StringIO
@@ -12,8 +12,9 @@
 
 deparse_cache = {}
 
-def deparse_and_cache(co, errmsg_fn):
+def deparse_and_cache(co, errmsg_fn, tempdir=None):
     # co = proc_obj.curframe.f_code
+    print("XXXX yo - rocky")
     out = StringIO()
     deparsed = deparse_cache.get(co, None)
     if not deparsed or not hasattr(deparsed, "source_linemap"):
@@ -36,6 +37,7 @@ def deparse_and_cache(co, errmsg_fn):
     name_for_code = sha1(co.co_code).hexdigest()[:6]
     prefix='deparsed-'
     fd = tempfile.NamedTemporaryFile(suffix='.py',
+                                     dir=tempdir,
                                      prefix=prefix)
     fd.write(text.encode('utf-8'))
     map_line = "\n\n# %s" % linemap

trepan/processor/cmdfns.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2013, 2015, 2017 Rocky Bernstein <rocky@gnu.org>
+#   Copyright (C) 2013, 2015, 2017, 2021 Rocky Bernstein <rocky@gnu.org>
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -17,13 +17,14 @@
 counts, to parse a string for an integer, or check a string for an
 on/off setting value.
 '''
-import os, sys, tempfile
-import pyficache
+import sys, tempfile
 
 def source_tempfile_remap(prefix, text):
+    print("Hi rocky!")
     fd = tempfile.NamedTemporaryFile(suffix='.py',
                                      prefix=prefix,
-                                     delete=False)
+                                     delete=False,
+                                     tempdir=None)
     with fd:
         fd.write(bytes(text, 'UTF-8'))
         fd.close()
@@ -43,26 +44,6 @@ def deparse_fn(code):
         raise
     return None
 
-def deparse_getline(code, filename, line_number, opts):
-    # Would love to figure out how to deparse the entire module
-    # but with all many-time rewritten import stuff, I still
-    # can't figure out how to get from "<frozen importlib>" to
-    # the module's code.
-    # So for now, we'll have to do this on a function by function
-    # bases. Fortunately pyficache has the ability to remap line
-    # numbers
-    text = deparse_fn(code)
-    if text:
-        prefix = os.path.basename(filename) + "_"
-        remapped_filename = source_tempfile_remap(prefix, text)
-        lines = text.split("\n")
-        first_line = code.co_firstlineno
-        pyficache.remap_file_lines(filename, remapped_filename,
-                                   range(first_line, first_line+len(lines)),
-                                   1)
-        return remapped_filename, pyficache.getline(filename, line_number, opts)
-    return None, None
-
 def get_an_int(errmsg, arg, msg_on_error, min_value=None, max_value=None):
     """Another get_int() routine, this one simpler and less stylized
     than get_int(). We eval arg return it as an integer value or
@@ -207,28 +188,28 @@ def want_different_line(cmd, default):
 # Demo it
 if __name__ == '__main__':
     def errmsg(msg):
-        print "** ", msg
+        print("** ", msg)
         return
 
     def msg(m):
-        print m
-    print get_int(errmsg, '1+2')  # 3
-    print get_int(errmsg, None)  # 1
-    print get_an_int(errmsg, '6*1', '6*1 is okay')  # 6
-    print get_an_int(errmsg, '0', '0 is too small', 1)  # errmsg
-    print get_an_int(errmsg, '5+a', '5+a is no good')   # errmsg
+        print(m)
+    print(get_int(errmsg, '1+2'))  # 3
+    print(get_int(errmsg, None))  # 1
+    print(get_an_int(errmsg, '6*1', '6*1 is okay'))  # 6
+    print(get_an_int(errmsg, '0', '0 is too small', 1))  # errmsg
+    print(get_an_int(errmsg, '5+a', '5+a is no good'))   # errmsg
     try:
         get_int(errmsg, 'pi')
     except ValueError:
-        print "Good - 'pi' is not an integer"
+        print("Good - 'pi' is not an integer")
         pass
 
     import inspect
     curframe = inspect.currentframe()
 
-    print want_different_line("s+", False)
-    print want_different_line("s-", True)
-    print want_different_line("s", False)
-    print want_different_line("s", True)
-    print want_different_line("s", True)
+    print(want_different_line("s+", False))
+    print(want_different_line("s-", True))
+    print(want_different_line("s", False))
+    print(want_different_line("s", True))
+    print(want_different_line("s", True))
     pass

trepan/processor/cmdproc.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2008-2010, 2013-2018, 2020 Rocky Bernstein <rocky@gnu.org>
+#   Copyright (C) 2008-2010, 2013-2018, 2020-2021 Rocky Bernstein
+#   <rocky@gnu.org>
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -13,7 +14,7 @@
 #
 #   You should have received a copy of the GNU General Public License
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
-import inspect, linecache, re, sys, shlex, tempfile, traceback, types
+import inspect, linecache, sys, shlex, tempfile, traceback, types
 import os.path as osp
 import pyficache
 from repr import Repr
@@ -192,7 +193,8 @@ def print_location(proc_obj):
             remapped_file = filename
             filename = pyficache.unmap_file(filename)
             if "<string>" == filename:
-                remapped = source_tempfile_remap("eval_string", dbgr_obj.eval_string)
+                remapped = source_tempfile_remap("eval_string", dbgr_obj.eval_string,
+                                                 tempdir=proc_obj.settings("tempdir"))
                 pyficache.remap_file(filename, remapped)
                 filename = remapped
                 lineno = pyficache.unmap_file_line(filename, lineno)
@@ -203,7 +205,7 @@ def print_location(proc_obj):
             filename = "<string: '%s'>" % source_text
             pass
         elif filename in proc_obj.file2file_remap:
-            remapped_file = self.file2file_remap[filename]
+            remapped_file = proc_obj.file2file_remap[filename]
         elif filename in pyficache.file2file_remap:
             remapped_file = pyficache.unmap_file(filename)
             # FIXME: a remapped_file shouldn't be the same as its unmapped version
@@ -233,7 +235,9 @@ def print_location(proc_obj):
                 # Deparse the code object into a temp file and remap the line from code
                 # into the corresponding line of the tempfile
                 co = proc_obj.curframe.f_code
-                temp_filename, name_for_code = deparse_and_cache(co, proc_obj.errmsg)
+                tempdir = proc_obj.settings("tempdir")
+                temp_filename, name_for_code = deparse_and_cache(co, proc_obj.errmsg,
+                                                                 tempdir=tempdir)
                 lineno = 1
                 # _, lineno = pyficache.unmap_file_line(temp_filename, lineno, True)
                 if temp_filename:
@@ -253,7 +257,8 @@ def print_location(proc_obj):
                     # FIXME: DRY code with version in cmdproc.py print_location
                     prefix = osp.basename(temp_name).split(".")[0]
                     fd = tempfile.NamedTemporaryFile(
-                        suffix=".py", prefix=prefix, delete=False
+                        suffix=".py", prefix=prefix, delete=False,
+                        dir=proc_obj.settings("tempdir"),
                     )
                     with fd:
                         fd.write("".join(lines))

trepan/processor/command/deparse.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (C) 2015-2018, 2020 Rocky Bernstein
+#  Copyright (C) 2015-2018, 2020-2021 Rocky Bernstein
 #
 #  This program is free software: you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
@@ -117,7 +117,8 @@ def run(self, args):
         nodeInfo = None
 
         if len(args) >= 1 and args[0] == ".":
-            temp_filename, name_for_code = deparse_and_cache(co, self.errmsg)
+            temp_filename, name_for_code = deparse_and_cache(co, self.errmsg,
+                                                             tempdir=self.settings["tempdir"])
             if not temp_filename:
                 return
             self.print_text("".join(getlines(temp_filename)))

trepan/processor/command/list.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2009, 2012-2018 Rocky Bernstein
+#   Copyright (C) 2009, 2012-2018, 2021 Rocky Bernstein
 #
 #  This program is free software: you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
@@ -96,7 +96,7 @@ def run(self, args):
             # Deparse the code object into a temp file and remap the line from code
             # into the corresponding line of the tempfile
             co = proc.curframe.f_code
-            temp_filename, name_for_code = deparse_and_cache(co, proc.errmsg)
+            temp_filename, name_for_code = deparse_and_cache(co, proc.errmsg, tempdir=self.settings["tempdir"])
             if temp_filename:
                 filename = temp_filename
                 show_marks = False

trepan/processor/command/set_subcmd/tempdir.py

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+#   Copyright (C) 2021 Rocky Bernstein
+#
+
+import os
+# Our local modules
+from trepan.processor.command.base_subcmd import DebuggerSubcommand
+
+
+class SetTempdir(DebuggerSubcommand):
+    """**set tempdir** *directory*
+
+Set the temporary directory for temporary decompiled python files.
+
+This is sometimes useful remote debugging where you might set up a
+common shared location available between the debugged process and
+the front end client.
+Examples:
+---------
+
+    set tempdir /code/tmp  # /code is a shared directory
+
+See also:
+--------
+
+`show tempdir`
+"""
+
+    in_list = True
+    min_abbrev = len("temp")
+    min_args = 1
+    max_args = 1
+    short_help = "Set a directory for storing decompiled Python"
+
+    def run(self, args):
+        dirpath = args[0]
+        if os.path.isdir(dirpath):
+            self.debugger.settings[self.name] = dirpath
+        else:
+            self.errmsg("set tempdir: directory %s not found; not changed." % dirpath)
+        return
+
+    pass
+
+
+# if __name__ == '__main__':
+#     from trepan.processor.command.set.tempdir import __demo_helper__ as Mhelper
+#     sub = Mhelper.demo_run(SetTempdir)
+#     d = sub.proc.debugger
+#     sub.run(['tempdir'])
+#     print(d.settings['tempdir'])
+#     pass

trepan/processor/command/show_subcmd/tempdir.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#   Copyright (C) 2021 Rocky Bernstein
+#
+
+# Our local modules
+from trepan.processor.command.base_subcmd import DebuggerSubcommand
+
+
+class ShowTempdir(DebuggerSubcommand):
+    """**show tempdir**
+
+Show the temporary directory usind in decompiled python files.
+
+See also:
+--------
+
+`set tempdir`
+"""
+
+    in_list = True
+    min_abbrev = len("temp")
+    min_args = 0
+    max_args = 0
+    short_help = "Set a directory for storing decompiled Python"
+
+    def run(self, args):
+        tempdir = self.debugger.settings.get(self.name, None)
+        if tempdir:
+            self.msg("tempdir is %s." % tempdir)
+        else:
+            self.msg("tempdir style not set; Python default is used.")
+        return
+    pass
+
+if __name__ == "__main__":
+    from trepan.processor.command.set_subcmd import __demo_helper__ as Mhelper
+
+    sub = Mhelper.demo_run(ShowTempdir)
+    d = sub.proc.debugger
+    sub.run(["show"])
+    pass