forked from DonJayamanne/pythonVSCode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathimportSortProvider.ts
More file actions
48 lines (45 loc) · 2.49 KB
/
Copy pathimportSortProvider.ts
File metadata and controls
48 lines (45 loc) · 2.49 KB
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
import * as fs from 'fs-extra';
import * as path from 'path';
import { TextDocument, TextEdit } from 'vscode';
import { PythonSettings } from '../common/configSettings';
import { getTempFileWithDocumentContents, getTextEditsFromPatch } from '../common/editor';
import { ExecutionResult, IProcessService, IPythonExecutionFactory } from '../common/process/types';
import { captureTelemetry } from '../telemetry';
import { FORMAT_SORT_IMPORTS } from '../telemetry/constants';
// tslint:disable-next-line:completed-docs
export class PythonImportSortProvider {
constructor(private pythonExecutionFactory: IPythonExecutionFactory,
private processService: IProcessService) { }
@captureTelemetry(FORMAT_SORT_IMPORTS)
public async sortImports(extensionDir: string, document: TextDocument): Promise<TextEdit[]> {
if (document.lineCount === 1) {
return [];
}
// isort does have the ability to read from the process input stream and return the formatted code out of the output stream.
// However they don't support returning the diff of the formatted text when reading data from the input stream.
// Yes getting text formatted that way avoids having to create a temporary file, however the diffing will have
// to be done here in node (extension), i.e. extension cpu, i.e. less responsive solution.
const importScript = path.join(extensionDir, 'pythonFiles', 'sortImports.py');
const tmpFileCreated = document.isDirty;
const filePath = tmpFileCreated ? await getTempFileWithDocumentContents(document) : document.fileName;
const settings = PythonSettings.getInstance(document.uri);
const isort = settings.sortImports.path;
const args = [filePath, '--diff'].concat(settings.sortImports.args);
let promise: Promise<ExecutionResult<string>>;
if (typeof isort === 'string' && isort.length > 0) {
// Lets just treat this as a standard tool.
promise = this.processService.exec(isort, args, { throwOnStdErr: true });
} else {
promise = this.pythonExecutionFactory.create(document.uri)
.then(executionService => executionService.exec([importScript].concat(args), { throwOnStdErr: true }));
}
try {
const result = await promise;
return getTextEditsFromPatch(document.getText(), result.stdout);
} finally {
if (tmpFileCreated) {
fs.unlinkSync(filePath);
}
}
}
}