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,
+    CodeSyntax,
     ColumnDisplayType,
     ColumnFilter,
     ColumnFilterType,
@@ -69,6 +70,7 @@
     GetRowLabelsRequest,
     GetSchemaRequest,
     GetStateRequest,
+    GuessCodeSyntaxRequest,
     RowFilter,
     RowFilterCondition,
     RowFilterType,
@@ -94,6 +96,8 @@
     TableSelectionKind,
     TableShape,
     TextSearchType,
+    TranslatedCode,
+    TranslateToCodeRequest,
 )
 from .positron_comm import CommMessage, PositronComm
 from .utils import BackgroundJobQueue, guid
@@ -282,6 +286,12 @@
     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
@@ -805,6 +815,7 @@
             support_status=SupportStatus.Unsupported,
             supported_formats=[],
         ),
+        code_syntaxes=["pandas", "polars"],
     )
 
 
@@ -1351,6 +1362,16 @@
 
         return schema_updated, new_state
 
+    def guess_code_syntax(self, request: GuessCodeSyntaxRequest):  # noqa: ARG002
+        """Returns the supported code types for exporting data."""
+        return CodeSyntax(code_syntax="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 TranslatedCode(
+            translated_code=["import pandas as pd", "# TODO: Implement export to code"]
+        ).dict()
+
     @classmethod
     def _construct_schema(
         cls, column, column_name, column_index: int, state: DataExplorerState
@@ -1912,6 +1933,7 @@
                 ExportFormat.Html,
             ],
         ),
+        code_syntaxes=["pandas"],
     )
 
 
@@ -2281,6 +2303,16 @@
 
         return schema_updated, new_state
 
+    def guess_code_syntax(self, request: GuessCodeSyntaxRequest):  # noqa: ARG002
+        """Returns the supported code types for exporting data."""
+        return CodeSyntax(code_syntax="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 TranslatedCode(
+            translated_code=["import polars as pl", "# 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]
@@ -2763,6 +2795,7 @@
             supported_formats=[ExportFormat.Csv, ExportFormat.Tsv],
         ),
         set_sort_columns=SetSortColumnsFeatures(support_status=SupportStatus.Supported),
+        code_syntaxes=["polars"],
     )
 
 

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

@@ -252,6 +252,27 @@ class ExportedData(BaseModel):
     )
 
 
+class TranslatedCode(BaseModel):
+    """
+    Code snippet for the data view
+    """
+
+    translated_code: List[StrictStr] = Field(
+        description="Lines of code translating filters and sort keys",
+    )
+
+
+class CodeSyntax(BaseModel):
+    """
+    Best guess of syntax to use for code translation
+    """
+
+    code_syntax: Optional[StrictStr] = Field(
+        default=None,
+        description="Best guess of syntax to use for code translation",
+    )
+
+
 class FilterResult(BaseModel):
     """
     The result of applying filters to a table
@@ -972,6 +993,10 @@ class SupportedFeatures(BaseModel):
         description="Support for 'export_data_selection' RPC and its features",
     )
 
+    code_syntaxes: List[StrictStr] = Field(
+        description="List of supported code syntax names",
+    )
+
 
 class SearchSchemaFeatures(BaseModel):
     """
@@ -1208,6 +1233,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"
+
+    # Guess code syntax for code translation
+    GuessCodeSyntax = "guess_code_syntax"
+
     # Set column filters to select subset of table columns
     SetColumnFilters = "set_column_filters"
 
@@ -1422,6 +1453,64 @@ 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 GuessCodeSyntaxRequest(BaseModel):
+    """
+    Guess desired code syntax for translation of a data view based on type
+    """
+
+    method: Literal[DataExplorerBackendRequest.GuessCodeSyntax] = Field(
+        description="The JSON-RPC method name (guess_code_syntax)",
+    )
+
+    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 +1664,8 @@ class DataExplorerBackendMessageContent(BaseModel):
         GetDataValuesRequest,
         GetRowLabelsRequest,
         ExportDataSelectionRequest,
+        TranslateToCodeRequest,
+        GuessCodeSyntaxRequest,
         SetColumnFiltersRequest,
         SetRowFiltersRequest,
         SetSortColumnsRequest,
@@ -1623,6 +1714,10 @@ class ReturnColumnProfilesParams(BaseModel):
 
 ExportedData.update_forward_refs()
 
+TranslatedCode.update_forward_refs()
+
+CodeSyntax.update_forward_refs()
+
 FilterResult.update_forward_refs()
 
 BackendState.update_forward_refs()
@@ -1741,6 +1836,12 @@ class ReturnColumnProfilesParams(BaseModel):
 
 ExportDataSelectionRequest.update_forward_refs()
 
+TranslateToCodeParams.update_forward_refs()
+
+TranslateToCodeRequest.update_forward_refs()
+
+GuessCodeSyntaxRequest.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": "translated_code",
+					"type": "object",
+					"description": "Code snippet for the data view",
+					"required": [
+						"translated_code"
+					],
+					"properties": {
+						"translated_code": {
+							"type": "array",
+							"description": "Lines of code translating filters and sort keys",
+							"items": {
+								"type": "string"
+							}
+						}
+					}
+				}
+			}
+		},
+{
+			"name": "guess_code_syntax",
+			"summary": "Guess code syntax for code translation",
+			"description": "Guess desired code syntax for translation of a data view based on type",
+			"params": [],
+			"result": {
+				"schema": {
+					"name": "code_syntax",
+					"type": "object",
+					"description": "Best guess of syntax to use for code translation",
+					"required": [
+						"code_syntaxes"
+					],
+					"properties": {
+						"code_syntax": {
+							"type": "string",
+							"description": "Best guess of syntax to use for code translation"
+						}
+					}
+				}
+			}
+		},
 		{
 			"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,9 @@
 					"set_row_filters",
 					"get_column_profiles",
 					"set_sort_columns",
-					"export_data_selection"
+					"export_data_selection",
+					"export_as_code",
+					"code_syntaxes"
 				],
 				"properties": {
 					"search_schema": {
@@ -1328,6 +1426,13 @@
 					"export_data_selection": {
 						"description": "Support for 'export_data_selection' RPC and its features",
 						"$ref": "#/components/schemas/export_data_selection_features"
+					},
+					"code_syntaxes": {
+						"type": "array",
+						"description": "List of supported code syntax names",
+						"items": {
+							"type": "string"
+						}
 					}
 				}
 			},