[ui] Python Script Editor Improvements #2587

waaake · 2024-10-28T10:42:36Z

Description

ScriptEditor Improvements

Features list

Script Editor now retains history of the code which is executed across Meshroom sessions.
Script Editor also highlights the code Syntax for Python
The output clearly distinguishes between executed code and the result of the code with different colors.

cbentejac · 2024-11-15T16:41:12Z

meshroom/ui/qml/GraphEditor/ScriptEditor.qml

-                horizontalAlignment: Text.AlignHCenter
-                Layout.fillWidth: true
-            }
+        MSplitView {


This needs to be discussed but I wonder if it wouldn't be better to have the split view be horizontal instead of vertical... As such, it's is pretty much unusable unless we expand the Script Editor's tab, which may not be ideal.

Thanks for your feedback @cbentejac, I do agree with how the widgets are placed in Meshroom at the moment, the best layout is a RowLayout.
Have reverted back in terms of Layout and I guess we can keep it till the time we have a better location/placement of Script Editor.

waaake · 2024-12-12T15:35:50Z

Thanks for the suggestions @yann-lty
I have added a confirmation dialog for clearing the history, let me know how these new icons feel.

…xceptions ScriptEditorManager now also allows the code to be saved and retrieved back. Exceptions are now shown with a better output to the user.

ScriptEditor is now part of a ColumnLayout in an MSplitView allowing more control over what is being viewed.

Python syntax within the script editor is now highlighted making it easier to understand and write smaller code in it.

…xpression

A Row Layout is more practical for using script editor with the current placement of meshroom GUI.

Updated Icons for ScriptEditor Script Editor shows a confirmation dialog before clearing history

codecov · 2025-01-07T04:11:23Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.93%. Comparing base (e43cd62) to head (7384db8).
Report is 23 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #2587   +/-   ##
========================================
  Coverage    69.93%   69.93%           
========================================
  Files          121      121           
  Lines         7088     7088           
========================================
  Hits          4957     4957           
  Misses        2131     2131

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

fabiencastan · 2025-01-07T22:53:18Z

meshroom/ui/qml/GraphEditor/ScriptEditor.qml

+         */
+
+        // Replace the text to be RichText Supportive
+        return "<font color=#49a1f3>" + "Result: " + replace(text, "\n", "<br>") + "</font><br><br>"


Suggested change

return "" + "Result: " + replace(text, "\n", " ") + " "

return "> Result: " + replace(text, "\n", " ") + " "

fabiencastan · 2025-01-07T22:53:35Z

meshroom/ui/qml/GraphEditor/ScriptEditor.qml

+         */
+
+        // Replace the text to be RichText Supportive
+        return "<font color=#868686>" + replace(text, "\n", "<br>") + "</font><br><br>"


Suggested change

return "" + replace(text, "\n", " ") + " "

return ">Input: " + replace(text, "\n", " ") + " "

fabiencastan

We cannot scroll to see the end of the text:

…flickables Formatted the input and output text for output display text area

fabiencastan · 2025-01-09T10:36:17Z

font size for icons is too big:

fabiencastan · 2025-01-09T10:44:17Z

On execution, we should scroll the output to the end.

fabiencastan · 2025-01-09T11:04:32Z

I would propose to update the order of the icons:

Groups all the actions related to the script, center the execution, and align to the right the clear.

Or:

fabiencastan · 2025-01-09T11:06:06Z

Could it be a SplitView between the Editor and the Output.

fabiencastan · 2025-01-09T18:41:25Z

Maybe also disable the button if there is no action to perform on the "Get Previous/Next Script".

fabiencastan · 2025-01-09T19:14:17Z

The first click on "Get Previous Script" is not working. You need to click a second time to do the action.

…of scripts hasPreviousScript and hasNextScript are getters for history if that is available

waaake · 2025-01-10T07:28:39Z

The first click on "Get Previous Script" is not working. You need to click a second time to do the action.

It feels like that actually, but it is actually working,
If I executed the below example:
print("A")

Then I executed
print("B")
Clicked on Get Previous Script,
it gets back print("B")

but I would not notice any difference because my current text in script editor input is still print("B") so I have to click on it two times to get it back to print("A")

I think in the first version of script editor we used to clear the input as soon as it was executed so this made it work as expected but now that we're not clearing the script contents, it feels like this is not working....
🙁

fabiencastan · 2025-01-10T21:12:57Z

It would be good to scroll the output to the end on execution.

fabiencastan · 2025-01-10T21:15:06Z

It looks surprising to me that clearing the history is not only clearing the history but also the current code in the script editor.

But if I close and re-open Meshroom, this code is back magically (so the history has not been fully cleared). If we do not remove the current code, then it would be fine to have it when you close and re-open.

fabiencastan · 2025-01-10T21:30:01Z

meshroom/ui/qml/GraphEditor/ScriptEditor.qml

-            Layout.fillHeight: true
-            width: root.width
+        MSplitView {
+            id: scriptSplitView;


I think we do not put the extra ";" in general.

waaake requested review from fabiencastan and cbentejac October 28, 2024 10:42

waaake self-assigned this Oct 28, 2024

cbentejac added this to the Meshroom 2024.1.0 milestone Oct 28, 2024

cbentejac reviewed Nov 15, 2024

View reviewed changes

waaake marked this pull request as draft November 26, 2024 11:28

waaake force-pushed the dev/PythonScriptEditor branch from 2bd93ff to 52b52b8 Compare November 26, 2024 14:47

waaake marked this pull request as ready for review November 26, 2024 14:48

waaake force-pushed the dev/PythonScriptEditor branch from 52b52b8 to dd40d93 Compare December 12, 2024 15:33

waaake requested a review from yann-lty December 12, 2024 15:34

waaake force-pushed the dev/PythonScriptEditor branch from dd40d93 to d0ecb8a Compare December 12, 2024 15:38

waaake added 6 commits January 7, 2025 09:25

[ui] ScriptEditor: Updated Core ScriptEditor Manager to show better e…

8984aac

…xceptions ScriptEditorManager now also allows the code to be saved and retrieved back. Exceptions are now shown with a better output to the user.

[ui] ScriptEditor: Updated Script Editor layout

4464cdf

ScriptEditor is now part of a ColumnLayout in an MSplitView allowing more control over what is being viewed.

[ui] ScriptEditor: Added syntax colorization for the script editor

2e57727

Python syntax within the script editor is now highlighted making it easier to understand and write smaller code in it.

[ui] Qt6 Compatibility for ScriptEditor: Updated QRegexp -> QRegularE…

0730936

…xpression

[ui] ScriptEditor: ScriptEditor gets a RowLayout

8207e84

A Row Layout is more practical for using script editor with the current placement of meshroom GUI.

[ui] ScriptEditor: ScriptEditor gets new icons

49052df

Updated Icons for ScriptEditor Script Editor shows a confirmation dialog before clearing history

waaake force-pushed the dev/PythonScriptEditor branch from d0ecb8a to 49052df Compare January 7, 2025 04:08

fabiencastan reviewed Jan 7, 2025

View reviewed changes

[ui] ScriptEditor: Updated the content width of the input and output …

a90d5c4

…flickables Formatted the input and output text for output display text area

waaake added 3 commits January 10, 2025 07:43

[ui] ScriptEditorManager: Added properties to get if we have history …

9fa7724

…of scripts hasPreviousScript and hasNextScript are getters for history if that is available

[ui] ScriptEditor: Adjusted Icon Size and Layout

1b963ab

[ui] ScriptEditor: Updated to Use Horizontal MSplitView

7384db8

fabiencastan added the majorFeature label Jan 10, 2025

fabiencastan reviewed Jan 10, 2025

View reviewed changes

fabiencastan approved these changes Jan 10, 2025

View reviewed changes

fabiencastan merged commit 3e8b736 into develop Jan 10, 2025
5 checks passed

fabiencastan deleted the dev/PythonScriptEditor branch January 10, 2025 21:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ui] Python Script Editor Improvements #2587

[ui] Python Script Editor Improvements #2587

waaake commented Oct 28, 2024

cbentejac Nov 15, 2024

waaake Nov 26, 2024

waaake commented Dec 12, 2024

codecov bot commented Jan 7, 2025 •

edited

Loading

fabiencastan Jan 7, 2025 •

edited

Loading

fabiencastan Jan 7, 2025 •

edited

Loading

fabiencastan left a comment

fabiencastan commented Jan 9, 2025

fabiencastan commented Jan 9, 2025

fabiencastan commented Jan 9, 2025

fabiencastan commented Jan 9, 2025

fabiencastan commented Jan 9, 2025

fabiencastan commented Jan 9, 2025

waaake commented Jan 10, 2025

fabiencastan commented Jan 10, 2025

fabiencastan commented Jan 10, 2025 •

edited

Loading

fabiencastan Jan 10, 2025

	return "<font color=#49a1f3>" + "Result: " + replace(text, "\n", "<br>") + "</font><br><br>"
	return "<font color=#49a1f3>> Result:<br>" + replace(text, "\n", "<br>") + "</font><br>"

	return "<font color=#868686>" + replace(text, "\n", "<br>") + "</font><br><br>"
	return "<font color=#868686>>Input:<br>" + replace(text, "\n", "<br>") + "</font><br>"

[ui] Python Script Editor Improvements #2587

[ui] Python Script Editor Improvements #2587

Conversation

waaake commented Oct 28, 2024

Description

ScriptEditor Improvements

Features list

cbentejac Nov 15, 2024

Choose a reason for hiding this comment

waaake Nov 26, 2024

Choose a reason for hiding this comment

waaake commented Dec 12, 2024

codecov bot commented Jan 7, 2025 • edited Loading

Codecov Report

fabiencastan Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

fabiencastan Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

fabiencastan left a comment

Choose a reason for hiding this comment

fabiencastan commented Jan 9, 2025

fabiencastan commented Jan 9, 2025

fabiencastan commented Jan 9, 2025

fabiencastan commented Jan 9, 2025

fabiencastan commented Jan 9, 2025

fabiencastan commented Jan 9, 2025

waaake commented Jan 10, 2025

fabiencastan commented Jan 10, 2025

fabiencastan commented Jan 10, 2025 • edited Loading

fabiencastan Jan 10, 2025

Choose a reason for hiding this comment

codecov bot commented Jan 7, 2025 •

edited

Loading

fabiencastan Jan 7, 2025 •

edited

Loading

fabiencastan Jan 7, 2025 •

edited

Loading

fabiencastan commented Jan 10, 2025 •

edited

Loading