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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
# -*- coding: utf-8 -*-
"""
Contains the go to assignments mode.
"""
import logging
import os
from pyqode.core import icons
from pyqode.qt import QtCore, QtGui, QtWidgets
from pyqode.core.api import Mode, TextHelper, DelayJobRunner, CodeEdit
from pyqode.core.backend import NotRunning
from pyqode.core.modes import WordClickMode
from pyqode.python.backend import workers
def _logger():
return logging.getLogger(__name__)
class Assignment(object):
"""
Defines an assignment. Used by :class:`GoToAssignmentsMode`.
"""
def __init__(self, path, line, column, full_name):
if path:
path = path.replace(".pyc", ".py")
#: File path of the module where the assignment can be found
self.module_path = path
#: Line number
self.line = line
#: Column number
self.column = column
#: Assignement full name
self.full_name = full_name
def __str__(self):
if self.line and self.column:
return "%s (%s, %s)" % (self.full_name, self.line + 1,
self.column + 1)
return self.full_name
def __repr__(self):
return "Definition(%r, %r, %r, %r)" % (self.module_path, self.line,
self.column, self.full_name)
class GoToAssignmentsMode(WordClickMode):
"""
Goes to the assignments (using jedi.Script.goto_assignments) when the user
execute the shortcut or click word. If there are more than one assignments,
an input dialog is used to ask the user to choose the desired assignment.
This mode will emit the :attr:`out_of_doc` signal if the definition can
not be reached in the current document. IDE will typically connects a slot
that open a new editor tab and goes to the definition position.
"""
#: Signal emitted when the definition cannot be reached in the current
#: document
out_of_doc = QtCore.Signal(Assignment)
#: Signal emitted when no results could be found.
no_results_found = QtCore.Signal()
shortcut = 'Alt+F2'
def __init__(self):
super(GoToAssignmentsMode, self).__init__()
self._definitions = []
self._goto_requested = False
self.action_goto = QtWidgets.QAction(_("Go to assignments"), self)
self.action_goto.setShortcut(self.shortcut)
self.action_goto.triggered.connect(self.request_goto)
icon = icons.icon(qta_name='fa.share')
if icon:
self.action_goto.setIcon(icon)
self.word_clicked.connect(self._on_word_clicked)
self._runner = DelayJobRunner(delay=1)
def on_state_changed(self, state):
super(GoToAssignmentsMode, self).on_state_changed(state)
if state:
self.editor.add_action(self.action_goto, sub_menu='Python')
else:
self.editor.remove_action(self.action_goto, sub_menu='Python')
def request_goto(self):
"""
Request a goto action for the word under the text cursor.
"""
self._goto_requested = True
self._check_word_cursor()
def _check_word_cursor(self, tc=None):
"""
Request a go to assignment.
:param tc: Text cursor which contains the text that we must look for
its assignment. Can be None to go to the text that is under
the text cursor.
:type tc: QtGui.QTextCursor
"""
if not tc:
tc = TextHelper(self.editor).word_under_cursor()
request_data = {
'code': self.editor.toPlainText(),
'line': tc.blockNumber(),
'column': tc.columnNumber(),
'path': self.editor.file.path,
'encoding': self.editor.file.encoding
}
try:
self.editor.backend.send_request(
workers.goto_assignments, request_data,
on_receive=self._on_results_available)
except NotRunning:
pass
def _goto(self, definition):
fp = ''
if self.editor.file.path:
fp = os.path.normpath(self.editor.file.path.replace(".pyc", ".py"))
if definition.module_path == fp:
line = definition.line
col = definition.column
_logger().debug("Go to %s" % definition)
self._runner.request_job(
TextHelper(self.editor).goto_line,
line, move=True, column=col)
else:
_logger().debug("Out of doc: %s" % definition)
self.out_of_doc.emit(definition)
def _unique(self, seq):
"""
Not performant but works.
"""
# order preserving
checked = []
for e in seq:
present = False
for c in checked:
if str(c) == str(e):
present = True
break
if not present:
checked.append(e)
return checked
def _clear_selection(self):
super(GoToAssignmentsMode, self)._clear_selection()
self._definitions[:] = []
def _validate_definitions(self, definitions):
if definitions:
if len(definitions) == 1:
return definitions[0].line is not None
return True
return False
def _on_results_available(self, definitions):
_logger().debug("Got %r" % definitions)
definitions = [Assignment(path, line, col, full_name)
for path, line, col, full_name in definitions]
definitions = self._unique(definitions)
self._definitions = definitions
if self._validate_definitions(definitions):
if self._goto_requested:
self._perform_goto(definitions)
else:
self._select_word_cursor()
self.editor.set_mouse_cursor(QtCore.Qt.PointingHandCursor)
else:
self._clear_selection()
self.editor.set_mouse_cursor(QtCore.Qt.IBeamCursor)
self._goto_requested = False
def _perform_goto(self, definitions):
if len(definitions) == 1:
definition = definitions[0]
if definition:
self._goto(definition)
elif len(definitions) > 1:
_logger().debug(
"More than 1 assignments in different modules, user "
"need to make a choice: %s" % definitions)
def_str, result = QtWidgets.QInputDialog.getItem(
self.editor, _("Choose a definition"),
_("Choose the definition you want to go to:"),
[str(d) for d in definitions])
if result:
for definition in definitions:
if definition and str(definition) == def_str:
self._goto(definition)
break
def _on_word_clicked(self):
self._perform_goto(self._definitions)
|
