vscode-python/pythonFiles/refactor.py at master · grantstead/vscode-python · GitHub

History

433 lines (368 loc) · 16 KB

Raw

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

421

422

423

424

425

426

427

428

429

430

431

432

433

# Arguments are:

# 1. Working directory.

# 2. Rope folder

import difflib

import io

import json

import os

import sys

import traceback

try:

import rope

from rope.base import libutils

from rope.refactor.rename import Rename

from rope.refactor.extract import ExtractMethod, ExtractVariable

from rope.refactor.usefunction import UseFunction

from rope.refactor.inline import create_inline

from rope.refactor.localtofield import LocalToField

import rope.base.project

import rope.base.taskhandle

except:

jsonMessage = {'error': True, 'message': 'Rope not installed',

'traceback': '', 'type': 'ModuleNotFoundError'}

sys.stderr.write(json.dumps(jsonMessage))

sys.stderr.flush()

WORKSPACE_ROOT = sys.argv[1]

ROPE_PROJECT_FOLDER = '.vscode/.ropeproject'

class RefactorProgress():

"""

Refactor progress information

"""

def __init__(self, name='Task Name', message=None, percent=0):

self.name = name

self.message = message

self.percent = percent

class ChangeType():

"""

Change Type Enum

"""

EDIT = 0

NEW = 1

DELETE = 2

class Change():

"""

EDIT = 0

NEW = 1

DELETE = 2

def __init__(self, filePath, fileMode=ChangeType.EDIT, diff=""):

self.filePath = filePath

self.diff = diff

self.fileMode = fileMode

def get_diff(changeset):

"""This is a copy of the code form the ChangeSet.get_description method found in Rope."""

new = changeset.new_contents

old = changeset.old_contents

if old is None:

if changeset.resource.exists():

old = changeset.resource.read()

else:

old = ''

# Ensure code has a trailing empty lines, before generating a diff.

# https://github.com/Microsoft/vscode-python/issues/695.

old_lines = old.splitlines(True)

if not old_lines[-1].endswith('\n'):

old_lines[-1] = old_lines[-1] + os.linesep

new = new + os.linesep

result = difflib.unified_diff(

old_lines, new.splitlines(True),

'a/' + changeset.resource.path, 'b/' + changeset.resource.path)

return ''.join(list(result))

class BaseRefactoring(object):

"""

Base class for refactorings

"""

def __init__(self, project, resource, name="Refactor", progressCallback=None):

self._progressCallback = progressCallback

self._handle = rope.base.taskhandle.TaskHandle(name)

self._handle.add_observer(self._update_progress)

self.project = project

self.resource = resource

self.changes = []

def _update_progress(self):

jobset = self._handle.current_jobset()

if jobset and not self._progressCallback is None:

progress = RefactorProgress()

# getting current job set name

if jobset.get_name() is not None:

progress.name = jobset.get_name()

# getting active job name

if jobset.get_active_job_name() is not None:

progress.message = jobset.get_active_job_name()

# adding done percent

percent = jobset.get_percent_done()

if percent is not None:

progress.percent = percent

if not self._progressCallback is None:

self._progressCallback(progress)

def stop(self):

self._handle.stop()

def refactor(self):

try:

self.onRefactor()

except rope.base.exceptions.InterruptedTaskError:

# we can ignore this exception, as user has cancelled refactoring

pass

def onRefactor(self):

"""

To be implemented by each base class

"""

pass

class RenameRefactor(BaseRefactoring):

def __init__(self, project, resource, name="Rename", progressCallback=None, startOffset=None, newName="new_Name"):

BaseRefactoring.__init__(self, project, resource,

name, progressCallback)

self._newName = newName

self.startOffset = startOffset

def onRefactor(self):

renamed = Rename(self.project, self.resource, self.startOffset)

changes = renamed.get_changes(self._newName, task_handle=self._handle)

for item in changes.changes:

if isinstance(item, rope.base.change.ChangeContents):

self.changes.append(

Change(item.resource.real_path, ChangeType.EDIT, get_diff(item)))

else:

raise Exception('Unknown Change')

class ExtractVariableRefactor(BaseRefactoring):

def __init__(self, project, resource, name="Extract Variable", progressCallback=None, startOffset=None, endOffset=None, newName="new_Name", similar=False, global_=False):

BaseRefactoring.__init__(self, project, resource,

name, progressCallback)

self._newName = newName

self._startOffset = startOffset

self._endOffset = endOffset

self._similar = similar

self._global = global_

def onRefactor(self):

renamed = ExtractVariable(

self.project, self.resource, self._startOffset, self._endOffset)

changes = renamed.get_changes(

self._newName, self._similar, self._global)

for item in changes.changes:

if isinstance(item, rope.base.change.ChangeContents):

self.changes.append(

Change(item.resource.real_path, ChangeType.EDIT, get_diff(item)))

else:

raise Exception('Unknown Change')

class ExtractMethodRefactor(ExtractVariableRefactor):

def __init__(self, project, resource, name="Extract Method", progressCallback=None, startOffset=None, endOffset=None, newName="new_Name", similar=False, global_=False):

ExtractVariableRefactor.__init__(self, project, resource,

name, progressCallback, startOffset=startOffset, endOffset=endOffset, newName=newName, similar=similar, global_=global_)

def onRefactor(self):

renamed = ExtractMethod(

self.project, self.resource, self._startOffset, self._endOffset)

changes = renamed.get_changes(

self._newName, self._similar, self._global)

for item in changes.changes:

if isinstance(item, rope.base.change.ChangeContents):

self.changes.append(

Change(item.resource.real_path, ChangeType.EDIT, get_diff(item)))

else:

raise Exception('Unknown Change')

class UseFunctionRefactor(BaseRefactoring):

""" This class implements the Use Function refactoring, but does it only on the current

