Disable sort imports in notebook cells (#12194)

For #12193

Author: DonJayamanne

news/2 Fixes/12193.md

@@ -0,0 +1 @@
+Disable `Sort Imports` command in `Notebook Cells`.

package.json

@@ -700,7 +700,7 @@
                     "command": "python.sortImports",
                     "title": "Refactor: Sort Imports",
                     "group": "Refactor",
-                    "when": "editorLangId == python"
+                    "when": "editorLangId == python && !notebookEditorFocused"
                 },
                 {
                     "command": "python.execSelectionInTerminal",

src/client/providers/codeActionProvider/pythonCodeActionProvider.ts

@@ -4,14 +4,18 @@
 'use strict';
 
 import * as vscode from 'vscode';
+import { isNotebookCell } from '../../common/utils/misc';
 
 export class PythonCodeActionProvider implements vscode.CodeActionProvider {
     public provideCodeActions(
-        _document: vscode.TextDocument,
+        document: vscode.TextDocument,
         _range: vscode.Range,
         _context: vscode.CodeActionContext,
         _token: vscode.CancellationToken
     ): vscode.ProviderResult<vscode.CodeAction[]> {
+        if (isNotebookCell(document)) {
+            return [];
+        }
         const sortImports = new vscode.CodeAction('Sort imports', vscode.CodeActionKind.SourceOrganizeImports);
         sortImports.command = {
             title: 'Sort imports',

src/test/providers/codeActionProvider/pythonCodeActionsProvider.unit.test.ts

@@ -3,9 +3,9 @@
 
 'use strict';
 
-import { expect } from 'chai';
+import { assert, expect } from 'chai';
 import * as TypeMoq from 'typemoq';
-import { CancellationToken, CodeActionContext, CodeActionKind, Range, TextDocument } from 'vscode';
+import { CancellationToken, CodeActionContext, CodeActionKind, Range, TextDocument, Uri } from 'vscode';
 import { PythonCodeActionProvider } from '../../../client/providers/codeActionProvider/pythonCodeActionProvider';
 
 suite('Python CodeAction Provider', () => {
@@ -24,21 +24,36 @@ suite('Python CodeAction Provider', () => {
     });
 
     test('Ensure it always returns a source.organizeImports CodeAction', async () => {
+        document.setup((d) => d.uri).returns(() => Uri.file('hello.ipynb'));
         const codeActions = await codeActionsProvider.provideCodeActions(
             document.object,
             range.object,
             context.object,
             token.object
         );
 
-        if (!codeActions) {
-            throw Error(`codeActionsProvider.provideCodeActions did not return an array (it returned ${codeActions})`);
-        }
+        assert.isArray(codeActions, 'codeActionsProvider.provideCodeActions did not return an array');
 
-        const organizeImportsCodeAction = codeActions.filter(
+        const organizeImportsCodeAction = (codeActions || []).filter(
             (codeAction) => codeAction.kind === CodeActionKind.SourceOrganizeImports
         );
         expect(organizeImportsCodeAction).to.have.length(1);
         expect(organizeImportsCodeAction[0].kind).to.eq(CodeActionKind.SourceOrganizeImports);
     });
+    test('Ensure it does not returns a source.organizeImports CodeAction for Notebook Cells', async () => {
+        document.setup((d) => d.uri).returns(() => Uri.file('hello.ipynb').with({ scheme: 'vscode-notebook-cell' }));
+        const codeActions = await codeActionsProvider.provideCodeActions(
+            document.object,
+            range.object,
+            context.object,
+            token.object
+        );
+
+        assert.isArray(codeActions, 'codeActionsProvider.provideCodeActions did not return an array');
+
+        const organizeImportsCodeAction = (codeActions || []).filter(
+            (codeAction) => codeAction.kind === CodeActionKind.SourceOrganizeImports
+        );
+        expect(organizeImportsCodeAction).to.have.length(0);
+    });
 });