data explorer: "Copy as Code" comms

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

@@ -27,6 +27,7 @@
 from .data_explorer_comm import (
     ArraySelection,
     BackendState,
+    CodeSyntaxOptions,
     ColumnDisplayType,
     ColumnFilter,
     ColumnFilterType,
@@ -53,6 +54,7 @@
     DataSelectionSingleCell,
     ExportDataSelectionFeatures,
     ExportDataSelectionRequest,
+    ExportedCode,
     ExportedData,
     ExportFormat,
     FilterBetween,
@@ -63,6 +65,7 @@
     FilterSetMembership,
     FilterTextSearch,
     FormatOptions,
+    GetCodeSyntaxesRequest,
     GetColumnProfilesFeatures,
     GetColumnProfilesRequest,
     GetDataValuesRequest,
@@ -94,6 +97,7 @@
     TableSelectionKind,
     TableShape,
     TextSearchType,
+    TranslateToCodeRequest,
 )
 from .positron_comm import CommMessage, PositronComm
 from .utils import BackgroundJobQueue, guid
@@ -282,6 +286,12 @@ def get_schema(self, request: GetSchemaRequest):
     def _get_single_column_schema(self, column_index: int) -> ColumnSchema:
         raise NotImplementedError
 
+    def get_code_syntaxes(self, request: GetCodeSyntaxesRequest):
+        raise NotImplementedError
+
+    def translate_to_code(self, request: TranslateToCodeRequest):
+        raise NotImplementedError
+
     def search_schema(self, request: SearchSchemaRequest):
         filters = request.params.filters
         start_index = request.params.start_index
@@ -1351,6 +1361,14 @@ def schema_getter(column_name, column_index):
 
         return schema_updated, new_state
 
+    def get_code_syntaxes(self, request: GetCodeSyntaxesRequest):  # noqa: ARG002
+        """Returns the supported code types for exporting data."""
+        return CodeSyntaxOptions(code_syntaxes=["pandas"]).dict()
+
+    def translate_to_code(self, request: TranslateToCodeRequest):  # noqa: ARG002
+        """Translates the current data view, including filters and sorts, into a code snippet."""
+        return ExportedCode(data="import pandas as pd\n\n# TODO: Implement export to code").dict()
+
     @classmethod
     def _construct_schema(
         cls, column, column_name, column_index: int, state: DataExplorerState
@@ -2281,6 +2299,14 @@ def schema_getter(column_name, column_index):
 
         return schema_updated, new_state
 
+    def get_code_syntaxes(self, request: GetCodeSyntaxesRequest):  # noqa: ARG002
+        """Returns the supported code types for exporting data."""
+        return CodeSyntaxOptions(code_syntaxes=["polars"]).dict()
+
+    def translate_to_code(self, request: TranslateToCodeRequest):  # noqa: ARG002
+        """Translates the current data view, including filters and sorts, into a code snippet."""
+        return ExportedCode(data="import polars as pl\n\n# TODO: Implement export to code").dict()
+
     def _get_single_column_schema(self, column_index: int):
         if self.state.schema_cache:
             return self.state.schema_cache[column_index]

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

@@ -252,6 +252,27 @@ class ExportedData(BaseModel):
     )
 
 
