Incorporated the extract method command #18518

news/1 Enhancements/18514.md

@@ -0,0 +1 @@
+Supported the extract method command. (Thanks [Harry-Hopkinson](https://github.com/Harry-Hopkinson))

package.json

@@ -72,6 +72,7 @@
         "onCommand:python.setShebangInterpreter",
         "onCommand:python.viewLanguageServerOutput",
         "onCommand:python.viewOutput",
+        "onCommand:python.extractMethod",
         "onCommand:python.execSelectionInTerminal",
         "onCommand:python.execSelectionInDjangoShell",
         "onCommand:python.startREPL",
@@ -487,6 +488,11 @@
                     "light": "resources/light/repl.svg"
                 },
                 "title": "%python.command.python.viewOutput.title%"
+            },
+            {
+                "category": "Python",
+                "command": "python.extractMethod",
+                "title": "Extract Method"
             }
         ],
         "configuration": {
@@ -1810,6 +1816,12 @@
                     "command": "python.viewOutput",
                     "title": "%python.command.python.viewOutput.title%",
                     "when": "!virtualWorkspace && shellExecutionSupported"
+                },
+                {
+                    "category": "Python",
+                    "command": "python.extractMethod",
+                    "title": "Extract Method",
+                    "when": "!virtualWorkspace && shellExecutionSupported"
                 }
             ],
             "editor/context": [

src/client/common/application/commands.ts

@@ -33,6 +33,7 @@ interface ICommandNameWithoutArgumentTypeMapping {
     ['editor.action.formatDocument']: [];
     ['editor.action.rename']: [];
     [Commands.ViewOutput]: [];
+    [Commands.ExtractMethod]: [];
     [Commands.Set_Linter]: [];
     [Commands.Start_REPL]: [];
     [Commands.Enable_SourceMap_Support]: [];

src/client/common/constants.ts

@@ -47,6 +47,7 @@ export namespace Commands {
     export const Test_Stop_Refreshing = 'python.stopRefreshingTests';
     export const Sort_Imports = 'python.sortImports';
     export const ViewOutput = 'python.viewOutput';
+    export const ExtractMethod = 'python.extractMethod';
     export const Start_REPL = 'python.startREPL';
     export const Create_Terminal = 'python.createTerminal';
     export const Set_Linter = 'python.setLinter';

src/client/extensionActivation.ts

@@ -3,13 +3,27 @@
 
 'use strict';
 
-import { CodeActionKind, debug, DebugConfigurationProvider, languages, OutputChannel, window } from 'vscode';
+import {
+    CodeActionKind,
+    debug,
+    DebugConfigurationProvider,
+    languages,
+    OutputChannel,
+    window,
+    workspace,
+    WorkspaceEdit,
+} from 'vscode';
 
 import { registerTypes as activationRegisterTypes } from './activation/serviceRegistry';
 import { IExtensionActivationManager } from './activation/types';
 import { registerTypes as appRegisterTypes } from './application/serviceRegistry';
 import { IApplicationDiagnostics } from './application/types';
-import { IApplicationEnvironment, ICommandManager, IWorkspaceService } from './common/application/types';
+import {
+    IApplicationEnvironment,
+    IApplicationShell,
+    ICommandManager,
+    IWorkspaceService,
+} from './common/application/types';
 import { Commands, PYTHON, PYTHON_LANGUAGE, STANDARD_OUTPUT_CHANNEL, UseProposedApi } from './common/constants';
 import { registerTypes as installerRegisterTypes } from './common/installer/serviceRegistry';
 import { IFileSystem } from './common/platform/types';
@@ -150,6 +164,67 @@ async function activateLegacy(ext: ExtensionState): Promise<ActivationResult> {
             disposables.push(cmdManager.registerCommand(Commands.ViewOutput, () => outputChannel.show()));
             cmdManager.executeCommand('setContext', 'python.vscode.channel', applicationEnv.channel).then(noop, noop);
 
+            disposables.push(
+                cmdManager.registerCommand(Commands.ExtractMethod, async () => {
+                    const editor = window.activeTextEditor;
+                    const shell: IApplicationShell = serviceManager.get<IApplicationShell>(IApplicationShell);
+                    if (editor) {
+                        if (editor.selection.isEmpty) {
+                            return shell.showErrorMessage('Please Select Text before Extracting a Method');
+                        } else if (editor.selection.start.line === editor.selection.end.line) {
+                            const { selection } = editor;
+                            const { document } = editor;
+                            const text = document.getText(selection);
+                            const position = selection.start;
+                            const edit = new WorkspaceEdit();
+                            const methodName = await window.showInputBox({ prompt: 'Enter Method Name' });
+                            if (methodName) {
+                                const newText = `def ${methodName}():\n\t${text}`;
+                                edit.delete(document.uri, selection);
+                                edit.insert(document.uri, position, newText);
+                                await workspace.applyEdit(edit);
+                            } else {
+                                return shell.showErrorMessage('Method Name is Required');
+                            }
+                        } else if (editor.selection.start.line !== editor.selection.end.line) {
+                            const { selection } = editor;
+                            const { document } = editor;
+                            let text = document.getText(selection);
+                            const position = selection.start;
+                            const edit = new WorkspaceEdit();
+                            const methodName = await window.showInputBox({ prompt: 'Enter Method Name' });
+                            if (methodName) {
+                                if (selection.start.line !== selection.end.line) {
+                                    if (selection.start.character === 0) {
+                                        text = text.replace(/\n/g, '\n\t');
+                                        text = `def ${methodName}():\n\t${text}`;
+                                        edit.delete(document.uri, selection);
+                                        edit.insert(document.uri, position, text);
+                                        await workspace.applyEdit(edit);
+                                    } else {
+                                        text = text.replace(/^\s+/, '');
+                                        const newText = `def ${methodName}():\n\t${text}`;
+                                        edit.delete(document.uri, selection);
+                                        edit.insert(document.uri, position, newText);
+                                        await workspace.applyEdit(edit);
+                                    }
+                                } else {
+                                    const newText = `def ${methodName}():\n\t${text}`;
+                                    edit.delete(document.uri, selection);
+                                    edit.insert(document.uri, position, newText);
+                                    await workspace.applyEdit(edit);
+                                }
+                            } else {
+                                return shell.showErrorMessage('Method Name is Required');
+                            }
+                        }
+                    } else {
+                        return shell.showErrorMessage('Open an Active Editor before Extracting a Method');
+                    }
+                    return undefined;
+                }),
+            );
+
             serviceContainer.get<IApplicationDiagnostics>(IApplicationDiagnostics).register();
 
             serviceManager.get<ITerminalAutoActivation>(ITerminalAutoActivation).register();

src/test/sourceMapSupport.unit.test.ts

@@ -6,7 +6,7 @@
 import { expect } from 'chai';
 import * as path from 'path';
 import rewiremock from 'rewiremock';
-import * as sinon from 'sinon';
+import sinon from 'sinon';
 import { ConfigurationTarget, Disposable } from 'vscode';
 import { Diagnostics } from '../client/common/utils/localize';
 import { EXTENSION_ROOT_DIR } from '../client/constants';