Add set/show tempdir

Useful in remote debugging when a file gets decompiled and
needs to be shared.

Author: rocky

trepan/__main__.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: iso-8859-1 -*-
-#   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
@@ -155,7 +156,10 @@ def main(dbg=None, sys_argv=list(sys.argv)):
 
                 short_name = osp.basename(mainpyfile).strip(".pyc")
                 fd = tempfile.NamedTemporaryFile(
-                    suffix=".py", prefix=short_name + "_", delete=False
+                    suffix=".py",
+                    prefix=short_name + "_",
+                    delete=False,
+                    dir=dbg.settings["tempdir"],
                 )
                 old_write = fd.file.write
 

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
@@ -104,6 +105,9 @@
     # (In the Python they are "class" and "def" statments)
     "skip": True,
     "step_ignore": 0,
+    # 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,18 +1,19 @@
 # -*- coding: utf-8 -*-
-'''Deparsing Routines'''
+"""Deparsing Routines"""
 
 import sys, tempfile
 from io import StringIO
 from hashlib import sha1
 from uncompyle6.semantics.linemap import code_deparse_with_map
-from uncompyle6.semantics.fragments import (
-    deparsed_find, code_deparse)
+from uncompyle6.semantics.fragments import deparsed_find, code_deparse
 import pyficache
+
 # FIXME remap filename to a short name.
 
 deparse_cache = {}
 
-def deparse_and_cache(co, errmsg_fn):
+
+def deparse_and_cache(co, errmsg_fn, tempdir=None):
     # co = proc_obj.curframe.f_code
     out = StringIO()
     deparsed = deparse_cache.get(co, None)
@@ -27,32 +28,33 @@ def deparse_and_cache(co, errmsg_fn):
         deparse_cache[co] = deparsed
 
     text = out.getvalue()
-    linemap = [(line_no, deparsed.source_linemap[line_no])
-                   for line_no in
-                   sorted(deparsed.source_linemap.keys())]
+    linemap = [
+        (line_no, deparsed.source_linemap[line_no])
+        for line_no in sorted(deparsed.source_linemap.keys())
+    ]
 
     # FIXME: DRY code with version in cmdproc.py print_location
 
     name_for_code = sha1(co.co_code).hexdigest()[:6]
-    prefix='deparsed-'
-    fd = tempfile.NamedTemporaryFile(suffix='.py',
-                                     prefix=prefix,
-                                     delete=False)
+    prefix = "deparsed-"
+    fd = tempfile.NamedTemporaryFile(
+        suffix=".py", prefix=prefix, dir=tempdir, delete=False
+    )
     with fd:
-        fd.write(text.encode('utf-8'))
+        fd.write(text.encode("utf-8"))
         map_line = "\n\n# %s" % linemap
-        fd.write(map_line.encode('utf-8'))
+        fd.write(map_line.encode("utf-8"))
         remapped_file = fd.name
     fd.close()
     # FIXME remap filename to a short name.
-    pyficache.remap_file_lines(name_for_code, remapped_file,
-                               linemap)
+    pyficache.remap_file_lines(name_for_code, remapped_file, linemap)
     return remapped_file, name_for_code
 
+
 def deparse_offset(co, name, last_i, errmsg_fn):
     nodeInfo = None
     deparsed = deparse_cache.get(co, None)
-    if not deparsed or not hasattr(deparsed, 'offsets'):
+    if not deparsed or not hasattr(deparsed, "offsets"):
         out = StringIO()
         try:
             # FIXME: cache co
@@ -76,14 +78,15 @@ def deparse_offset(co, name, last_i, errmsg_fn):
 
 
 # Demo it
-if __name__ == '__main__':
+if __name__ == "__main__":
     import inspect
+
     def msg(msg_str):
         print(msg_str)
         return
 
     def errmsg(msg_str):
-        msg('*** ' + msg_str)
+        msg("*** " + msg_str)
         return
 
     curframe = inspect.currentframe()

trepan/processor/cmdfns.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2013, 2015, 2017-2018, 2020 Rocky Bernstein <rocky@gnu.org>
+#   Copyright (C) 2013, 2015, 2017-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
@@ -22,8 +22,10 @@
 from xdis import IS_PYPY
 
 