+class ExportedCode(BaseModel):
+    """
+    Resulting code
+    """
+
+    data: Optional[StrictStr] = Field(
+        default=None,
+        description="Exported code as a string suitable for copy and paste",
+    )
+
+
+class CodeSyntaxOptions(BaseModel):
+    """
+    Code syntaxes available for export
+    """
+
+    code_syntaxes: List[StrictStr] = Field(
+        description="Available code syntaxes supported for export",
+    )
+
+
 class FilterResult(BaseModel):
     """
     The result of applying filters to a table
@@ -1208,6 +1229,12 @@ class DataExplorerBackendRequest(str, enum.Enum):
     # Export data selection as a string in different formats
     ExportDataSelection = "export_data_selection"
 
+    # Translates the current data view into a code snippet.
+    TranslateToCode = "translate_to_code"
+
+    # Get code syntaxes supported for code translation
+    GetCodeSyntaxes = "get_code_syntaxes"
+
     # Set column filters to select subset of table columns
     SetColumnFilters = "set_column_filters"
 
@@ -1422,6 +1449,65 @@ class ExportDataSelectionRequest(BaseModel):
     )
 
 
+class TranslateToCodeParams(BaseModel):
+    """
+    Translate filters and sort keys as code in different syntaxes like
+    pandas, polars, data.table, dplyr
+    """
+
+    column_filters: List[ColumnFilter] = Field(
+        description="Zero or more column filters to apply",
+    )
+
+    row_filters: List[RowFilter] = Field(
+        description="Zero or more row filters to apply",
+    )
+
+    sort_keys: List[ColumnSortKey] = Field(
+        description="Zero or more sort keys to apply",
+    )
+
+    code_syntax: StrictStr = Field(
+        description="The code syntax to use for translation",
+    )
+
+
+class TranslateToCodeRequest(BaseModel):
+    """
+    Translate filters and sort keys as code in different syntaxes like
+    pandas, polars, data.table, dplyr
+    """
+
+    params: TranslateToCodeParams = Field(
+        description="Parameters to the TranslateToCode method",
+    )
+
+    method: Literal[DataExplorerBackendRequest.TranslateToCode] = Field(
+        description="The JSON-RPC method name (translate_to_code)",
+    )
+
+    jsonrpc: str = Field(
+        default="2.0",
+        description="The JSON-RPC version specifier",
+    )
+
+
+class GetCodeSyntaxesRequest(BaseModel):
+    """
+    Get all available code syntaxes supported for translation for a data
+    view
+    """
+
+    method: Literal[DataExplorerBackendRequest.GetCodeSyntaxes] = Field(
+        description="The JSON-RPC method name (get_code_syntaxes)",
+    )
+
+    jsonrpc: str = Field(
+        default="2.0",
+        description="The JSON-RPC version specifier",
+    )
+
+
 class SetColumnFiltersParams(BaseModel):
     """
     Set or clear column filters on table, replacing any previous filters
@@ -1575,6 +1661,8 @@ class DataExplorerBackendMessageContent(BaseModel):
         GetDataValuesRequest,
         GetRowLabelsRequest,
         ExportDataSelectionRequest,
+        TranslateToCodeRequest,
+        GetCodeSyntaxesRequest,
         SetColumnFiltersRequest,
         SetRowFiltersRequest,
         SetSortColumnsRequest,
@@ -1623,6 +1711,10 @@ class ReturnColumnProfilesParams(BaseModel):
 
 ExportedData.update_forward_refs()
 
+ExportedCode.update_forward_refs()
+
+CodeSyntaxOptions.update_forward_refs()
+
 FilterResult.update_forward_refs()
 
 BackendState.update_forward_refs()
@@ -1741,6 +1833,12 @@ class ReturnColumnProfilesParams(BaseModel):
 
 ExportDataSelectionRequest.update_forward_refs()
 
+TranslateToCodeParams.update_forward_refs()
+
+TranslateToCodeRequest.update_forward_refs()
+
+GetCodeSyntaxesRequest.update_forward_refs()
+
 SetColumnFiltersParams.update_forward_refs()
 
 SetColumnFiltersRequest.update_forward_refs()

positron/comms/data_explorer-backend-openrpc.json

@@ -215,6 +215,98 @@
 				}
 			}
 		},
+{
+			"name": "translate_to_code",
+			"summary": "Translates the current data view into a code snippet.",
+			"description": "Translate filters and sort keys as code in different syntaxes like pandas, polars, data.table, dplyr",
+			"params": [
+				{
+					"name": "column_filters",
+					"description": "Zero or more column filters to apply",
+					"required": true,
+					"schema": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/column_filter"
+						}
+					}
+				},
+				{
+					"name": "row_filters",
+					"description": "Zero or more row filters to apply",
+					"required": true,
+					"schema": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/row_filter"
+						}
+					}
+				},
+				{
+					"name": "sort_keys",
+					"description": "Zero or more sort keys to apply",
+					"required": true,
+					"schema": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/column_sort_key"
+						}
+					}
+				},
+				{
+					"name": "code_syntax",
+					"description": "The code syntax to use for translation",
+					"required": true,
+					"schema": {
+						"type": "string",
+						"items": {
+							"$ref": "#/components/schemas/code_syntax"
+						}
+					}
+				}
+		],
+			"result": {
+				"schema": {
+					"name": "exported_code",
+					"type": "object",
+					"description": "Resulting code",
+					"required": [
+						"code"
+					],
+					"properties": {
+						"data": {
+							"type": "string",
+							"description": "Exported code as a string suitable for copy and paste"
+						}
+					}
+				}
+			}
+		},
+{
+			"name": "get_code_syntaxes",
+			"summary": "Get code syntaxes supported for code translation",
+			"description": "Get all available code syntaxes supported for translation for a data view",
+			"params": [],
+			"result": {
+				"schema": {
+					"name": "code_syntax_options",
+					"type": "object",
+					"description": "Code syntaxes available for export",
+					"required": [
+						"code_syntaxes"
+					],
+					"properties": {
+						"code_syntaxes": {
+							"type": "array",
+							"description": "Available code syntaxes supported for export",
+							"items": {
+								"type": "string"
+							}
+						}
+					}
+				}
+			}
+		},
 		{
 			"name": "set_column_filters",
 			"summary": "Set column filters to select subset of table columns",
@@ -1293,6 +1385,10 @@
 					}
 				}
 			},
