data explorer: create "Copy as Code" modal

extensions/positron-python/python_files/posit/positron/data_explorer.py

@@ -27,7 +27,6 @@
 from .data_explorer_comm import (
     ArraySelection,
     BackendState,
-    CodeSyntaxFeatures,
     CodeSyntaxName,
     ColumnDisplayType,
     ColumnFilter,
@@ -48,6 +47,7 @@
     ColumnSummaryStats,
     ColumnValue,
     ConvertedCode,
+    ConvertToCodeFeatures,
     ConvertToCodeRequest,
     DataExplorerBackendMessageContent,
     DataExplorerFrontendEvent,
@@ -84,7 +84,7 @@
     SetRowFiltersFeatures,
     SetRowFiltersParams,
     SetSortColumnsFeatures,
-    SetSortColumnsRequest,
+    SetSortColumnsParams,
     SuggestCodeSyntaxRequest,
     SummaryStatsBoolean,
     SummaryStatsDate,
@@ -292,10 +292,10 @@ def suggest_code_syntax(self, request: SuggestCodeSyntaxRequest):
     def convert_to_code(self, request: ConvertToCodeRequest):
         raise NotImplementedError
 
-    def search_schema(self, request: SearchSchemaRequest):
-        filters = request.params.filters
-        start_index = request.params.start_index
-        max_results = request.params.max_results
+    def search_schema(self, params: SearchSchemaParams):
+        filters = params.filters
+        start_index = params.start_index
+        max_results = params.max_results
         if self._search_schema_last_result is not None:
             last_filters, matches = self._search_schema_last_result
             if last_filters != filters:
@@ -815,9 +815,12 @@ def _prof_histogram(
             support_status=SupportStatus.Unsupported,
             supported_formats=[],
         ),
-        code_syntaxes=CodeSyntaxFeatures(
+        convert_to_code=ConvertToCodeFeatures(
             support_status=SupportStatus.Supported,
-            code_syntaxes=["pandas", "polars"],
+            code_syntaxes=[
+                CodeSyntaxName(code_syntax_name="pandas"),
+                CodeSyntaxName(code_syntax_name="polars"),
+            ],
         ),
     )
 
@@ -1936,8 +1939,9 @@ def _prof_histogram(
                 ExportFormat.Html,
             ],
         ),
-        code_syntaxes=CodeSyntaxFeatures(
-            support_status=SupportStatus.Supported, code_syntaxes=["pandas"]
+        convert_to_code=ConvertToCodeFeatures(
+            support_status=SupportStatus.Supported,
+            code_syntaxes=[CodeSyntaxName(code_syntax_name="pandas")],
         ),
     )
 
@@ -2800,8 +2804,9 @@ def _prof_histogram(
             supported_formats=[ExportFormat.Csv, ExportFormat.Tsv],
         ),
         set_sort_columns=SetSortColumnsFeatures(support_status=SupportStatus.Supported),
-        code_syntaxes=CodeSyntaxFeatures(
-            support_status=SupportStatus.Supported, code_syntaxes=["polars"]
+        convert_to_code=ConvertToCodeFeatures(
+            support_status=SupportStatus.Supported,
+            code_syntaxes=[CodeSyntaxName(code_syntax_name="polars")],
         ),
     )
 

extensions/positron-python/python_files/posit/positron/data_explorer_comm.py

@@ -258,17 +258,17 @@ class ConvertedCode(BaseModel):
     """
 
     converted_code: List[StrictStr] = Field(
-        description="Lines of code translating filters and sort keys",
+        description="Lines of code that implement filters and sort keys",
     )
 
 
 class CodeSyntaxName(BaseModel):
     """
