beremiz

unify exception handling of Beremiz and PLCOpenEditor

2017-08-25, Andrey Skvortsov
4d1de8b0183f
Parents 3216ed1ba1f7
Children c2f48d791d9f
unify exception handling of Beremiz and PLCOpenEditor
4 files changed, 160 insertions(+), 244 deletions(-)
  • +2 -3
    Beremiz.py
  • +0 -127
    BeremizIDE.py
  • +4 -114
    PLCOpenEditor.py
  • +154 -0
    util/ExceptionHandler.py
    • --- a/Beremiz.py Fri Aug 25 12:23:45 2017 +0300
    +++ b/Beremiz.py Fri Aug 25 14:01:44 2017 +0300
    @@ -175,9 +175,8 @@
    def InstallExceptionHandler(self):
    import version
    - import tempfile
    - logpath = tempfile.gettempdir()+os.sep+'Beremiz'
    - BeremizIDE.AddExceptHook(logpath, version.app_version)
    + import util.ExceptionHandler
    + util.ExceptionHandler.AddExceptHook(version.app_version)
    def ShowUI(self):
    self.frame = BeremizIDE.Beremiz(None, self.projectOpen, self.buildpath)
    --- a/BeremizIDE.py Fri Aug 25 12:23:45 2017 +0300
    +++ b/BeremizIDE.py Fri Aug 25 14:01:44 2017 +0300
    @@ -41,11 +41,8 @@
    import types
    import time
    import re
    -import platform
    import time
    -import traceback
    import commands
    -import threading
    from threading import Lock, Timer, currentThread
    from time import time as gettime
    @@ -1106,127 +1103,3 @@
    viewer.AddHighlight(infos[1:], start, end, highlight_type)
    else:
    IDEFrame.ShowHighlight(self, infos, start, end, highlight_type)
    -
    -
    -# -------------------------------------------------------------------------------
    -# Exception Handler
    -# -------------------------------------------------------------------------------
    -
    -Max_Traceback_List_Size = 20
    -
    -
    -def Display_Exception_Dialog(e_type, e_value, e_tb, bug_report_path):
    - trcbck_lst = []
    - for i, line in enumerate(traceback.extract_tb(e_tb)):
    - trcbck = " " + str(i+1) + ". "
    - if line[0].find(os.getcwd()) == -1:
    - trcbck += "file : " + str(line[0]) + ", "
    - else:
    - trcbck += "file : " + str(line[0][len(os.getcwd()):]) + ", "
    - trcbck += "line : " + str(line[1]) + ", " + "function : " + str(line[2])
    - trcbck_lst.append(trcbck)
    -
    - # Allow clicking....
    - cap = wx.Window_GetCapture()
    - if cap:
    - cap.ReleaseMouse()
    -
    - dlg = wx.SingleChoiceDialog(
    - None,
    - _("""
    -An unhandled exception (bug) occured. Bug report saved at :
    -(%s)
    -
    -Please be kind enough to send this file to:
    -beremiz-devel@lists.sourceforge.net
    -
    -You should now restart program.
    -
    -Traceback:
    -""") % bug_report_path +
    - repr(e_type) + " : " + repr(e_value),
    - _("Error"),
    - trcbck_lst)
    - try:
    - res = (dlg.ShowModal() == wx.ID_OK)
    - finally:
    - dlg.Destroy()
    -
    - return res
    -
    -
    -def get_last_traceback(tb):
    - while tb.tb_next:
    - tb = tb.tb_next
    - return tb
    -
    -
    -def format_namespace(d, indent=' '):
    - return '\n'.join(['%s%s: %s' % (indent, k, repr(v)[:10000]) for k, v in d.iteritems()])
    -
    -
    -ignored_exceptions = [] # a problem with a line in a module is only reported once per session
    -
    -
    -def AddExceptHook(path, app_version='[No version]'):
    -
    - def save_bug_report(e_type, e_value, e_traceback, bug_report_path, date):
    - info = {
    - 'app-title': wx.GetApp().GetAppName(),
    - 'app-version': app_version,
    - 'wx-version': wx.VERSION_STRING,
    - 'wx-platform': wx.Platform,
    - 'python-version': platform.python_version(),
    - 'platform': platform.platform(),
    - 'e-type': e_type,
    - 'e-value': e_value,
    - 'date': date,
    - 'cwd': os.getcwd(),
    - }
    - if e_traceback:
    - info['traceback'] = ''.join(traceback.format_tb(e_traceback)) + '%s: %s' % (e_type, e_value)
    - last_tb = get_last_traceback(e_traceback)
    - exception_locals = last_tb.tb_frame.f_locals # the locals at the level of the stack trace where the exception actually occurred
    - info['locals'] = format_namespace(exception_locals)
    - if 'self' in exception_locals:
    - try:
    - info['self'] = format_namespace(exception_locals['self'].__dict__)
    - except Exception:
    - pass
    - if not os.path.exists(path):
    - os.mkdir(path)
    - output = open(bug_report_path, 'w')
    - lst = info.keys()
    - lst.sort()
    - for a in lst:
    - output.write(a + ":\n" + str(info[a]) + "\n\n")
    - output.close()
    -
    - def handle_exception(e_type, e_value, e_traceback):
    - traceback.print_exception(e_type, e_value, e_traceback) # this is very helpful when there's an exception in the rest of this func
    - last_tb = get_last_traceback(e_traceback)
    - ex = (last_tb.tb_frame.f_code.co_filename, last_tb.tb_frame.f_lineno)
    - if ex not in ignored_exceptions:
    - ignored_exceptions.append(ex)
    - date = time.ctime()
    - bug_report_path = path + os.sep + "bug_report_" + time.strftime("%Y_%m_%d__%H-%M-%S") + ".txt"
    - save_bug_report(e_type, e_value, e_traceback, bug_report_path, date)
    - Display_Exception_Dialog(e_type, e_value, e_traceback, bug_report_path)
    - # sys.excepthook = lambda *args: wx.CallAfter(handle_exception, *args)
    - sys.excepthook = handle_exception
    -
    - init_old = threading.Thread.__init__
    -
    - def init(self, *args, **kwargs):
    - init_old(self, *args, **kwargs)
    - run_old = self.run
    -
    - def run_with_except_hook(*args, **kw):
    - try:
    - run_old(*args, **kw)
    - except (KeyboardInterrupt, SystemExit):
    - raise
    - except Exception:
    - sys.excepthook(*sys.exc_info())
    - self.run = run_with_except_hook
    - threading.Thread.__init__ = init
    --- a/PLCOpenEditor.py Fri Aug 25 12:23:45 2017 +0300
    +++ b/PLCOpenEditor.py Fri Aug 25 14:01:44 2017 +0300
    @@ -26,17 +26,15 @@
    import wx
    import os
    import sys
    -import platform
    -import time
    -import traceback
    import getopt
    +
    import version
    import util.paths as paths
    +import util.ExceptionHandler
    beremiz_dir = paths.AbsDir(__file__)
    -__version__ = "$Revision: 1.130 $"
    if __name__ == '__main__':
    # Usage message displayed when help request or when error detected in
    @@ -79,7 +77,7 @@
    # these imports require wx.GetApp to return
    # a valid application instance
    - from docutil import *
    +
    from IDEFrame import IDEFrame, AppendMenu
    from IDEFrame import \
    TITLE, \
    @@ -415,121 +413,13 @@
    self._Refresh(TITLE, FILEMENU, PAGETITLES)
    dialog.Destroy()
    -# -------------------------------------------------------------------------------
    -# Exception Handler
    -# -------------------------------------------------------------------------------
    -
    -
    -Max_Traceback_List_Size = 20
    -
    -
    -def Display_Exception_Dialog(e_type, e_value, e_tb):
    - trcbck_lst = []
    - for i, line in enumerate(traceback.extract_tb(e_tb)):
    - trcbck = " " + str(i+1) + _(". ")
    - if line[0].find(os.getcwd()) == -1:
    - trcbck += _("file : ") + str(line[0]) + _(", ")
    - else:
    - trcbck += _("file : ") + str(line[0][len(os.getcwd()):]) + _(", ")
    - trcbck += _("line : ") + str(line[1]) + _(", ") + _("function : ") + str(line[2])
    - trcbck_lst.append(trcbck)
    -
    - # Allow clicking....
    - cap = wx.Window_GetCapture()
    - if cap:
    - cap.ReleaseMouse()
    -
    - dlg = wx.SingleChoiceDialog(
    - None,
    - _("""
    -An unhandled exception (bug) occured. Bug report saved at :
    -(%s)
    -
    -Please be kind enough to send this file to:
    -beremiz-devel@lists.sourceforge.net
    -
    -You should now restart program.
    -
    -Traceback:
    -""") % bug_report_path +
    - repr(e_type) + " : " + repr(e_value),
    - _("Error"),
    - trcbck_lst)
    - try:
    - res = (dlg.ShowModal() == wx.ID_OK)
    - finally:
    - dlg.Destroy()
    -
    - return res
    -
    -
    -def Display_Error_Dialog(e_value):
    - message = wx.MessageDialog(None, str(e_value), _("Error"), wx.OK | wx.ICON_ERROR)
    - message.ShowModal()
    - message.Destroy()
    -
    -
    -def get_last_traceback(tb):
    - while tb.tb_next:
    - tb = tb.tb_next
    - return tb
    -
    -
    -def format_namespace(d, indent=' '):
    - return '\n'.join(['%s%s: %s' % (indent, k, repr(v)[:10000]) for k, v in d.iteritems()])
    -
    -
    -ignored_exceptions = [] # a problem with a line in a module is only reported once per session
    -
    -
    -def AddExceptHook(path, app_version='[No version]'):
    -
    - def handle_exception(e_type, e_value, e_traceback):
    - traceback.print_exception(e_type, e_value, e_traceback) # this is very helpful when there's an exception in the rest of this func
    - last_tb = get_last_traceback(e_traceback)
    - ex = (last_tb.tb_frame.f_code.co_filename, last_tb.tb_frame.f_lineno)
    - if str(e_value).startswith("!!!"):
    - Display_Error_Dialog(e_value)
    - elif ex not in ignored_exceptions:
    - result = Display_Exception_Dialog(e_type, e_value, e_traceback)
    - if result:
    - ignored_exceptions.append(ex)
    - info = {
    - 'app-title': wx.GetApp().GetAppName(),
    - 'app-version': app_version,
    - 'wx-version': wx.VERSION_STRING,
    - 'wx-platform': wx.Platform,
    - 'python-version': platform.python_version(),
    - 'platform': platform.platform(),
    - 'e-type': e_type,
    - 'e-value': e_value,
    - 'date': time.ctime(),
    - 'cwd': os.getcwd(),
    - }
    - if e_traceback:
    - info['traceback'] = ''.join(traceback.format_tb(e_traceback)) + '%s: %s' % (e_type, e_value)
    - last_tb = get_last_traceback(e_traceback)
    - exception_locals = last_tb.tb_frame.f_locals # the locals at the level of the stack trace where the exception actually occurred
    - info['locals'] = format_namespace(exception_locals)
    - if 'self' in exception_locals:
    - info['self'] = format_namespace(exception_locals['self'].__dict__)
    -
    - output = open(path+os.sep+"bug_report_"+time.strftime("%Y_%m_%d__%H-%M-%S")+".txt", 'w')
    - lst = info.keys()
    - lst.sort()
    - for a in lst:
    - output.write(a+":\n"+str(info[a])+"\n\n")
    -
    - # sys.excepthook = lambda *args: wx.CallAfter(handle_exception, *args)
    - sys.excepthook = handle_exception
    -
    if __name__ == '__main__':
    if wx.VERSION < (3, 0, 0):
    wx.InitAllImageHandlers()
    # Install a exception handle for bug reports
    - AddExceptHook(os.getcwd(), version.app_version)
    + util.ExceptionHandler.AddExceptHook(version.app_version)
    frame = PLCOpenEditor(None, fileOpen=fileOpen)
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/util/ExceptionHandler.py Fri Aug 25 14:01:44 2017 +0300
    @@ -0,0 +1,154 @@
    +#!/usr/bin/env python
    +# -*- coding: utf-8 -*-
    +
    +# This file is part of Beremiz, a Integrated Development Environment for
    +# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.
    +#
    +# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
    +# Copyright (C) 2016-2017: Andrey Skvortsov <andrej.skvortzov@gmail.com>
    +#
    +# See COPYING file for copyrights details.
    +#
    +# 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 the Free Software Foundation; either version 2
    +# of the License, or (at your option) any later version.
    +#
    +# This program is distributed in the hope that it will be useful,
    +# but WITHOUT ANY WARRANTY; without even the implied warranty of
    +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    +# GNU General Public License for more details.
    +#
    +# You should have received a copy of the GNU General Public License
    +# along with this program; if not, write to the Free Software
    +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
    +
    +import os
    +import sys
    +import time
    +import tempfile
    +import platform
    +import traceback
    +import threading
    +import wx
    +
    +Max_Traceback_List_Size = 20
    +
    +
    +def Display_Exception_Dialog(e_type, e_value, e_tb, bug_report_path):
    + trcbck_lst = []
    + for i, line in enumerate(traceback.extract_tb(e_tb)):
    + trcbck = " " + str(i+1) + ". "
    + if line[0].find(os.getcwd()) == -1:
    + trcbck += "file : " + str(line[0]) + ", "
    + else:
    + trcbck += "file : " + str(line[0][len(os.getcwd()):]) + ", "
    + trcbck += "line : " + str(line[1]) + ", " + "function : " + str(line[2])
    + trcbck_lst.append(trcbck)
    +
    + # Allow clicking....
    + cap = wx.Window_GetCapture()
    + if cap:
    + cap.ReleaseMouse()
    +
    + dlg = wx.SingleChoiceDialog(
    + None,
    + _("""
    +An unhandled exception (bug) occured. Bug report saved at :
    +(%s)
    +
    +Please be kind enough to send this file to:
    +beremiz-devel@lists.sourceforge.net
    +
    +You should now restart program.
    +
    +Traceback:
    +""") % bug_report_path +
    + repr(e_type) + " : " + repr(e_value),
    + _("Error"),
    + trcbck_lst)
    + try:
    + res = (dlg.ShowModal() == wx.ID_OK)
    + finally:
    + dlg.Destroy()
    +
    + return res
    +
    +
    +def get_last_traceback(tb):
    + while tb.tb_next:
    + tb = tb.tb_next
    + return tb
    +
    +
    +def format_namespace(d, indent=' '):
    + return '\n'.join(['%s%s: %s' % (indent, k, repr(v)[:10000]) for k, v in d.iteritems()])
    +
    +
    +ignored_exceptions = [] # a problem with a line in a module is only reported once per session
    +
    +
    +def AddExceptHook(app_version='[No version]'):
    +
    + def save_bug_report(e_type, e_value, e_traceback, bug_report_path, date):
    + info = {
    + 'app-title': wx.GetApp().GetAppName(),
    + 'app-version': app_version,
    + 'wx-version': wx.VERSION_STRING,
    + 'wx-platform': wx.Platform,
    + 'python-version': platform.python_version(),
    + 'platform': platform.platform(),
    + 'e-type': e_type,
    + 'e-value': e_value,
    + 'date': date,
    + 'cwd': os.getcwd(),
    + }
    + if e_traceback:
    + info['traceback'] = ''.join(traceback.format_tb(e_traceback)) + '%s: %s' % (e_type, e_value)
    + last_tb = get_last_traceback(e_traceback)
    + exception_locals = last_tb.tb_frame.f_locals # the locals at the level of the stack trace where the exception actually occurred
    + info['locals'] = format_namespace(exception_locals)
    + if 'self' in exception_locals:
    + try:
    + info['self'] = format_namespace(exception_locals['self'].__dict__)
    + except Exception:
    + pass
    + path = os.path.dirname(bug_report_path)
    + if not os.path.exists(path):
    + os.mkdir(path)
    + output = open(bug_report_path, 'w')
    + lst = info.keys()
    + lst.sort()
    + for a in lst:
    + output.write(a + ":\n" + str(info[a]) + "\n\n")
    + output.close()
    +
    + def handle_exception(e_type, e_value, e_traceback):
    + traceback.print_exception(e_type, e_value, e_traceback) # this is very helpful when there's an exception in the rest of this func
    + last_tb = get_last_traceback(e_traceback)
    + ex = (last_tb.tb_frame.f_code.co_filename, last_tb.tb_frame.f_lineno)
    + if ex not in ignored_exceptions:
    + ignored_exceptions.append(ex)
    + date = time.ctime()
    + path = tempfile.gettempdir()+os.sep+wx.GetApp().GetAppName()
    + bug_report_path = path + os.sep + "bug_report_" + time.strftime("%Y_%m_%d__%H-%M-%S") + ".txt"
    + save_bug_report(e_type, e_value, e_traceback, bug_report_path, date)
    + Display_Exception_Dialog(e_type, e_value, e_traceback, bug_report_path)
    + # sys.excepthook = lambda *args: wx.CallAfter(handle_exception, *args)
    + sys.excepthook = handle_exception
    +
    + init_old = threading.Thread.__init__
    +
    + def init(self, *args, **kwargs):
    + init_old(self, *args, **kwargs)
    + run_old = self.run
    +
    + def run_with_except_hook(*args, **kw):
    + try:
    + run_old(*args, **kw)
    + except (KeyboardInterrupt, SystemExit):
    + raise
    + except Exception:
    + sys.excepthook(*sys.exc_info())
    + self.run = run_with_except_hook
    + threading.Thread.__init__ = init