+			"code_syntax": {
+				"type": "string",
+				"description": "The syntax for translated code"
+			},
 			"supported_features": {
 				"type": "object",
 				"description": "For each field, returns flags indicating supported features",
@@ -1302,7 +1398,8 @@
 					"set_row_filters",
 					"get_column_profiles",
 					"set_sort_columns",
-					"export_data_selection"
+					"export_data_selection",
+					"export_as_code"
 				],
 				"properties": {
 					"search_schema": {

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

@@ -8,7 +8,7 @@ import { Emitter, Event } from '../../../../base/common/event.js';
 import { Disposable } from '../../../../base/common/lifecycle.js';
 import { URI } from '../../../../base/common/uri.js';
 import { generateUuid } from '../../../../base/common/uuid.js';
-import { ArraySelection, BackendState, ColumnFilter, ColumnProfileRequest, ColumnProfileResult, ColumnSchema, ColumnSelection, ColumnSortKey, DataExplorerFrontendEvent, DataUpdateEvent, ExportedData, ExportFormat, FilterResult, FormatOptions, ReturnColumnProfilesEvent, RowFilter, SchemaUpdateEvent, SupportedFeatures, SupportStatus, TableData, TableRowLabels, TableSchema, TableSelection } from './positronDataExplorerComm.js';
+import { ArraySelection, BackendState, CodeSyntaxOptions, ColumnFilter, ColumnProfileRequest, ColumnProfileResult, ColumnSchema, ColumnSelection, ColumnSortKey, DataExplorerFrontendEvent, DataUpdateEvent, ExportedCode, ExportedData, ExportFormat, FilterResult, FormatOptions, ReturnColumnProfilesEvent, RowFilter, SchemaUpdateEvent, SupportedFeatures, SupportStatus, TableData, TableRowLabels, TableSchema, TableSelection } from './positronDataExplorerComm.js';
 
 /**
  * TableSchemaSearchResult interface. This is here temporarily until searching the tabe schema
@@ -66,6 +66,8 @@ export interface IDataExplorerBackendClient extends Disposable {
 	getDataValues(columns: Array<ColumnSelection>, formatOptions: FormatOptions): Promise<TableData>;
 	getRowLabels(selection: ArraySelection, formatOptions: FormatOptions): Promise<TableRowLabels>;
 	exportDataSelection(selection: TableSelection, format: ExportFormat): Promise<ExportedData>;
+	getCodeSyntaxes(): Promise<CodeSyntaxOptions>;
+	translateToCode(columnFilters: Array<ColumnFilter>, rowFilters: Array<RowFilter>, sortKeys: Array<ColumnSortKey>, exportOptions: string): Promise<ExportedCode>;
 	setColumnFilters(filters: Array<ColumnFilter>): Promise<void>;
 	setRowFilters(filters: Array<RowFilter>): Promise<FilterResult>;
 	setSortColumns(sortKeys: Array<ColumnSortKey>): Promise<void>;
@@ -496,6 +498,32 @@ export class DataExplorerClientInstance extends Disposable {
 		}
 	}
 
+
+	async translateToCode(desiredSyntax: string): Promise<ExportedCode> {
+		const state = await this.getBackendState();
+		//const codeTypes = await this.getCodeTypes();
+
+		const columnFilters: Array<ColumnFilter> = state.column_filters;
+		const rowFilters: Array<RowFilter> = state.row_filters;
+		const sortKeys: Array<ColumnSortKey> = state.sort_keys;
+
+		return this.runBackendTask(
+			() => this._backendClient.translateToCode(columnFilters, rowFilters, sortKeys, desiredSyntax),
+			() => ({ 'data': '' })
+		);
+	}
+
+	/**
+	 * Get the code syntaxes supported for export.
+	 * @returns A promise that resolves to the available code syntaxes.
+	 */
+	async getCodeSyntaxes(): Promise<CodeSyntaxOptions> {
+		return this.runBackendTask(
+			() => this._backendClient.getCodeSyntaxes(),
+			() => ({ code_syntaxes: [] })
+		);
+	}
+
 	//#endregion Public Methods
 
 	//#region Private Methods