exclude list for variable viewer (microsoft#5186)

IanMatthewHuff · web-flow · commit 64f8c9d93f33 · 2019-04-10T12:38:25.000-07:00
diff --git a/news/1 Enhancements/5104.md b/news/1 Enhancements/5104.md
@@ -0,0 +1 @@
+Add exclude list to variable viewer
diff --git a/package.json b/package.json
@@ -1388,6 +1388,12 @@
                     "description": "Show the variable explorer in the Python Interactive window. (experimental)",
                     "scope": "resource"
                 },
+                "python.dataScience.variableExplorerExclude": {
+                    "type": "string",
+                    "default": "module;builtin_function_or_method",
+                    "description": "Types to exclude from showing in the Python Interactive variable explorer",
+                    "scope": "resource"
+                },
                 "python.dataScience.codeRegularExpression": {
                     "type": "string",
                     "default": "^(#\\s*%%|#\\s*\\<codecell\\>|#\\s*In\\[\\d*?\\]|#\\s*In\\[ \\])",
diff --git a/pythonFiles/datascience/getJupyterVariableList.py b/pythonFiles/datascience/getJupyterVariableList.py
@@ -1,13 +1,17 @@
 # Query Jupyter server for defined variables list
 # Tested on 2.7 and 3.6
-from sys import getsizeof
+from sys import getsizeof as _VSCODE_getsizeof
 import json as _VSCODE_json
 
 # who_ls is a Jupyter line magic to fetch currently defined vars
 _VSCode_JupyterVars = %who_ls
 
 print(_VSCODE_json.dumps([{'name': var,
                                'type': type(eval(var)).__name__,
-                               'size': getsizeof(var),
+                               'size': _VSCODE_getsizeof(var),
                                'expensive': True
                               } for var in _VSCode_JupyterVars]))
+
+del _VSCode_JupyterVars
+del _VSCODE_json
+del _VSCODE_getsizeof
diff --git a/pythonFiles/datascience/getJupyterVariableValue.py b/pythonFiles/datascience/getJupyterVariableValue.py
@@ -22,4 +22,11 @@
 else:
     _VSCODE_targetVariable['value'] = _VSCODE_targetValue
 
-print(_VSCODE_json.dumps(_VSCODE_targetVariable))
+print(_VSCODE_json.dumps(_VSCODE_targetVariable))
+
+# Cleanup
+del _VSCODE_max_len
+del _VSCODE_json
+del _VSCODE_targetVariable
+del _VSCODE_evalResult
+del _VSCODE_targetValue
diff --git a/src/client/common/types.ts b/src/client/common/types.ts
@@ -303,6 +303,7 @@ export interface IDataScienceSettings {
     errorBackgroundColor: string;
     ignoreVscodeTheme?: boolean;
     showJupyterVariableExplorer?: boolean;
+    variableExplorerExclude?: string;
 }
 
 export const IConfigurationService = Symbol('IConfigurationService');
diff --git a/src/client/datascience/history/history.ts b/src/client/datascience/history/history.ts
@@ -920,7 +920,18 @@ export class History extends WebViewHost<IHistoryMapping> implements IHistory  {
 
     private requestVariables = async (): Promise<void> => {
         // Request our new list of variables
-        const vars: IJupyterVariable[] = await this.jupyterVariables.getVariables();
+        let vars: IJupyterVariable[] = await this.jupyterVariables.getVariables();
+
+        const settings = this.configuration.getSettings();
+        const excludeString = settings.datascience.variableExplorerExclude;
+
+        if (excludeString) {
+            const excludeArray = excludeString.split(';');
+            vars = vars.filter((value) => {
+               return excludeArray.indexOf(value.type) === -1;
+            });
+        }
+
         this.postMessage(HistoryMessages.GetVariablesResponse, vars).ignoreErrors();
     }
 

Original file line number	Diff line number	Diff line change
`@@ -303,6 +303,7 @@ export interface IDataScienceSettings {`
`303`	`303`	`errorBackgroundColor: string;`
`304`	`304`	`ignoreVscodeTheme?: boolean;`
`305`	`305`	`showJupyterVariableExplorer?: boolean;`
	`306`	`+ variableExplorerExclude?: string;`
`306`	`307`	`}`
`307`	`308`
`308`	`309`	`export const IConfigurationService = Symbol('IConfigurationService');`