1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
# -*- coding: utf-8 -*-
"""
Contains the quick documentation panel
"""
from docutils.core import publish_parts
from pyqode.core import icons
from pyqode.qt import QtCore, QtWidgets
from pyqode.core.api import Panel, TextHelper
from pyqode.python.backend.workers import quick_doc
class QuickDocPanel(Panel):
""" Shows the python documentation for the word under the text cursor.
This panel quickly shows the documentation of the symbol under
cursor.
"""
_KEYS = ['panelBackground', 'background', 'panelForeground',
'panelHighlight']
def __init__(self):
super(QuickDocPanel, self).__init__(dynamic=True)
# layouts
layout = QtWidgets.QHBoxLayout()
self.setLayout(layout)
child_layout = QtWidgets.QVBoxLayout()
# A QTextEdit to show the doc
self.text_edit = QtWidgets.QTextEdit()
self.text_edit.setReadOnly(True)
self.text_edit.setAcceptRichText(True)
layout.addWidget(self.text_edit)
# A QPushButton (inside a child layout for a better alignment)
# to close the panel
self.bt_close = QtWidgets.QPushButton()
self.bt_close.setIcon(icons.icon(
'window-close', ':/pyqode-icons/rc/close.png', 'fa.close'))
self.bt_close.setIconSize(QtCore.QSize(16, 16))
self.bt_close.clicked.connect(self.hide)
child_layout.addWidget(self.bt_close)
child_layout.addStretch()
layout.addLayout(child_layout)
# Action
self.action_quick_doc = QtWidgets.QAction(
_('Show documentation'), self)
self.action_quick_doc.setShortcut('Alt+Q')
icon = icons.icon(qta_name='fa.book')
if icon:
self.action_quick_doc.setIcon(icon)
self.action_quick_doc.triggered.connect(
self._on_action_quick_doc_triggered)
def on_install(self, editor):
super(QuickDocPanel, self).on_install(editor)
self.setVisible(False)
def on_state_changed(self, state):
super(QuickDocPanel, self).on_state_changed(state)
if state:
self.editor.add_action(self.action_quick_doc, sub_menu='Python')
else:
self.editor.remove_action(self.action_quick_doc, sub_menu='Python')
def _on_action_quick_doc_triggered(self):
tc = TextHelper(self.editor).word_under_cursor(select_whole_word=True)
request_data = {
'code': self.editor.toPlainText(),
'line': tc.blockNumber(),
'column': tc.columnNumber(),
'path': self.editor.file.path,
'encoding': self.editor.file.encoding
}
self.editor.backend.send_request(
quick_doc, request_data, on_receive=self._on_results_available)
def _on_results_available(self, results):
self.setVisible(True)
if len(results) and results[0] != '':
string = '\n\n'.join(results)
string = publish_parts(
string, writer_name='html',
settings_overrides={'output_encoding': 'unicode'})[
'html_body']
string = string.replace('colspan="2"', 'colspan="0"')
string = string.replace('<th ', '<th align="left" ')
string = string.replace(
'</tr>\n<tr class="field"><td> </td>', '')
if string:
skip_error_msg = False
lines = []
for l in string.splitlines():
if (l.startswith('<div class="system-message"') or
l.startswith(
'<div class="last system-message"')):
skip_error_msg = True
continue
if skip_error_msg:
if l.endswith('</div>'):
skip_error_msg = False
else:
lines.append(l)
self.text_edit.setText('\n'.join(lines))
return
else:
self.text_edit.setText(_('Documentation not found'))
|