-def source_tempfile_remap(prefix, text):
-    fd = tempfile.NamedTemporaryFile(suffix=".py", prefix=prefix, delete=False)
+def source_tempfile_remap(prefix, text, tempdir=None):
+    fd = tempfile.NamedTemporaryFile(
+        suffix=".py", prefix=prefix, dir=tempdir, delete=False
+    )
     with fd:
         fd.write(bytes(text, "UTF-8"))
         fd.close()
@@ -48,31 +50,6 @@ def deparse_fn(code):
     return None
 
 
-def deparse_getline(code, filename, line_number, opts):
-    # I Would like to figure out how to deparse the entire module,
-    # instead doing this on a line-by-line basis.
-    # But because th Python import library routines have been rewritten many times, I
-    # 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
-    deparsed = deparse_fn(code)
-    text = deparsed.text.strip()
-    if text:
-        prefix = os.path.basename(filename) + "_"
-        remapped_filename = source_tempfile_remap(prefix, text)
-        lines = text.split("\n")
-        first_line = code.co_firstlineno
-        linemap = [
-            (line_no, deparsed.source_linemap[line_no])
-            for line_no in sorted(deparsed.source_linemap.keys())
-        ]
-        pyficache.remap_file_lines(filename, remapped_filename, linemap)
-        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

trepan/processor/cmdproc.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2008-2010, 2013-2020 Rocky Bernstein <rocky@gnu.org>
+#   Copyright (C) 2008-2010, 2013-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
@@ -207,7 +207,9 @@ def print_location(proc_obj):
             filename = pyficache.unmap_file(filename)
             if "<string>" == filename:
                 remapped = cmdfns.source_tempfile_remap(
-                    "eval_string", dbgr_obj.eval_string
+                    "eval_string",
+                    dbgr_obj.eval_string,
+                    tempdir=proc_obj.settings("tempdir"),
                 )
                 pyficache.remap_file(filename, remapped)
                 filename, lineno = pyficache.unmap_file_line(filename, lineno)
@@ -230,7 +232,9 @@ def print_location(proc_obj):
                     pass
                 pass
             elif pyficache.main.remap_re_hash:
-                remapped_file = pyficache.remap_file_pat(filename, pyficache.main.remap_re_hash)
+                remapped_file = pyficache.remap_file_pat(
+                    filename, pyficache.main.remap_re_hash
+                )
             elif m and m.group(1) in sys.modules:
                 remapped_file = m.group(1)
                 pyficache.remap_file(filename, remapped_file)
@@ -255,7 +259,10 @@ 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:
@@ -275,7 +282,10 @@ 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).encode("utf-8"))
@@ -343,7 +353,10 @@ def print_location(proc_obj):
         val = proc_obj.event_arg
         intf_obj.msg("R=> %s" % proc_obj._saferepr(val))
         pass
-    elif proc_obj.event == "call" and proc_obj.curframe.f_locals.get("__name__", "") != "__main__":
+    elif (
+        proc_obj.event == "call"
+        and proc_obj.curframe.f_locals.get("__name__", "") != "__main__"
+    ):
         try:
             proc_obj.commands["info"].run(["info", "locals"])
         except:
@@ -450,8 +463,8 @@ def add_remap_pat(self, pat, replace, clear_remap=True):
         self.remap_re_hash[re.compile(pat)] = (pat, replace)
         pyficache.main.add_remap_pat(pat, replace, clear_remap)
         if clear_remap:
-             self.file2file_remap = {}
-             pyficache.file2file_remap = {}
+            self.file2file_remap = {}
+            pyficache.file2file_remap = {}
 
     # To be overridden in derived debuggers
     def defaultFile(self):

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
@@ -112,7 +112,9 @@ 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-2017, 2020 Rocky Bernstein
+#   Copyright (C) 2009, 2012-2017, 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

trepan/processor/command/set_subcmd/tempdir.py

@@ -0,0 +1,53 @@
+# -*- 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,43 @@
+# -*- 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 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