mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-31 00:06:02 -04:00
262 lines
11 KiB
Python
262 lines
11 KiB
Python
# -*- coding:utf-8 -*-
|
|
"""
|
|
/***************************************************************************
|
|
Python Console for QGIS
|
|
-------------------
|
|
begin : 2012-09-10
|
|
copyright : (C) 2012 by Salvatore Larosa
|
|
email : lrssvtml (at) gmail (dot) 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. *
|
|
* *
|
|
***************************************************************************/
|
|
Some portions of code were taken from https://code.google.com/p/pydee/
|
|
"""
|
|
|
|
from qgis.PyQt.QtCore import Qt, QCoreApplication, QThread, QMetaObject, Q_RETURN_ARG, Q_ARG, QObject, pyqtSlot
|
|
from qgis.PyQt.QtGui import QColor, QFont, QKeySequence, QFontDatabase
|
|
from qgis.PyQt.QtWidgets import QGridLayout, QSpacerItem, QSizePolicy, QShortcut, QMenu, QApplication
|
|
from qgis.PyQt.Qsci import QsciScintilla
|
|
from qgis.core import Qgis, QgsApplication, QgsSettings
|
|
from qgis.gui import QgsMessageBar, QgsCodeEditorPython
|
|
import sys
|
|
|
|
|
|
class writeOut(QObject):
|
|
ERROR_COLOR = "#e31a1c"
|
|
|
|
def __init__(self, shellOut, out=None, style=None):
|
|
"""
|
|
This class allows writing to stdout and stderr
|
|
"""
|
|
super().__init__()
|
|
self.sO = shellOut
|
|
self.out = None
|
|
self.style = style
|
|
self.fire_keyboard_interrupt = False
|
|
|
|
@pyqtSlot(str)
|
|
def write(self, m):
|
|
|
|
# This manage the case when console is called from another thread
|
|
if QThread.currentThread() != QCoreApplication.instance().thread():
|
|
QMetaObject.invokeMethod(self, "write", Qt.QueuedConnection, Q_ARG(str, m))
|
|
return
|
|
|
|
if self.style == "_traceback":
|
|
# Show errors in red
|
|
stderrColor = QColor(self.sO.settings.value("pythonConsole/stderrFontColor", QColor(self.ERROR_COLOR)))
|
|
self.sO.SendScintilla(QsciScintilla.SCI_STYLESETFORE, 0o01, stderrColor)
|
|
self.sO.SendScintilla(QsciScintilla.SCI_STYLESETITALIC, 0o01, True)
|
|
self.sO.SendScintilla(QsciScintilla.SCI_STYLESETBOLD, 0o01, True)
|
|
pos = self.sO.SendScintilla(QsciScintilla.SCI_GETCURRENTPOS)
|
|
self.sO.SendScintilla(QsciScintilla.SCI_STARTSTYLING, pos, 31)
|
|
self.sO.append(m)
|
|
self.sO.SendScintilla(QsciScintilla.SCI_SETSTYLING, len(m), 0o01)
|
|
else:
|
|
self.sO.append(m)
|
|
|
|
if self.out:
|
|
self.out.write(m)
|
|
|
|
self.move_cursor_to_end()
|
|
|
|
if self.style != "_traceback":
|
|
self.sO.repaint()
|
|
|
|
if self.fire_keyboard_interrupt:
|
|
self.fire_keyboard_interrupt = False
|
|
raise KeyboardInterrupt
|
|
|
|
def move_cursor_to_end(self):
|
|
"""Move cursor to end of text"""
|
|
line, index = self.get_end_pos()
|
|
self.sO.setCursorPosition(line, index)
|
|
self.sO.ensureCursorVisible()
|
|
self.sO.ensureLineVisible(line)
|
|
|
|
def get_end_pos(self):
|
|
"""Return (line, index) position of the last character"""
|
|
line = self.sO.lines() - 1
|
|
return (line, len(self.sO.text(line)))
|
|
|
|
def flush(self):
|
|
pass
|
|
|
|
def isatty(self):
|
|
return False
|
|
|
|
|
|
class ShellOutputScintilla(QgsCodeEditorPython):
|
|
|
|
def __init__(self, parent=None):
|
|
super().__init__(parent)
|
|
self.parent = parent
|
|
self.shell = self.parent.shell
|
|
|
|
self.settings = QgsSettings()
|
|
|
|
# Creates layout for message bar
|
|
self.layout = QGridLayout(self)
|
|
self.layout.setContentsMargins(0, 0, 0, 0)
|
|
spacerItem = QSpacerItem(20, 40, QSizePolicy.Minimum, QSizePolicy.Expanding)
|
|
self.layout.addItem(spacerItem, 1, 0, 1, 1)
|
|
# messageBar instance
|
|
self.infoBar = QgsMessageBar()
|
|
sizePolicy = QSizePolicy(QSizePolicy.Minimum, QSizePolicy.Fixed)
|
|
self.infoBar.setSizePolicy(sizePolicy)
|
|
self.layout.addWidget(self.infoBar, 0, 0, 1, 1)
|
|
|
|
sys.stdout = writeOut(self, sys.stdout)
|
|
sys.stderr = writeOut(self, sys.stderr, "_traceback")
|
|
|
|
self.insertInitText()
|
|
self.refreshSettingsOutput()
|
|
|
|
self.setMinimumHeight(120)
|
|
|
|
self.setWrapMode(QsciScintilla.WrapCharacter)
|
|
self.SendScintilla(QsciScintilla.SCI_SETHSCROLLBAR, 0)
|
|
|
|
self.runScut = QShortcut(QKeySequence(Qt.CTRL + Qt.Key_E), self)
|
|
self.runScut.setContext(Qt.WidgetShortcut)
|
|
self.runScut.activated.connect(self.enteredSelected)
|
|
# Reimplemented copy action to prevent paste prompt (>>>,...) in command view
|
|
self.copyShortcut = QShortcut(QKeySequence.Copy, self)
|
|
self.copyShortcut.setContext(Qt.WidgetWithChildrenShortcut)
|
|
self.copyShortcut.activated.connect(self.copy)
|
|
self.selectAllShortcut = QShortcut(QKeySequence.SelectAll, self)
|
|
self.selectAllShortcut.setContext(Qt.WidgetWithChildrenShortcut)
|
|
self.selectAllShortcut.activated.connect(self.selectAll)
|
|
|
|
def insertInitText(self):
|
|
txtInit = QCoreApplication.translate("PythonConsole",
|
|
"Python Console\n"
|
|
"Use iface to access QGIS API interface or type help(iface) for more info\n"
|
|
"Security warning: typing commands from an untrusted source can harm your computer")
|
|
|
|
txtInit = '\n'.join(['# ' + line for line in txtInit.split('\n')])
|
|
|
|
# some translation string for the console header ends without '\n'
|
|
# and the first command in console will be appended at the header text.
|
|
# The following code add a '\n' at the end of the string if not present.
|
|
if txtInit.endswith('\n'):
|
|
self.setText(txtInit)
|
|
else:
|
|
self.setText(txtInit + '\n')
|
|
|
|
def initializeLexer(self):
|
|
super().initializeLexer()
|
|
self.setFoldingVisible(False)
|
|
self.setEdgeMode(QsciScintilla.EdgeNone)
|
|
|
|
def refreshSettingsOutput(self):
|
|
# Set Python lexer
|
|
self.initializeLexer()
|
|
self.setReadOnly(True)
|
|
|
|
self.setCaretWidth(0) # NO (blinking) caret in the output
|
|
|
|
def clearConsole(self):
|
|
self.setText('')
|
|
self.insertInitText()
|
|
self.shell.setFocus()
|
|
|
|
def contextMenuEvent(self, e):
|
|
menu = QMenu(self)
|
|
menu.addAction(QgsApplication.getThemeIcon("console/iconHideToolConsole.svg"),
|
|
QCoreApplication.translate("PythonConsole", "Hide/Show Toolbar"),
|
|
self.hideToolBar)
|
|
menu.addSeparator()
|
|
showEditorAction = menu.addAction(
|
|
QgsApplication.getThemeIcon("console/iconShowEditorConsole.svg"),
|
|
QCoreApplication.translate("PythonConsole", "Show Editor"),
|
|
self.showEditor)
|
|
menu.addSeparator()
|
|
runAction = menu.addAction(QgsApplication.getThemeIcon("console/mIconRunConsole.svg"),
|
|
QCoreApplication.translate("PythonConsole", "Enter Selected"),
|
|
self.enteredSelected,
|
|
QKeySequence(Qt.CTRL + Qt.Key_E))
|
|
clearAction = menu.addAction(QgsApplication.getThemeIcon("console/iconClearConsole.svg"),
|
|
QCoreApplication.translate("PythonConsole", "Clear Console"),
|
|
self.clearConsole)
|
|
pyQGISHelpAction = menu.addAction(QgsApplication.getThemeIcon("console/iconHelpConsole.svg"),
|
|
QCoreApplication.translate("PythonConsole", "Search Selected in PyQGIS docs"),
|
|
self.searchSelectedTextInPyQGISDocs)
|
|
menu.addSeparator()
|
|
copyAction = menu.addAction(
|
|
QgsApplication.getThemeIcon("mActionEditCopy.svg"),
|
|
QCoreApplication.translate("PythonConsole", "Copy"),
|
|
self.copy, QKeySequence.Copy)
|
|
selectAllAction = menu.addAction(
|
|
QCoreApplication.translate("PythonConsole", "Select All"),
|
|
self.selectAll, QKeySequence.SelectAll)
|
|
menu.addSeparator()
|
|
menu.addAction(QgsApplication.getThemeIcon("console/iconSettingsConsole.svg"),
|
|
QCoreApplication.translate("PythonConsole", "Options…"),
|
|
self.parent.openSettings)
|
|
runAction.setEnabled(False)
|
|
clearAction.setEnabled(False)
|
|
copyAction.setEnabled(False)
|
|
pyQGISHelpAction.setEnabled(False)
|
|
selectAllAction.setEnabled(False)
|
|
showEditorAction.setEnabled(True)
|
|
if self.hasSelectedText():
|
|
runAction.setEnabled(True)
|
|
copyAction.setEnabled(True)
|
|
pyQGISHelpAction.setEnabled(True)
|
|
if not self.text(3) == '':
|
|
selectAllAction.setEnabled(True)
|
|
clearAction.setEnabled(True)
|
|
if self.parent.tabEditorWidget.isVisible():
|
|
showEditorAction.setEnabled(False)
|
|
menu.exec_(self.mapToGlobal(e.pos()))
|
|
|
|
def hideToolBar(self):
|
|
tB = self.parent.toolBar
|
|
tB.hide() if tB.isVisible() else tB.show()
|
|
self.shell.setFocus()
|
|
|
|
def showEditor(self):
|
|
Ed = self.parent.splitterObj
|
|
if not Ed.isVisible():
|
|
Ed.show()
|
|
self.parent.showEditorButton.setChecked(True)
|
|
self.shell.setFocus()
|
|
|
|
def copy(self):
|
|
"""Copy text to clipboard... or keyboard interrupt"""
|
|
if self.hasSelectedText():
|
|
text = self.selectedText()
|
|
text = text.replace('>>> ', '').replace('... ', '').strip() # removing prompts
|
|
QApplication.clipboard().setText(text)
|
|
else:
|
|
raise KeyboardInterrupt
|
|
|
|
def enteredSelected(self):
|
|
cmd = self.selectedText()
|
|
self.shell.insertFromDropPaste(cmd)
|
|
self.shell.entered()
|
|
|
|
def keyPressEvent(self, e):
|
|
# empty text indicates possible shortcut key sequence so stay in output
|
|
txt = e.text()
|
|
if len(txt) and txt >= " ":
|
|
self.shell.append(txt)
|
|
self.shell.move_cursor_to_end()
|
|
self.shell.setFocus()
|
|
e.ignore()
|
|
else:
|
|
# possible shortcut key sequence, accept it
|
|
e.accept()
|
|
|
|
def widgetMessageBar(self, iface, text):
|
|
timeout = iface.messageTimeout()
|
|
self.infoBar.pushMessage(text, Qgis.Info, timeout)
|