-    Suggestion of syntax to use for code translation
+    Syntax to use for code conversion
     """
 
     code_syntax_name: StrictStr = Field(
-        description="The syntax for converted code",
+        description="The name of the code syntax, eg, pandas, polars, dplyr, etc.",
     )
 
 
@@ -992,8 +992,8 @@ class SupportedFeatures(BaseModel):
         description="Support for 'export_data_selection' RPC and its features",
     )
 
-    code_syntaxes: CodeSyntaxFeatures = Field(
-        description="Support for converting data selections to code",
+    convert_to_code: ConvertToCodeFeatures = Field(
+        description="Support for 'convert_to_code' RPC and its features",
     )
 
 
@@ -1081,16 +1081,16 @@ class SetSortColumnsFeatures(BaseModel):
     )
 
 
-class CodeSyntaxFeatures(BaseModel):
+class ConvertToCodeFeatures(BaseModel):
     """
-    A list of supported code syntax names for exporting data selections
+    Feature flags for convert to code RPC
     """
 
     support_status: SupportStatus = Field(
         description="The support status for this RPC method",
     )
 
-    code_syntaxes: Optional[List[StrictStr]] = Field(
+    code_syntaxes: Optional[List[CodeSyntaxName]] = Field(
         default=None,
         description="The syntaxes for converted code",
     )
@@ -1485,8 +1485,8 @@ class ConvertToCodeParams(BaseModel):
         description="Zero or more sort keys to apply",
     )
 
-    code_syntax_name: StrictStr = Field(
-        description="The code syntax to use for translation",
+    code_syntax_name: CodeSyntaxName = Field(
+        description="The code syntax to use for conversion",
     )
 
 
@@ -1815,7 +1815,7 @@ class ReturnColumnProfilesParams(BaseModel):
 
 SetSortColumnsFeatures.update_forward_refs()
 
-CodeSyntaxFeatures.update_forward_refs()
+ConvertToCodeFeatures.update_forward_refs()
 
 TableSelection.update_forward_refs()
 

positron/comms/data_explorer-backend-openrpc.json

@@ -215,7 +215,7 @@
 				}
 			}
 		},
-{
+		{
 			"name": "convert_to_code",
 			"summary": "Converts the current data view into a code snippet.",
 			"description": "Converts filters and sort keys as code in different syntaxes like pandas, polars, data.table, dplyr",
@@ -255,14 +255,14 @@
 				},
 				{
 					"name": "code_syntax_name",
-					"description": "The code syntax to use for translation",
+					"description": "The code syntax to use for conversion",
 					"required": true,
 					"schema": {
-						"type": "string",
-						"description": "The syntax for converted code"
+						"$ref": "#/components/schemas/code_syntax_name",
+						"description": "The name of the code syntax, eg, pandas, polars, dplyr, etc."
 					}
 				}
-		],
+			],
 			"result": {
 				"schema": {
 					"name": "converted_code",
@@ -274,7 +274,7 @@
 					"properties": {
 						"converted_code": {
 							"type": "array",
-							"description": "Lines of code translating filters and sort keys",
+							"description": "Lines of code that implement filters and sort keys",
 							"items": {
 								"type": "string"
 							}
@@ -283,7 +283,7 @@
 				}
 			}
 		},
-{
+		{
 			"name": "suggest_code_syntax",
 			"summary": "Suggest code syntax for code conversion",
 			"description": "Suggest code syntax for code conversion based on the current backend state",
@@ -292,14 +292,14 @@
 				"schema": {
 					"name": "code_syntax_name",
 					"type": "object",
-					"description": "Suggestion of syntax to use for code translation",
+					"description": "Syntax to use for code conversion",
 					"required": [
 						"code_syntax_name"
 					],
 					"properties": {
 						"code_syntax_name": {
 							"type": "string",
-							"description": "The syntax for converted code"
+							"description": "The name of the code syntax, eg, pandas, polars, dplyr, etc."
 						}
 					}
 				}
@@ -1393,8 +1393,7 @@
 					"get_column_profiles",
 					"set_sort_columns",
 					"export_data_selection",
-					"export_as_code",
-					"code_syntaxes"
+					"convert_to_code"
 				],
 				"properties": {
 					"search_schema": {
@@ -1421,9 +1420,9 @@
 						"description": "Support for 'export_data_selection' RPC and its features",
 						"$ref": "#/components/schemas/export_data_selection_features"
 					},
-					"code_syntaxes": {
-						"description": "Support for converting data selections to code",
-						"$ref": "#/components/schemas/code_syntax_features"
+					"convert_to_code": {
+						"description": "Support for 'convert_to_code' RPC and its features",
+						"$ref": "#/components/schemas/convert_to_code_features"
 					}
 				}
 			},
@@ -1550,9 +1549,9 @@
 					}
 				}
 			},
-			"code_syntax_features": {
+			"convert_to_code_features": {
 				"type": "object",
-				"description": "A list of supported code syntax names for exporting data selections",
+				"description": "Feature flags for convert to code RPC",
 				"required": [
 					"support_status"
 				],
@@ -1565,12 +1564,16 @@
 						"type": "array",
 						"description": "The syntaxes for converted code",
 						"items": {
-							"type": "string",
-							"description": "The syntaxes for converted code"
+							"$ref": "#/components/schemas/code_syntax_name",
+							"description": "The name of the code syntax, eg, pandas, polars, dplyr, etc."
 						}
 					}
 				}
 			},
+			"code_syntax_name": {
+				"type": "string",
+				"description": "The name of the code syntax, eg, pandas, polars, dplyr, etc."
+			},
 			"table_selection": {
 				"type": "object",
 				"description": "A selection on the data grid, for copying to the clipboard or other actions",

src/vs/workbench/browser/positronModalDialogs/copyAsCodeModalDialog.tsx → src/vs/workbench/browser/positronModalDialogs/convertToCodeModalDialog.tsx

@@ -12,13 +12,14 @@ import { ICommandService } from '../../../platform/commands/common/commands.js';
 import { IKeybindingService } from '../../../platform/keybinding/common/keybinding.js';
 import { IWorkbenchLayoutService } from '../../services/layout/browser/layoutService.js';
 import { VerticalStack } from '../positronComponents/positronModalDialog/components/verticalStack.js';
-import { PositronModalReactRenderer } from '../positronModalReactRenderer/positronModalReactRenderer.js';
 import { OKCancelModalDialog } from '../positronComponents/positronModalDialog/positronOKCancelModalDialog.js';
 import { IPositronDataExplorerInstance } from '../../services/positronDataExplorer/browser/interfaces/positronDataExplorerInstance.js';
 import { PositronDataExplorerCommandId } from '../../contrib/positronDataExplorerEditor/browser/positronDataExplorerActions.js';
 import { DropDownListBox } from '../positronComponents/dropDownListBox/dropDownListBox.js';
 import { DropDownListBoxItem } from '../positronComponents/dropDownListBox/dropDownListBoxItem.js';
 import { DropdownEntry } from './components/dropdownEntry.js';
+import { CodeSyntaxName } from '../../services/languageRuntime/common/positronDataExplorerComm.js';
+import { PositronModalReactRenderer } from '../../../base/browser/positronModalReactRenderer.js';
 
 /**
  * Shows the convert to code modal dialog.
@@ -35,11 +36,7 @@ export const showConvertToCodeModalDialog = async (
 	dataExplorerClientInstance: IPositronDataExplorerInstance,
 ): Promise<void> => {
 	// Create the renderer.
-	const renderer = new PositronModalReactRenderer({
-		keybindingService,
-		layoutService,
-		container: layoutService.activeContainer
-	});
+	const renderer = new PositronModalReactRenderer()
 
 	// Show the copy as code dialog.
 	renderer.render(
@@ -54,9 +51,9 @@ export const showConvertToCodeModalDialog = async (
 };
 
 /**
- * CopyAsCodeDialogProps interface.
+ * ConvertToCodeDialogProps interface.
  */
-interface CopyAsCodeDialogProps {
+interface ConvertToCodeDialogProps {
 	commandService: ICommandService;
 	dataExplorerClientInstance: IPositronDataExplorerInstance
 	keybindingService: IKeybindingService;
@@ -66,23 +63,24 @@ interface CopyAsCodeDialogProps {
 
 
 /**
- * CopyAsCodeModalDialog component.
+ * ConvertToCodeModalDialog component.
  * @param props The component properties.
  * @returns The rendered component.
  */
-export const ConvertToCodeModalDialog = (props: CopyAsCodeDialogProps) => {
+export const ConvertToCodeModalDialog = (props: ConvertToCodeDialogProps) => {
 	// State hooks.
 	const instance = props.dataExplorerClientInstance.dataExplorerClientInstance;
-	const codeSyntaxOptions = instance.cachedBackendState?.supported_features?.code_syntaxes.code_syntaxes ?? [];
+	const codeSyntaxOptions = instance.cachedBackendState?.supported_features?.convert_to_code.code_syntaxes ?? [];
 
-	const [selectedSyntax, setSelectedSyntax] = useState<string>(
-		instance.suggestedSyntax?.code_syntax_name ?? localize('selectCodeSyntax', 'Select Code Syntax')
-	);
+	const [selectedSyntax, setSelectedSyntax] = useState<CodeSyntaxName | undefined>(instance.suggestedSyntax);
 
 	const [codeString, setCodeString] = useState<string | undefined>(undefined);
 
 	useEffect(() => {
 		const getCodeString = async () => {
+			if (!selectedSyntax) {
+				return;
+			}
 			// Execute the command to get the code string based on the selected syntax.
 			const codeString = await props.commandService.executeCommand(PositronDataExplorerCommandId.ConvertToCodeAction, selectedSyntax);
 			setCodeString(codeString);
@@ -96,23 +94,31 @@ export const ConvertToCodeModalDialog = (props: CopyAsCodeDialogProps) => {
 	};
 
 	const syntaxInfoToDropDownItems = (
-		syntaxes: string[]
-	): DropDownListBoxItem<string, string>[] => {
+		syntaxes: CodeSyntaxName[]
+	): DropDownListBoxItem<string, CodeSyntaxName>[] => {
 		return syntaxes.map(
 			(syntax) =>
-				new DropDownListBoxItem<string, string>({
-					identifier: syntax,
+				new DropDownListBoxItem<string, CodeSyntaxName>({
+					identifier: syntax.code_syntax_name,
 					value: syntax,
 				})
 		);
 	};
 
-	const onSelectionChanged = async (item: DropDownListBoxItem<string, string>) => {
-		const typedItem = item as DropDownListBoxItem<string, string>;
-		setSelectedSyntax(typedItem.options.identifier);
+	const syntaxDropdownTitle = (): string => {
+		// if selectedSyntax is an object with code_syntax_name, return that name
+		if (typeof selectedSyntax === 'object' && 'code_syntax_name' in selectedSyntax) {
+			return (selectedSyntax as CodeSyntaxName).code_syntax_name;
+		}
+		return localize('selectCodeSyntax', 'Select Code Syntax');
+	}
+
+	const onSelectionChanged = async (item: DropDownListBoxItem<string, CodeSyntaxName>) => {
+		const typedItem = item as DropDownListBoxItem<string, CodeSyntaxName>;
+		setSelectedSyntax(typedItem.options.value);
 
 		// Execute the command to get the code string based on the selected syntax.
-		const exc = await props.commandService.executeCommand(PositronDataExplorerCommandId.ConvertToCodeAction, typedItem.options.identifier)
+		const exc = await props.commandService.executeCommand(PositronDataExplorerCommandId.ConvertToCodeAction, typedItem.options.value);
 		setCodeString(exc);
 	};
 
@@ -140,9 +146,7 @@ export const ConvertToCodeModalDialog = (props: CopyAsCodeDialogProps) => {
 						/>
 					)}
 					entries={syntaxDropdownEntries()}
-					keybindingService={props.keybindingService}
-					layoutService={props.layoutService}
-					title={selectedSyntax}
+					title={syntaxDropdownTitle()}
 					onSelectionChanged={onSelectionChanged}
 				/>
 				<pre>