wing_debug.py

# -*- coding: utf-8 -*-
# Python 3.6 or later




# Examples of resources in Lime/LiR Integ:
# from . import lime
# lime.MsgBoxStyle.YesNoCancel is already defined by Henrik.
# app = lime.get_app()
# app.ActiveExplorer.Class.Name
# app.MenuBar.Menu.Item(8).SubMenu.Item(1).Name
# app.ActiveExplorer.Items.Count
# app.ActiveExplorer.Selection.Count
# app.ActiveExplorer.Selection.Item(1).Value("idparticipant")
# cParticipant = app.Database.Classes.Lookup('participant', constants.lkLookupClassByName)


# instanciated object log must be global so that logging will work
import logging
log = logging.getLogger(__name__)
log.setLevel(logging.DEBUG)    # filter (DEBUG, INFO, WARNING, ERROR)

from pathlib import Path

from . import lime
from . import vba_dialogs

from win32com.shell import shell, shellcon



class Wingdebugger():
    # two use cases:
        # (1) declare an object (debugger) and then destroy it (debugger = None)
        # (2) with Wingdebugger(): ...
    def __init__(self):       # called before __enter__ when used in with statement
        try:
            import wingdbstub    # may cause debugger to start; must be inside class, not global
            wingdbstub.Ensure()   # force debugger start; raises exception if Wingware is not running
        except ImportError:
            pass     #log.exception('Missing wingdbstub on class init')    # not for production
    def __enter__(self):      # used in with statement, try: statement is implicit
        pass
    def __exit__(self, exc_type, exc_value, traceback):   # used in with statement
        if exc_value is not None:
            messagebox(str(exc_value))
            log.exception(str(exc_value))
            try:
                import wingdbstub
                wingdbstub.debugger.ProgramQuit()
            except ImportError:
                pass     #log.exception('Missing wingdbstub on class exit')    # not for production
        return True       # True suppresses exception processing
    def __del__(self):        # called after __exit__ when used in with statement
        try:
            import wingdbstub
            wingdbstub.debugger.ProgramQuit()
        except Exception:
            pass     #log.exception('Missing wingdbstub on class delete')    # not for production
        self.log = None


def get_known_path(key):
    csidl = {'appdata': shellcon.CSIDL_LOCAL_APPDATA,
             'desktop': shellcon.CSIDL_DESKTOPDIRECTORY}[key]
    SHGFP_TYPE_CURRENT = 0
    return Path(shell.SHGetFolderPath(None, csidl, None, SHGFP_TYPE_CURRENT))


def messagebox(message, style=0, *, title="LiR Rapportplugin"):
    return vba_dialogs.messagebox(
        lime.get_app(), message,
        title=title, style=style)


def inputbox(message, title="LiR Rapportplugin", default=None,
             xpos=100, ypos=100):
    return vba_dialogs.inputbox(
        lime.get_app(),
        message, title=title, default=default,
        xpos=xpos, ypos=ypos)