updates from review

Author: isabelizimm

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",
+    code_syntax_name: CodeSyntaxName = Field(
+        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"
+							"$ref": "#/components/schemas/code_syntax_name",
+							"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/services/languageRuntime/common/languageRuntimeDataExplorerClient.ts

@@ -67,7 +67,7 @@ export interface IDataExplorerBackendClient extends Disposable {
 	getRowLabels(selection: ArraySelection, formatOptions: FormatOptions): Promise<TableRowLabels>;
 	exportDataSelection(selection: TableSelection, format: ExportFormat): Promise<ExportedData>;
 	suggestCodeSyntax(): Promise<CodeSyntaxName | undefined>;
-	convertToCode(columnFilters: Array<ColumnFilter>, rowFilters: Array<RowFilter>, sortKeys: Array<ColumnSortKey>, exportOptions: string): Promise<ConvertedCode>;
+	convertToCode(columnFilters: Array<ColumnFilter>, rowFilters: Array<RowFilter>, sortKeys: Array<ColumnSortKey>, codeSyntax: CodeSyntaxName): Promise<ConvertedCode>;
 	setColumnFilters(filters: Array<ColumnFilter>): Promise<void>;
 	setRowFilters(filters: Array<RowFilter>): Promise<FilterResult>;
 	setSortColumns(sortKeys: Array<ColumnSortKey>): Promise<void>;
@@ -105,7 +105,7 @@ export const DATA_EXPLORER_DISCONNECTED_STATE: BackendState = {
 			support_status: SupportStatus.Unsupported,
 			supported_formats: []
 		},
-		code_syntaxes: {
+		convert_to_code: {
 			support_status: SupportStatus.Unsupported
 		}
 	}
@@ -517,7 +517,7 @@ export class DataExplorerClientInstance extends Disposable {
 	 * @param desiredSyntax The desired syntax for the code conversion.
 	 * @returns A promise that resolves to the converted code.
 	 */
-	async convertToCode(desiredSyntax: string): Promise<ConvertedCode> {
+	async convertToCode(desiredSyntax: CodeSyntaxName): Promise<ConvertedCode> {
 		const state = await this.getBackendState();
 		await this.isSyntaxSupported(desiredSyntax, state);
 
@@ -536,7 +536,7 @@ export class DataExplorerClientInstance extends Disposable {
 	 * @returns A promise that resolves to the available code syntaxes.
 	 */
 	async suggestCodeSyntax(): Promise<CodeSyntaxName | undefined> {
-		await this.isSyntaxSupported();
+		await this.isConvertToCodeSupported();
 		return await this.runBackendTask(
 			() => this._backendClient.suggestCodeSyntax(),
 			() => undefined
@@ -548,15 +548,29 @@ export class DataExplorerClientInstance extends Disposable {
 
 	//#region Private Methods
 
-	private async isSyntaxSupported(syntax?: string, backendState?: BackendState): Promise<void> {
+	/**
+	 * Checks if the convert to code feature is supported by the backend.
+	 * @param backendState The backend state to check.
+	 * @throws An error if the feature is not supported.
+	 */
+	private async isConvertToCodeSupported(backendState?: BackendState): Promise<void> {
 		const state = backendState || await this.getBackendState();
-		const supportedSyntaxes = state.supported_features.code_syntaxes.code_syntaxes;
 
-		if (state.supported_features.code_syntaxes.support_status === SupportStatus.Unsupported) {
+		if (state.supported_features.convert_to_code.support_status === SupportStatus.Unsupported) {
 			throw new Error('Code syntax conversion is not supported by the backend.');
 		}
+	}
+
+	/**
+	 * Checks if the given code syntax is supported by the backend.
+	 * @param syntax The code syntax to check.
+	 * @param backendState The backend state to check.
+	 * @throws An error if the syntax is not supported.
+	 */
+	private async isSyntaxSupported(syntax: CodeSyntaxName, backendState: BackendState): Promise<void> {
+		await this.isConvertToCodeSupported(backendState);
 
-		if (syntax && !supportedSyntaxes?.includes(syntax)) {
+		if (syntax && !backendState.supported_features.convert_to_code.code_syntaxes?.some(s => s.code_syntax_name === syntax)) {
 			throw new Error(`Code syntax "${syntax}" is not supported by the backend.`);
 		}
 	}

src/vs/workbench/services/languageRuntime/common/positronDataExplorerComm.ts

@@ -59,20 +59,20 @@ export interface ExportedData {
  */
 export interface ConvertedCode {
 	/**
-	 * Lines of code translating filters and sort keys
+	 * Lines of code that implement filters and sort keys
 	 */
 	converted_code: Array<string>;
 
 }
 
 /**
- * Suggestion of syntax to use for code translation
+ * Syntax to use for code conversion
  */
 export interface CodeSyntaxName {
 	/**
-	 * The syntax for converted code
+	 * The name of the code syntax, eg, pandas, polars, dplyr, etc.
 	 */
-	code_syntax_name: string;
+	code_syntax_name: CodeSyntaxName;
 
 }
 
@@ -879,9 +879,9 @@ export interface SupportedFeatures {
 	export_data_selection: ExportDataSelectionFeatures;
 
 	/**
-	 * Support for converting data selections to code
+	 * Support for 'convert_to_code' RPC and its features
 	 */
-	code_syntaxes: CodeSyntaxFeatures;
+	convert_to_code: ConvertToCodeFeatures;
 
 }
 
@@ -982,9 +982,9 @@ export interface SetSortColumnsFeatures {
 }
 
 /**
- * A list of supported code syntax names for exporting data selections
+ * Feature flags for convert to code RPC
  */
-export interface CodeSyntaxFeatures {
+export interface ConvertToCodeFeatures {
 	/**
 	 * The support status for this RPC method
 	 */
@@ -993,7 +993,7 @@ export interface CodeSyntaxFeatures {
 	/**
 	 * The syntaxes for converted code
 	 */
-	code_syntaxes?: Array<string>;
+	code_syntaxes?: Array<CodeSyntaxName>;
 
 }
 
@@ -1349,9 +1349,9 @@ export interface ConvertToCodeParams {
 	sort_keys: Array<ColumnSortKey>;
 
 	/**
-	 * The code syntax to use for translation
+	 * The code syntax to use for conversion
 	 */
-	code_syntax_name: string;
+	code_syntax_name: CodeSyntaxName;
 }
 
 /**
@@ -1589,11 +1589,11 @@ export class PositronDataExplorerComm extends PositronBaseComm {
 	 * @param columnFilters Zero or more column filters to apply
 	 * @param rowFilters Zero or more row filters to apply
 	 * @param sortKeys Zero or more sort keys to apply
-	 * @param codeSyntaxName The code syntax to use for translation
+	 * @param codeSyntaxName The code syntax to use for conversion
 	 *
 	 * @returns Code snippet for the data view
 	 */
-	convertToCode(columnFilters: Array<ColumnFilter>, rowFilters: Array<RowFilter>, sortKeys: Array<ColumnSortKey>, codeSyntaxName: string): Promise<ConvertedCode> {
+	convertToCode(columnFilters: Array<ColumnFilter>, rowFilters: Array<RowFilter>, sortKeys: Array<ColumnSortKey>, codeSyntaxName: CodeSyntaxName): Promise<ConvertedCode> {
 		return super.performRpc('convert_to_code', ['column_filters', 'row_filters', 'sort_keys', 'code_syntax_name'], [columnFilters, rowFilters, sortKeys, codeSyntaxName]);
 	}
 
@@ -1604,7 +1604,7 @@ export class PositronDataExplorerComm extends PositronBaseComm {
 	 * state
 	 *
 	 *
-	 * @returns Suggestion of syntax to use for code translation
+	 * @returns Syntax to use for code conversion
 	 */
 	suggestCodeSyntax(): Promise<CodeSyntaxName> {
 		return super.performRpc('suggest_code_syntax', [], []);

src/vs/workbench/services/positronDataExplorer/browser/interfaces/positronDataExplorerInstance.ts

@@ -9,6 +9,7 @@ import { TableDataDataGridInstance } from '../tableDataDataGridInstance.js';
 import { DataExplorerClientInstance } from '../../../languageRuntime/common/languageRuntimeDataExplorerClient.js';
 import { TableSummaryDataGridInstance } from '../tableSummaryDataGridInstance.js';
 import { PositronDataExplorerLayout } from './positronDataExplorerService.js';
+import { CodeSyntaxName } from '../../../languageRuntime/common/positronDataExplorerComm.js';
 
 /**
  * IPositronDataExplorerInstance interface.
@@ -121,7 +122,7 @@ export interface IPositronDataExplorerInstance extends IDisposable {
 	copyTableDataToClipboard(): Promise<void>;
 
 	/**
-	 * Translates the current data view's filters and sorts to code in the desired syntax.
+	 * Converts the current data view's filters and sorts to code in the desired syntax.
 	 */
-	convertToCode(desiredSyntax: string): Promise<string | undefined>;
+	convertToCode(desiredSyntax: CodeSyntaxName): Promise<string | undefined>;
 }

src/vs/workbench/services/positronDataExplorer/browser/positronDataExplorerInstance.ts

@@ -24,6 +24,7 @@ import { PositronDataExplorerLayout } from './interfaces/positronDataExplorerSer
 import { IPositronDataExplorerInstance } from './interfaces/positronDataExplorerInstance.js';
 import { ClipboardCell, ClipboardCellRange, ClipboardColumnIndexes, ClipboardColumnRange, ClipboardRowIndexes, ClipboardRowRange } from '../../../browser/positronDataGrid/classes/dataGridInstance.js';
 import { DataExplorerSummaryCollapseEnabled, DefaultDataExplorerSummaryLayout } from './positronDataExplorerSummary.js';
+import { CodeSyntaxName } from '../../languageRuntime/common/positronDataExplorerComm.js';
 
 /**
  * Constants.
@@ -431,10 +432,10 @@ export class PositronDataExplorerInstance extends Disposable implements IPositro
 	}
 
 	/**
-	 * Translates the data explorer view to code in the desired syntax.
-	 * @returns A Promise<string> that resolves when generated code is returned.
+	 * Converts the data explorer view to code in the desired syntax.
+	 * @returns A Promise<string> that resolves when converted code is returned.
 	 */
-	async convertToCode(desiredSyntax: string): Promise<string | undefined> {
+	async convertToCode(desiredSyntax: CodeSyntaxName): Promise<string | undefined> {
 		const generatedCode = await this._dataExplorerClientInstance.convertToCode(desiredSyntax);
 		return generatedCode.converted_code.join('\n');
 	}