diff -r 8c48f5e0cd92 -r 878ce843ca9f DebugClients/Python/PyProfile.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/DebugClients/Python/PyProfile.py Mon Sep 19 22:47:52 2016 +0200
@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2009 - 2016 Detlev Offenbach <detlev@die-offenbachs.de>
+
+"""
+Module defining additions to the standard Python profile.py.
+"""
+
+import os
+import marshal
+import profile
+import atexit
+import pickle
+
+
+class PyProfile(profile.Profile):
+ """
+ Class extending the standard Python profiler with additional methods.
+
+ This class extends the standard Python profiler by the functionality to
+ save the collected timing data in a timing cache, to restore these data
+ on subsequent calls, to store a profile dump to a standard filename and
+ to erase these caches.
+ """
+ def __init__(self, basename, timer=None, bias=None):
+ """
+ Constructor
+
+ @param basename name of the script to be profiled (string)
+ @param timer function defining the timing calculation
+ @param bias calibration value (float)
+ """
+ profile.Profile.__init__(self, timer, bias)
+
+ self.dispatch = self.__class__.dispatch
+
+ basename = os.path.splitext(basename)[0]
+ self.profileCache = "{0}.profile".format(basename)
+ self.timingCache = "{0}.timings".format(basename)
+
+ self.__restore()
+ atexit.register(self.save)
+
+ def __restore(self):
+ """
+ Private method to restore the timing data from the timing cache.
+ """
+ if not os.path.exists(self.timingCache):
+ return
+
+ try:
+ cache = open(self.timingCache, 'rb')
+ timings = marshal.load(cache)
+ if isinstance(timings, dict):
+ self.timings = timings
+ except Exception:
+ pass
+ finally:
+ cache.close()
+
+ def save(self):
+ """
+ Public method to store the collected profile data.
+ """
+ # dump the raw timing data
+ try:
+ cache = open(self.timingCache, 'wb')
+ marshal.dump(self.timings, cache)
+ except Exception:
+ pass
+ finally:
+ cache.close()
+
+ # dump the profile data
+ self.dump_stats(self.profileCache)
+
+ def dump_stats(self, file):
+ """
+ Public method to dump the statistics data.
+
+ @param file name of the file to write to (string)
+ """
+ try:
+ f = open(file, 'wb')
+ self.create_stats()
+ pickle.dump(self.stats, f, 2)
+ except (EnvironmentError, pickle.PickleError):
+ pass
+ finally:
+ f.close()
+
+ def erase(self):
+ """
+ Public method to erase the collected timing data.
+ """
+ self.timings = {}
+ if os.path.exists(self.timingCache):
+ os.remove(self.timingCache)
+
+ def fix_frame_filename(self, frame):
+ """
+ Public method used to fixup the filename for a given frame.
+
+ The logic employed here is that if a module was loaded
+ from a .pyc file, then the correct .py to operate with
+ should be in the same path as the .pyc. The reason this
+ logic is needed is that when a .pyc file is generated, the
+ filename embedded and thus what is readable in the code object
+ of the frame object is the fully qualified filepath when the
+ pyc is generated. If files are moved from machine to machine
+ this can break debugging as the .pyc will refer to the .py
+ on the original machine. Another case might be sharing
+ code over a network... This logic deals with that.
+
+ @param frame the frame object
+ @return fixed up file name (string)
+ """
+ # get module name from __file__
+ if not isinstance(frame, profile.Profile.fake_frame) and \
+ '__file__' in frame.f_globals:
+ root, ext = os.path.splitext(frame.f_globals['__file__'])
+ if ext in ['.pyc', '.py', '.py3', '.pyo']:
+ fixedName = root + '.py'
+ if os.path.exists(fixedName):
+ return fixedName
+
+ fixedName = root + '.py3'
+ if os.path.exists(fixedName):
+ return fixedName
+
+ return frame.f_code.co_filename
+
+ def trace_dispatch_call(self, frame, t):
+ """
+ Public method used to trace functions calls.
+
+ This is a variant of the one found in the standard Python
+ profile.py calling fix_frame_filename above.
+
+ @param frame reference to the call frame
+ @param t arguments
+ @return flag indicating a successful handling (boolean)
+ """
+ if self.cur and frame.f_back is not self.cur[-2]:
+ rpt, rit, ret, rfn, rframe, rcur = self.cur
+ if not isinstance(rframe, profile.Profile.fake_frame):
+ assert rframe.f_back is frame.f_back, ("Bad call", rfn,
+ rframe, rframe.f_back,
+ frame, frame.f_back)
+ self.trace_dispatch_return(rframe, 0)
+ assert (self.cur is None or
+ frame.f_back is self.cur[-2]), ("Bad call",
+ self.cur[-3])
+ fcode = frame.f_code
+ fn = (self.fix_frame_filename(frame),
+ fcode.co_firstlineno, fcode.co_name)
+ self.cur = (t, 0, 0, fn, frame, self.cur)
+ timings = self.timings
+ if fn in timings:
+ cc, ns, tt, ct, callers = timings[fn]
+ timings[fn] = cc, ns + 1, tt, ct, callers
+ else:
+ timings[fn] = 0, 0, 0, 0, {}
+ return 1
+
+ dispatch = {
+ "call": trace_dispatch_call,
+ "exception": profile.Profile.trace_dispatch_exception,
+ "return": profile.Profile.trace_dispatch_return,
+ "c_call": profile.Profile.trace_dispatch_c_call,
+ "c_exception": profile.Profile.trace_dispatch_return,
+ # the C function returned
+ "c_return": profile.Profile.trace_dispatch_return,
+ }
+
+#
+# eflag: noqa = M702