resource (file).

"""

def __init__(self, project, resource, name="Use Function", progressCallback=None, startOffset=None):

BaseRefactoring.__init__(self, project, resource,

name, progressCallback)

self._startOffset = startOffset

def onRefactor(self):

renamed = UseFunction(

self.project, self.resource, self._startOffset)

changes = renamed.get_changes([renamed.resource], task_handle=self._handle)

for item in changes.changes:

if isinstance(item, rope.base.change.ChangeContents):

self.changes.append(

Change(item.resource.real_path, ChangeType.EDIT, get_diff(item)))

else:

raise Exception('Unknown Change')

class InlineRefactor(BaseRefactoring):

""" This class implements the Inline refactoring.

"""

def __init__(self, project, resource, name="Inline", progressCallback=None, startOffset=None):

BaseRefactoring.__init__(self, project, resource,

name, progressCallback)

self._startOffset = startOffset

def onRefactor(self):

renamed = create_inline(self.project, self.resource, self._startOffset)

changes = renamed.get_changes(resources=[self.resource], task_handle=self._handle)

for item in changes.changes:

if isinstance(item, rope.base.change.ChangeContents):

self.changes.append(

Change(item.resource.real_path, ChangeType.EDIT, get_diff(item)))

else:

raise Exception('Unknown Change')

class LocalToFieldRefactor(BaseRefactoring):

""" This class implements the Local To Field refactoring.

"""

def __init__(self, project, resource, name="Local To Field", progressCallback=None, startOffset=None):

BaseRefactoring.__init__(self, project, resource,

name, progressCallback)

self._startOffset = startOffset

def onRefactor(self):

renamed = LocalToField(self.project, self.resource, self._startOffset)

changes = renamed.get_changes()

for item in changes.changes:

if isinstance(item, rope.base.change.ChangeContents):

self.changes.append(

Change(item.resource.real_path, ChangeType.EDIT, get_diff(item)))

else:

raise Exception('Unknown Change')

class RopeRefactoring(object):

def __init__(self):

self.default_sys_path = sys.path

self._input = io.open(sys.stdin.fileno(), encoding='utf-8')

def _rename(self, filePath, start, newName, indent_size):

"""

Renames a variable

"""

project = rope.base.project.Project(

WORKSPACE_ROOT, ropefolder=ROPE_PROJECT_FOLDER, save_history=False, indent_size=indent_size)

resourceToRefactor = libutils.path_to_resource(project, filePath)

refactor = RenameRefactor(

project, resourceToRefactor, startOffset=start, newName=newName)

refactor.refactor()

changes = refactor.changes

project.close()

valueToReturn = []

for change in changes:

valueToReturn.append({'diff': change.diff})

return valueToReturn

def _extractVariable(self, filePath, start, end, newName, indent_size):

"""

Extracts a variable

"""

project = rope.base.project.Project(

WORKSPACE_ROOT, ropefolder=ROPE_PROJECT_FOLDER, save_history=False, indent_size=indent_size)

resourceToRefactor = libutils.path_to_resource(project, filePath)

refactor = ExtractVariableRefactor(

project, resourceToRefactor, startOffset=start, endOffset=end, newName=newName, similar=True)

refactor.refactor()

changes = refactor.changes

project.close()

valueToReturn = []

for change in changes:

valueToReturn.append({'diff': change.diff})

return valueToReturn

def _extractMethod(self, filePath, start, end, newName, indent_size):

"""

Extracts a method

