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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
|
import ast
from typing import List, Optional
from rope.contrib import generate
from rope.refactor import (
extract,
inline,
method_object,
usefunction,
localtofield,
importutils,
introduce_parameter,
)
from pylsp_rope import typing, commands
from pylsp_rope.project import (
WorkspaceEditFormat,
get_project,
get_resource,
get_resources,
apply_rope_changeset,
DEFAULT_WORKSPACE_EDIT_FORMAT,
)
from pylsp_rope.typing import DocumentUri, CodeActionKind
class Command:
name: str
title: str
kind: CodeActionKind
def __init__(self, workspace, **arguments):
self.workspace = workspace
self.arguments = arguments
self.__dict__.update(**arguments)
def __call__(
self,
*,
workspace_edit_format: List[
WorkspaceEditFormat
] = DEFAULT_WORKSPACE_EDIT_FORMAT,
):
rope_changeset = self.get_changes()
if rope_changeset is not None:
apply_rope_changeset(
self.workspace,
rope_changeset,
workspace_edit_format,
)
def get_changes(self):
"""
Calculate the rope changeset to perform this refactoring.
"""
def validate(self, info) -> None:
"""
Override this method to raise an exception if this refactoring command
cannot be performed
"""
def is_valid(self, info):
try:
self.validate(info)
except Exception:
return False
else:
return True
return False
def get_code_action(self, title: str) -> typing.CodeAction:
return {
"title": title,
"kind": self.kind,
"command": {
"title": title,
"command": self.name,
"arguments": [self.arguments],
},
}
@property # FIXME: backport cached_property
def project(self):
if not hasattr(self, "_project"):
self._project = get_project(self.workspace)
return self._project
class CommandRefactorExtractMethod(Command):
name = commands.COMMAND_REFACTOR_EXTRACT_METHOD
kind: CodeActionKind = "refactor.extract"
document_uri: DocumentUri
range: typing.Range
similar: bool
global_: bool
# FIXME: requires rope.refactor.extract._ExceptionalConditionChecker for proper checking
# def _is_valid(self, info):
# ...
def get_changes(self):
current_document, resource = get_resource(self.workspace, self.document_uri)
refactoring = extract.ExtractMethod(
project=self.project,
resource=resource,
start_offset=current_document.offset_at_position(self.range["start"]),
end_offset=current_document.offset_at_position(self.range["end"]),
)
rope_changeset = refactoring.get_changes(
extracted_name="extracted_method",
similar=self.similar,
global_=self.global_,
)
return rope_changeset
@classmethod
def get_code_actions(cls, workspace, document, range):
return {
"Extract method including similar statements": cls(
workspace,
document_uri=document.uri,
range=range,
global_=False,
similar=True,
),
"Extract method": cls(
workspace,
document_uri=document.uri,
range=range,
global_=False,
similar=False,
),
"Extract global method including similar statements": cls(
workspace,
document_uri=document.uri,
range=range,
global_=True,
similar=True,
),
"Extract global method": cls(
workspace,
document_uri=document.uri,
range=range,
global_=True,
similar=False,
),
}
class CommandRefactorExtractVariable(Command):
name = commands.COMMAND_REFACTOR_EXTRACT_VARIABLE
kind: CodeActionKind = "refactor.extract"
document_uri: DocumentUri
range: typing.Range
similar: bool
global_: bool
def validate(self, info):
# FIXME: requires rope.refactor.extract._ExceptionalConditionChecker for proper checking
ast.parse(info.selected_text, mode="eval")
def get_changes(self):
current_document, resource = get_resource(self.workspace, self.document_uri)
refactoring = extract.ExtractVariable(
project=self.project,
resource=resource,
start_offset=current_document.offset_at_position(self.range["start"]),
end_offset=current_document.offset_at_position(self.range["end"]),
)
rope_changeset = refactoring.get_changes(
extracted_name="extracted_variable",
similar=self.similar,
global_=self.global_,
)
return rope_changeset
@classmethod
def get_code_actions(cls, workspace, document, range):
return {
"Extract variable including similar statements": cls(
workspace,
document_uri=document.uri,
range=range,
global_=False,
similar=True,
),
"Extract variable": cls(
workspace,
document_uri=document.uri,
range=range,
global_=False,
similar=False,
),
"Extract global variable including similar statements": cls(
workspace,
document_uri=document.uri,
range=range,
global_=True,
similar=True,
),
"Extract global variable": cls(
workspace,
document_uri=document.uri,
range=range,
global_=True,
similar=False,
),
}
class CommandRefactorInline(Command):
name = commands.COMMAND_REFACTOR_INLINE
kind: CodeActionKind = "refactor.inline"
document_uri: DocumentUri
position: typing.Range
def validate(self, info):
refactoring = inline.create_inline(
project=self.project,
resource=info.resource,
offset=info.current_document.offset_at_position(info.position),
)
rope_changeset = refactoring.get_changes()
if not rope_changeset.changes:
raise Exception("Not offering changeless inline refactor")
def get_changes(self):
current_document, resource = get_resource(self.workspace, self.document_uri)
refactoring = inline.create_inline(
project=self.project,
resource=resource,
offset=current_document.offset_at_position(self.position),
)
rope_changeset = refactoring.get_changes()
return rope_changeset
class CommandRefactorUseFunction(Command):
name = commands.COMMAND_REFACTOR_USE_FUNCTION
kind: CodeActionKind = "refactor"
document_uri: DocumentUri
documents: Optional[List[DocumentUri]] = None
position: typing.Range
def validate(self, info):
usefunction.UseFunction(
project=self.project,
resource=info.resource,
offset=info.current_document.offset_at_position(info.position),
)
def get_changes(self):
current_document, resource = get_resource(self.workspace, self.document_uri)
refactoring = usefunction.UseFunction(
project=self.project,
resource=resource,
offset=current_document.offset_at_position(self.position),
)
resources = (
get_resources(self.workspace, self.documents)
if self.documents is not None
else None
)
rope_changeset = refactoring.get_changes(
resources=resources,
)
return rope_changeset
class CommandRefactorMethodToMethodObject(Command):
name = commands.COMMAND_REFACTOR_METHOD_TO_METHOD_OBJECT
kind: CodeActionKind = "refactor.rewrite"
document_uri: DocumentUri
position: typing.Range
def validate(self, info):
method_object.MethodObject(
project=self.project,
resource=info.resource,
offset=info.current_document.offset_at_position(self.position),
)
def get_changes(self):
current_document, resource = get_resource(self.workspace, self.document_uri)
refactoring = method_object.MethodObject(
project=self.project,
resource=resource,
offset=current_document.offset_at_position(self.position),
)
rope_changeset = refactoring.get_changes(classname="NewMethodObject")
return rope_changeset
class CommandRefactorLocalToField(Command):
name = commands.COMMAND_REFACTOR_LOCAL_TO_FIELD
kind: CodeActionKind = "refactor.rewrite"
document_uri: DocumentUri
position: typing.Range
def validate(self, info):
localtofield.LocalToField(
project=self.project,
resource=info.resource,
offset=info.current_document.offset_at_position(self.position),
)
def get_changes(self):
current_document, resource = get_resource(self.workspace, self.document_uri)
refactoring = localtofield.LocalToField(
project=self.project,
resource=resource,
offset=current_document.offset_at_position(self.position),
)
rope_changeset = refactoring.get_changes()
return rope_changeset
class CommandSourceOrganizeImport(Command):
name = commands.COMMAND_SOURCE_ORGANIZE_IMPORT
kind: CodeActionKind = "source.organizeImports"
document_uri: DocumentUri
def get_changes(self):
current_document, resource = get_resource(self.workspace, self.document_uri)
organizer = importutils.ImportOrganizer(
project=self.project,
)
rope_changeset = organizer.organize_imports(
resource=resource,
)
return rope_changeset
class CommandIntroduceParameter(Command):
name = commands.COMMAND_INTRODUCE_PARAMETER
kind: CodeActionKind = "refactor"
document_uri: DocumentUri
position: typing.Range
def validate(self, info):
introduce_parameter.IntroduceParameter(
project=self.project,
resource=info.resource,
offset=info.current_document.offset_at_position(self.position),
)
def get_changes(self):
current_document, resource = get_resource(self.workspace, self.document_uri)
refactoring = introduce_parameter.IntroduceParameter(
project=self.project,
resource=resource,
offset=current_document.offset_at_position(self.position),
)
rope_changeset = refactoring.get_changes(
new_parameter="new_parameter",
)
return rope_changeset
class GenerateCode(Command):
"""
Given an undefined symbol under cursor, generate an empty
variable/function/class/module/package
"""
name = commands.COMMAND_GENERATE_CODE
kind: CodeActionKind = "quickfix"
document_uri: DocumentUri
position: typing.Range
generate_kind: str
def validate(self, info):
generate.create_generate(
kind=self.generate_kind,
project=self.project,
resource=info.resource,
offset=info.current_document.offset_at_position(self.position),
)
def get_changes(self):
current_document, resource = get_resource(self.workspace, self.document_uri)
refactoring = generate.create_generate(
kind=self.generate_kind,
project=self.project,
resource=resource,
offset=current_document.offset_at_position(self.position),
)
rope_changeset = refactoring.get_changes()
return rope_changeset
@classmethod
def get_code_actions(cls, workspace, document, position):
return {
f"Generate {generate_kind}": cls(
workspace,
document_uri=document.uri,
position=position,
generate_kind=generate_kind,
)
for generate_kind in ["variable", "function", "class", "module", "package"]
}
|
