Support inlay hints (#7898)

* support inlay hints * make hotkeys unique * address feedback
microsoft · May 15, 2024 · afafd41 · afafd41
1 parent a7f06e6
commit afafd41
Show file tree

Hide file tree

Showing 7 changed files with 251 additions and 89 deletions.
diff --git a/Python/Product/Common/Strings.Designer.cs b/Python/Product/Common/Strings.Designer.cs
diff --git a/Python/Product/Common/Strings.resx b/Python/Product/Common/Strings.resx
@@ -3444,4 +3444,10 @@ Please specify at least one package.</value>
   <data name="ImportFormatToolTip" xml:space="preserve">
     <value>Defines the default format for import module.</value>
   </data>
+  <data name="InlayHintsFunctionReturnTypesToolTip" xml:space="preserve">
+    <value>Toggle inlay hints for function return types.</value>
+  </data>
+  <data name="InlayHintsVariableTypeToolTip" xml:space="preserve">
+    <value>Toggle inlay hints for variable types.</value>
+  </data>
 </root>
diff --git a/Python/Product/PythonTools/PythonTools/LanguageServerClient/PythonLanguageClient.cs b/Python/Product/PythonTools/PythonTools/LanguageServerClient/PythonLanguageClient.cs
@@ -429,8 +429,8 @@ private LanguageServerSettings.PythonSettings GetSettings(Uri scopeUri = null)
                     extraCommitChars = false,
                     importFormat = _analysisOptions.ImportFormat,
                     inlayHints = new LanguageServerSettings.PythonSettings.PythonAnalysisSettings.PythonAnalysisInlayHintsSettings {
-                        variableTypes = false,
-                        functionReturnTypes = false
+                        variableTypes = _analysisOptions.InlayHintsVariableTypes,
+                        functionReturnTypes = _analysisOptions.InlayHintsFunctionReturnTypes
                     },
                     taskListTokens = taskListTokens.ToArray()
                 }

diff --git a/Python/Product/PythonTools/PythonTools/Options/PythonAnalysisOptions.cs b/Python/Product/PythonTools/PythonTools/Options/PythonAnalysisOptions.cs
@@ -34,6 +34,8 @@ public sealed class PythonAnalysisOptions {
         public string[] ExtraPaths { get; set; }
         public bool Indexing { get; set; }
         public string ImportFormat { get; set; }
+        public bool InlayHintsVariableTypes { get; set; }
+        public bool InlayHintsFunctionReturnTypes {get; set;}
 
         internal PythonAnalysisOptions(PythonToolsService service) {
             _service = service;
@@ -102,6 +104,18 @@ public void Load() {
                 changed = true;
             }
 
+            var inlayHintsVariableTypes = _service.LoadBool(nameof(InlayHintsVariableTypes), Category) ?? false;
+            if (InlayHintsVariableTypes != inlayHintsVariableTypes) { 
+                InlayHintsVariableTypes = inlayHintsVariableTypes;
+                changed = true;
+            }
+
+            var inlayHintsFunctionReturnTypes = _service.LoadBool(nameof(InlayHintsFunctionReturnTypes), Category) ?? false;
+            if (InlayHintsFunctionReturnTypes != inlayHintsFunctionReturnTypes) {
+                InlayHintsFunctionReturnTypes = inlayHintsFunctionReturnTypes;
+                changed = true;
+            }
+
             if (changed) {
                 Changed?.Invoke(this, EventArgs.Empty);
             }
@@ -118,6 +132,8 @@ public void Save() {
             changed |= _service.SaveBool(nameof(UseLibraryCodeForTypes), Category, UseLibraryCodeForTypes);
             changed |= _service.SaveBool(nameof(Indexing), Category, Indexing);
             changed |= _service.SaveString(nameof(ImportFormat), Category, ImportFormat);
+            changed |= _service.SaveBool(nameof(InlayHintsVariableTypes), Category, InlayHintsVariableTypes);
+            changed |= _service.SaveBool(nameof(InlayHintsFunctionReturnTypes), Category, InlayHintsFunctionReturnTypes);
             if (changed) {
                 Changed?.Invoke(this, EventArgs.Empty);
             }
@@ -133,6 +149,8 @@ public void Reset() {
             UseLibraryCodeForTypes = true;
             Indexing = false;
             ImportFormat = PylanceImportFormat.Absolute;
+            InlayHintsVariableTypes = false;
+            InlayHintsFunctionReturnTypes = false;
             Changed?.Invoke(this, EventArgs.Empty);
         }
 

diff --git a/Python/Product/PythonTools/PythonTools/Options/PythonAnalysisOptionsControl.Designer.cs b/Python/Product/PythonTools/PythonTools/Options/PythonAnalysisOptionsControl.Designer.cs
diff --git a/Python/Product/PythonTools/PythonTools/Options/PythonAnalysisOptionsControl.cs b/Python/Product/PythonTools/PythonTools/Options/PythonAnalysisOptionsControl.cs
@@ -49,6 +49,9 @@ public PythonAnalysisOptionsControl() {
             _importFormatCombo.Items.Add(Strings.ImportFormatAbsolute);
             _importFormatCombo.Items.Add(Strings.ImportFormatRelative);
             _importFormatToolTip.SetToolTip(_importFormatCombo, Strings.ImportFormatToolTip);
+
+            _inlayHintsVariableTypesToolTip.SetToolTip(_inlayHintsVariableTypes, Strings.InlayHintsVariableTypeToolTip);
+            _inlayHintsFunctionReturnTypeToolTip.SetToolTip(_inlayHintsFunctionReturnTypes, Strings.InlayHintsFunctionReturnTypesToolTip);
         }
 
         internal void SyncControlWithPageSettings(PythonToolsService pyService) {
@@ -59,6 +62,8 @@ internal void SyncControlWithPageSettings(PythonToolsService pyService) {
 
             _autoSearchPath.Checked = pyService.AnalysisOptions.AutoSearchPaths;
             _indexing.Checked = pyService.AnalysisOptions.Indexing;
+            _inlayHintsVariableTypes.Checked = pyService.AnalysisOptions.InlayHintsVariableTypes;
+            _inlayHintsFunctionReturnTypes.Checked = pyService.AnalysisOptions.InlayHintsFunctionReturnTypes;
             _diagnosticsModeCombo.SelectedIndex =
                 pyService.AnalysisOptions.DiagnosticMode == PylanceDiagnosticMode.OpenFilesOnly ? 0 : 1;
             _importFormatCombo.SelectedIndex =
@@ -98,6 +103,8 @@ internal void SyncPageWithControlSettings(PythonToolsService pyService) {
 
             pyService.AnalysisOptions.AutoSearchPaths = _autoSearchPath.Checked;
             pyService.AnalysisOptions.Indexing = _indexing.Checked;
+            pyService.AnalysisOptions.InlayHintsVariableTypes = _inlayHintsVariableTypes.Checked;
+            pyService.AnalysisOptions.InlayHintsFunctionReturnTypes = _inlayHintsFunctionReturnTypes.Checked;
             pyService.AnalysisOptions.DiagnosticMode = _diagnosticsModeCombo.SelectedIndex == 0 ?
                 PylanceDiagnosticMode.OpenFilesOnly : PylanceDiagnosticMode.Workspace;
             pyService.AnalysisOptions.ImportFormat = _importFormatCombo.SelectedIndex == 0 ?