__init__.py

# -*- coding: utf-8 -*-
"""
/***************************************************************************
 DebugVS
                                 A QGIS plugin
 Plugin to connect Visual Studio Remote Debugger
                             -------------------
        begin                : 2018-10-16
        copyright            : (C) 2018 by Luiz Motta
        email                : motta.luiz@gmail.com

/***************************************************************************
 *                                                                         *
 *   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 script initializes the plugin, making it known to QGIS.
"""

__author__ = "Luiz Motta"
__date__ = "2018-10-16"
__copyright__ = "(C) 2018, Luiz Motta"
__revision__ = "$Format:%H$"


import os
import sys
import runpy

from qgis.core import QgsApplication
from qgis.PyQt.QtCore import QObject, pyqtSlot
from qgis.PyQt.QtGui import QIcon
from qgis.PyQt.QtWidgets import QAction, QFileDialog, QMenu, QToolButton


def getQGisPythonPath():
    if sys.platform.startswith('linux'):
        return sys.executable
    
    pythonExec = os.path.dirname( sys.executable )
    pythonExec += '\\python3' if sys.platform == 'win32' else '/bin/python3'
    return pythonExec

def classFactory(iface):
    return DebugVSPlugin(iface)


class DebugVSPlugin(QObject):
    def __init__(self, iface):
        super().__init__()
        self.iface = iface
        self.debugpy = None
        try:
            import debugpy

            self.debugpy = debugpy
            self.debugpy.configure(python=getQGisPythonPath())
            self.debugpy._already_listening = False
        except:
            pass
        self.port = 5678
        if os.environ.get("RUN_IN_DOCKER"):
            self.host = "0.0.0.0"
        else:
            self.host = "localhost"
        self.actionsScript = []

        self.toolButton = QToolButton()
        self.toolButton.setMenu(QMenu())
        self.toolButton.setPopupMode(QToolButton.MenuButtonPopup)
        self.toolBtnAction = self.iface.addToolBarWidget(self.toolButton)

        self.msgBar = iface.messageBar()
        self.pluginName = 'DebugVS'
        self.nameActionEnable = 'Enable Visual Studio Debugging'
        self.action = None

        if not hasattr(sys, "argv"):
            sys.argv = []
        
        self.msg_debug = f'"type": "debugpy", "request": "attach", "host": "{self.host}", "port": {self.port}'
        self.msg_vs = 'Visual Studio Remote Debugging'

    def initGui(self):
        # Action Run
        icon = QIcon(os.path.join(os.path.dirname(__file__), "code.svg"))
        self.actionEnable = QAction(icon, self.nameActionEnable, self.iface.mainWindow())
        self.actionEnable.setToolTip(self.nameActionEnable)
        self.actionEnable.triggered.connect(self.enable)
        self.iface.addPluginToMenu(f"&{self.nameActionEnable}", self.actionEnable)
        # Action Load Script
        title = "Load script"
        icon = QgsApplication.getThemeIcon("mActionScriptOpen.svg")
        self.actionLoad = QAction(icon, title, self.iface.mainWindow())
        self.actionLoad.setToolTip(title)
        self.actionLoad.triggered.connect(self.load)
        self.iface.addPluginToMenu(f"&{self.nameActionEnable}", self.actionLoad)
        #
        m = self.toolButton.menu()
        m.addAction(self.actionEnable)
        m.addAction(self.actionLoad)
        self.toolButton.setDefaultAction(self.actionEnable)

    def unload(self):
        for action in [self.actionEnable, self.actionLoad] + self.actionsScript:
            self.iface.removePluginMenu(f"&{self.nameActionEnable}", action)
            self.iface.removeToolBarIcon(action)
            self.iface.unregisterMainWindowAction(action)

        self.iface.removeToolBarIcon(self.toolBtnAction)

    def _addActionScript(self, filename):
        icon = QgsApplication.getThemeIcon("processingScript.svg")
        title = os.path.split(filename)[-1]
        action = QAction(icon, title, self.iface.mainWindow())
        action.setToolTip(filename)
        action.triggered.connect(self.run)
        m = self.toolButton.menu()
        m.addAction(action)

        self.actionsScript.append(action)

    def _existsActionScript(self, filename):
        filenames = [a.toolTip() for a in self.actionsScript]
        return filename in filenames

    def _checkEnable(self):
        if not self.debugpy.is_client_connected():
            self.msgBar.popWidget()
            msg = f"{self.nameActionEnable} (this plugin) AND Start {self.msg_vs}({self.msg_debug})"
            self.msgBar.pushWarning(self.pluginName, msg)
            return False
        return True

    def _debugFile(self, filepath):
        if not self._checkEnable():
            return

        self.debugpy.wait_for_client()
        runpy.run_path( filepath, run_name='__main__' )

        # with open(filepath, 'r') as f:
        #     exec( f.read() )

    @pyqtSlot(bool)
    def enable(self, checked):
        self.msgBar.popWidget()
        if self.debugpy is None:
            self.msgBar.pushCritical(self.pluginName, "Need to install debugpy: pip3 install debugpy")
            return

        if self.debugpy.is_client_connected():
            self.msgBar.pushWarning(self.pluginName, f"QGIS is already set up for {self.msg_vs}({self.msg_debug})")
            return

        if self.debugpy._already_listening:
            self.msgBar.pushWarning(self.pluginName, f"Start {self.msg_vs}({self.msg_debug})")
            return

        t_, self.port = self.debugpy.listen((self.host, self.port))
        self.debugpy._already_listening = True
        self.msgBar.pushInfo(self.pluginName, f"QGIS is ready for {self.msg_vs}({self.msg_debug})")

    @pyqtSlot(bool)
    def load(self, checked):
        if not self._checkEnable():
            return

        filepath, _ = QFileDialog.getOpenFileName(None, "Debug script", "", "Python Files (*.py)")
        if not filepath:
            return

        self._debugFile( filepath )

        if not self._existsActionScript(filepath):
            self._addActionScript(filepath)

    @pyqtSlot(bool)
    def run(self, checked):
        action = self.sender()
        filepath = action.toolTip()

        self._debugFile( filepath )