"""

project = rope.base.project.Project(

WORKSPACE_ROOT, ropefolder=ROPE_PROJECT_FOLDER, save_history=False, indent_size=indent_size)

resourceToRefactor = libutils.path_to_resource(project, filePath)

refactor = ExtractMethodRefactor(

project, resourceToRefactor, startOffset=start, endOffset=end, newName=newName, similar=True)

refactor.refactor()

changes = refactor.changes

project.close()

valueToReturn = []

for change in changes:

valueToReturn.append({'diff': change.diff})

return valueToReturn

def _useFunction(self, filePath, start, indent_size):

"""

Use Function

"""

project = rope.base.project.Project(

WORKSPACE_ROOT, ropefolder=ROPE_PROJECT_FOLDER, save_history=False, indent_size=indent_size)

resourceToRefactor = libutils.path_to_resource(project, filePath)

refactor = UseFunctionRefactor(project, resourceToRefactor, startOffset=start)

refactor.refactor()

changes = refactor.changes

project.close()

valueToReturn = []

for change in changes:

valueToReturn.append({'diff': change.diff})

return valueToReturn

def _inline(self, filePath, start, indent_size):

"""

Inline

"""

project = rope.base.project.Project(

WORKSPACE_ROOT, ropefolder=ROPE_PROJECT_FOLDER, save_history=False, indent_size=indent_size)

resourceToRefactor = libutils.path_to_resource(project, filePath)

refactor = InlineRefactor(project, resourceToRefactor, startOffset=start)

refactor.refactor()

changes = refactor.changes

project.close()

valueToReturn = []

for change in changes:

valueToReturn.append({'diff': change.diff})

return valueToReturn

def _localToField(self, filePath, start, indent_size):

"""

Local To Field

"""

project = rope.base.project.Project(

WORKSPACE_ROOT, ropefolder=ROPE_PROJECT_FOLDER, save_history=False, indent_size=indent_size)

resourceToRefactor = libutils.path_to_resource(project, filePath)

refactor = LocalToFieldRefactor(project, resourceToRefactor, startOffset=start)

refactor.refactor()

changes = refactor.changes

project.close()

valueToReturn = []

for change in changes:

valueToReturn.append({'diff': change.diff})

return valueToReturn

def _serialize(self, identifier, results):

"""

Serializes the refactor results

"""

return json.dumps({'id': identifier, 'results': results})

def _deserialize(self, request):

"""Deserialize request from VSCode.

Args:

request: String with raw request from VSCode.

Returns:

Python dictionary with request data.

"""

return json.loads(request)

def _process_request(self, request):

"""Accept serialized request from VSCode and write response.

"""

request = self._deserialize(request)

lookup = request.get('lookup', '')

if lookup == '':

pass

elif lookup == 'rename':

changes = self._rename(request['file'], int(

request['start']), request['name'], int(request['indent_size']))

return self._write_response(self._serialize(request['id'], changes))

elif lookup == 'extract_variable':

changes = self._extractVariable(request['file'], int(

request['start']), int(request['end']), request['name'], int(request['indent_size']))

return self._write_response(self._serialize(request['id'], changes))

elif lookup == 'extract_method':

changes = self._extractMethod(request['file'], int(

request['start']), int(request['end']), request['name'], int(request['indent_size']))

return self._write_response(self._serialize(request['id'], changes))

elif lookup == 'use_function':

changes = self._useFunction(request['file'], int(

request['start']), int(request['indent_size']))

return self._write_response(self._serialize(request['id'], changes))

elif lookup == 'inline':

changes = self._inline(request['file'], int(

request['start']), int(request['indent_size']))

return self._write_response(self._serialize(request['id'], changes))

elif lookup == 'local_to_field':

changes = self._localToField(request['file'], int(

request['start']), int(request['indent_size']))

return self._write_response(self._serialize(request['id'], changes))

def _write_response(self, response):

sys.stdout.write(response + '\n')

sys.stdout.flush()

def watch(self):

self._write_response("STARTED")

while True:

try:

self._process_request(self._input.readline())

except:

exc_type, exc_value, exc_tb = sys.exc_info()

tb_info = traceback.extract_tb(exc_tb)

jsonMessage = {'error': True, 'message': str(

exc_value), 'traceback': str(tb_info), 'type': str(exc_type)}

sys.stderr.write(json.dumps(jsonMessage))

sys.stderr.flush()

if __name__ == '__main__':

RopeRefactoring().watch()

vscode-python/pythonFiles/refactor.py at master · grantstead/vscode-python · GitHub

Expand file tree

Breadcrumbs

refactor.py

Latest commit

History

Breadcrumbs

refactor.py

File metadata and controls