Tab with spaces when using Python 3 (#11010)

mmisol · web-flow · commit 236a43b7b51e · 2020-08-18T08:32:56.000-04:00
The Python text editor now inserts spaces when the tab key is pressed
if the engine is not 'IronPython2'. This is done in order to remain
consistent with the reindent that occurs in 2to3 migration, which will
avoid errors from Python 3 complaining about mixing spaces and tabs.
diff --git a/src/Libraries/PythonNodeModelsWpf/ScriptEditorWindow.xaml.cs b/src/Libraries/PythonNodeModelsWpf/ScriptEditorWindow.xaml.cs
@@ -207,6 +207,8 @@ private void OnEngineChanged(object sender, System.Windows.Controls.SelectionCha
             {
                 UpdateScript(editText.Text);
             }
+
+            editText.Options.ConvertTabsToSpaces = nodeModel.Engine != PythonEngineVersion.IronPython2;
         }
 
         private void OnScriptEditorWindowClosed(object sender, EventArgs e)
diff --git a/test/DynamoCoreWpfTests/PythonNodeCustomizationTests.cs b/test/DynamoCoreWpfTests/PythonNodeCustomizationTests.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Windows;
 using System.Windows.Controls;
+using System.Windows.Input;
 using Dynamo.Controls;
 using Dynamo.Graph.Workspaces;
 using Dynamo.Utilities;
@@ -136,6 +137,16 @@ public void ChangingDropdownEngineSavesCodeBeforeRunning()
             DispatcherUtil.DoEvents();
         }
 
+        private static ICSharpCode.AvalonEdit.TextEditor FindCodeEditor(ScriptEditorWindow view)
+        {
+            DispatcherUtil.DoEvents();
+            var windowGrid = view.Content as Grid;
+            var codeEditor = windowGrid
+                .ChildrenOfType<ICSharpCode.AvalonEdit.TextEditor>()
+                .First();
+            return codeEditor;
+        }
+
         private static ComboBox FindEditorDropDown(ScriptEditorWindow view)
         {
             DispatcherUtil.DoEvents();
@@ -324,5 +335,54 @@ public void WorkspaceWithMultiplePythonEnginesUpdatesCorrectlyViaContextHandler(
             DispatcherUtil.DoEvents();
             
         }
+
+        [Test]
+        public void TabWithSpacesMatchesEngine()
+        {
+            // Arrange
+            Open(@"core\python\python.dyn");
+
+            var nodeView = NodeViewWithGuid("3bcad14e-d086-4278-9e08-ed2759ef92f3");
+            var nodeModel = nodeView.ViewModel.NodeModel as PythonNodeBase;
+            Assert.NotNull(nodeModel);
+
+            var scriptWindow = EditPythonCode(nodeView, View);
+            var codeEditor = FindCodeEditor(scriptWindow);
+            var engineSelectorComboBox = FindEditorDropDown(scriptWindow);
+
+            Assert.AreEqual(PythonEngineVersion.IronPython2, engineSelectorComboBox.SelectedItem);
+
+            // Act
+            codeEditor.Focus();
+            codeEditor.SelectionStart = 0;
+            var textArea = Keyboard.FocusedElement;
+            textArea.RaiseEvent(new KeyEventArgs(
+                Keyboard.PrimaryDevice,
+                PresentationSource.FromVisual(codeEditor),
+                0,
+                Key.Tab)
+                {
+                    RoutedEvent = Keyboard.KeyDownEvent
+                }
+            );
+            DispatcherUtil.DoEvents();
+
+            engineSelectorComboBox.SelectedItem = PythonEngineVersion.CPython3;
+
+            codeEditor.SelectionStart = 0;
+            textArea.RaiseEvent(new KeyEventArgs(
+                Keyboard.PrimaryDevice,
+                PresentationSource.FromVisual(codeEditor),
+                0,
+                Key.Tab)
+            {
+                RoutedEvent = Keyboard.KeyDownEvent
+            }
+            );
+            DispatcherUtil.DoEvents();
+
+            // Assert
+            StringAssert.StartsWith("    \t", codeEditor.Text);
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -207,6 +207,8 @@ private void OnEngineChanged(object sender, System.Windows.Controls.SelectionCha`
`207`	`207`	`{`
`208`	`208`	`UpdateScript(editText.Text);`
`209`	`209`	`}`
	`210`	`+`
	`211`	`+ editText.Options.ConvertTabsToSpaces = nodeModel.Engine != PythonEngineVersion.IronPython2;`
`210`	`212`	`}`
`211`	`213`
`212`	`214`	`private void OnScriptEditorWindowClosed(object sender, EventArgs e)`