Model Editor Bug Fixes #2901

tsole0 · 2024-06-21T17:04:09Z

Description

Fixes minor bugs in the model editor (PluginDefinition.py and its parent TabbedModelEditor.py) that impede usability or cause undesirable effects.

Generates error message when user neglects to input a model name (84e4ebe)
- Fixes behavior where a model syntax error (bad unicode) is thrown instead, which is unintuitive
Allows user to create model even if default function text is unedited (b4c8f8c, bf3b57a)
- Fixes bug in which user had to perform an edit action in the function box before model could be saved
Changed behavior of model parameter tables in GUI (01b286c)
- Previously would add new rows to tables even if no parameters were changed and would create unnecessary amounts of blank rows that could not be deleted
- Previously new rows would be generated only after editing a parameter's value box and not the name of the parameter itself
Fixes Investigate why the Model Editor is not applying the test on Apply #1633 by ensuring both model and syntax checks are applied to user models regardless of whether they are defined using PluginDefinition or ModelEditor (558c7a1, 54a8aaf, 2b71022)
- Note: Previously, only syntax was checked when using ModelEditor and only model tests were run when using PluginDefinition. The syntax checks were done using the ast library, which only checks for SyntaxErrors. I have kept this check as the first one that runs because it can often catch SyntaxErrors with more precision than using GuiUtils.checkModel(). In theory we don't need to run the ast check on models generated with the plugin editor, but it doesn't seem to add significant overhead and could even be useful if future changes break the model template.
Fixes bug that prevented user from viewing/editng C model associated with a Python file if the C model contained errors when loading into the model editor. (eb3dee0, 14d1e0a)
- New behavior: shows popup warning the user that the model loaded into the editor contains errors and must be fixed before using
Fixes bug causing font to change in the function definition textbox if the user deleted all its text (788433b)
- Note: bug was fixed by changing default text in box to Consolas, which is a Microsoft font. The fix still works on my Mac, however, probably because the system knows to substitute a similar monospace font. Even if the fix didn't work on Linux, this change should only make things better and I highly doubt it would create a worse result than before.

How Has This Been Tested?

Verified correct behavior in SasView and checked wide variety of possible user inputs to search for additional bugs. Windows installer tested and verified.

Review Checklist:

Documentation (check at least one)

There is nothing that needs documenting
Documentation changes are in this PR
There is an issue open for the documentation (link?)

Installers

There is a chance this will affect the installers, if so
- Windows installer (GH artifact) has been tested (installed and worked)
- MacOSX installer (GH artifact) has been tested (installed and worked)

Licensing (untick if necessary)

The introduced changes comply with SasView license (BSD 3-Clause)

…l file to generate

…model file before approving it; condense into checkModel method

…o checkModel in previous commit

…with C code. Clear highlights from both python and C windows if checks pass. Ensure that checkModel() is always passed a path argument instead of raw text.

… by removing os.remove(). allow user to load .c models into editor even if .c file fails model checks

…l-editor-bug-fixes

tsole0 · 2024-07-01T19:44:13Z

Converting back to draft until 6.0.0 bug fix branch is created

…-bug-fixes

krzywon

Functionally, this almost does what it says it does, but I'm not 100% certain this fixes #1633.

If params are in the model text, but not defined in the param table, an error is displayed, but the model file is stil generated. This causes issues when correcting the model if the overwrite option is not selected. I'm not sure if this is the expected behavior or not. @rozyczko, what do you think?

src/sas/qtgui/Utilities/PluginDefinition.py

krzywon · 2024-10-28T21:37:03Z

Please note - I am planning to fix the issues I've found here.

…arams in the model editor window

krzywon

Functionally, this almost does what it says it does, but I'm not 100% certain this fixes #1633.

This fixes the issue.

If params are in the model text, but not defined in the param table, an error is displayed, but the model file is stil generated. This causes issues when correcting the model if the overwrite option is not selected. I'm not sure if this is the expected behavior or not.

This is a bigger fix than expected and should not hold up this PR. Many of the underlying checks require the file to exist, so I think this is ready.

pkienzle

Code looks okay. I didn't test functionality.

pkienzle · 2025-02-11T17:09:40Z

src/sas/qtgui/Utilities/TabbedModelEditor.py

-            for line in reversed(all_lines):
-                if 'File' in line and 'line' in line:
+            reversed_error_text = list(reversed(all_lines))
+            for line in reversed_error_text:


Better to use iterator form for line in reversed(all_lines) rather than turning it into a list that you are just going to throw away.

If you do need to assign an iterator to a variable, wrapping it in a tuple is a good defensive practice. Too often I've tried to reuse a sequence only to find that it empty the second time I traverse it. Tuples are immutable and slightly faster.

pkienzle · 2025-02-11T17:34:57Z

src/sas/qtgui/Utilities/TabbedModelEditor.py

-                if 'File' in line and 'line' in line:
+            reversed_error_text = list(reversed(all_lines))
+            for line in reversed_error_text:
+                if ('File' in line and 'line' in line):


Parsing compiler error messages feels brittle. Maybe a regexp with r"[Ff]ile.*[Ll]ine ([0-9]+)" will be a little more future proof?

pkienzle · 2025-02-11T17:38:22Z

src/sas/qtgui/Utilities/TabbedModelEditor.py

        # make sure we have the file handle ready
-        assert(filename != "")
+        assert filename != ""


The python "optimizer" suppresses assert statements so technically we shouldn't rely on it for flow control. In practice we never run with the optimizer so not a problem. In this case we would fail on self.writeFile with a missing filename so even less of an issue.

pkienzle · 2025-02-11T17:52:07Z

src/sas/qtgui/Utilities/TabbedModelEditor.py

+        full_path = os.path.join(plugin_location, filename)
+        if not w.is_python and self.is_python:
+            pass
+        elif os.path.splitext(full_path)[1] != ".py":


No idea where filename is coming from, but if it is model.c and the code is python would you want this saved as model.c.py? This will likely cause problems for the loader.

You ought to check that filename without extension is a valid python symbol name [with something like Path(filename).stem.isidentifier()] and replace the extension with .py for python models.

Shouldn't this happen before self.writeFile() ?

Also, self.writeFile() must have similar code for path handling. Can you modify that function to return the full path or set it as an attribute?

pkienzle · 2025-02-11T18:33:01Z

Within "create new model" tab add a plugin name. The apply button does not become available until you switch to another field. Okay, a little confusing. Now go back into the plugin name field and change it. Clicking apply it is still using the old name, not the name that is typed into the field.

You may want to check whether the name already exists or does not pass the isidentifier() test as soon as you leave the field rather than waiting for the apply button to be pressed.

pkienzle · 2025-02-11T18:42:09Z

I see that the box only accepts alphanumeric (and probably underscore but I didn't try). This still allows a name like 2cows.

I can't tell if 2cow is working because this branch is throwing the following error when I try to calculate a model (even a sphere model):

13:39:57 - sas.qtgui.Perspectives.Fitting.FittingWidget - ERROR - Traceback (most recent call last):
  File ".../sasview/src/sas/qtgui/MainWindow/GuiManager.py", line 1339, in deleteIntermediateTheoryPlotsByTabId
    self.filesWidget.deleteIntermediateTheoryPlotsByTabId(tab_id)
  File ".../sasview/src/sas/qtgui/MainWindow/DataExplorer.py", line 2085, in deleteIntermediateTheoryPlotsByTabId
    if item_model_id == model_id:
                        ^^^^^^^^
NameError: name 'model_id' is not defined

pkienzle · 2025-02-11T18:52:25Z

Changing model_id to tab_id on that line lets me see that my 2cows model works. Not sure if this is a good thing or a bad thing.

pkienzle · 2025-02-12T21:35:28Z

On mac when not in full screen the editor window pops up behind the application. Is it too difficult to put it within the MDI workspace?
On mac plugin manager selecting Edit... for a model opens a new editor window even if there is already one open. Expected behaviour is to raise the existing window to the front.
The traceback in the error log is hard to read with all the line breaks and indentation removed.
Should check parameter table for name and initial value when creating model. If name is blank then it ignores all subsequent parameters. If value is blank it defaults to 1.
Need to get current value from all fields on apply. Changing the name or value of the parameter then clicking apply uses the value from before the edit.
Parameter table cannot input units, limits or description (future enhancement)

pkienzle

Make sure that the current value displayed in the text box, not the value before the text box was edited, is the one that is used in the new model file. The remaining suggestions are optional.

tsole0 added 4 commits June 21, 2024 10:04

add error message when user does not enter model name

84e4ebe

Fixes pre-existing bug forcing user to re-enter default text for mode…

b4c8f8c

…l file to generate

edit bug fix to use variable consistent with release version

bf3b57a

bug fix: adds functionality to auto-delete unused rows

01b286c

tsole0 added the Bug Fix label Jun 21, 2024

tsole0 self-assigned this Jun 21, 2024

tsole0 added 5 commits June 24, 2024 12:55

bug fix: ensure that both a syntax check and a model check is run on …

558c7a1

…model file before approving it; condense into checkModel method

remove isModelCorrect method whose functionality was incorporated int…

54a8aaf

…o checkModel in previous commit

Update comments and remove unnecessary flag from method

2b71022

when saving C model, run model check and highlight C window if error …

eb3dee0

…with C code. Clear highlights from both python and C windows if checks pass. Ensure that checkModel() is always passed a path argument instead of raw text.

fix bug that deletes .py file after a failed model check on a .c file…

14d1e0a

… by removing os.remove(). allow user to load .c models into editor even if .c file fails model checks

tsole0 mentioned this pull request Jun 28, 2024

Plugin editor not show model errors on save #1595

Closed

Merge remote-tracking branch 'origin/release_6.0.0-macos13' into mode…

52b758d

…l-editor-bug-fixes

tsole0 marked this pull request as ready for review June 28, 2024 20:55

tsole0 added the Discuss At The Call Issues to be discussed at the fortnightly call label Jun 28, 2024

tsole0 marked this pull request as draft July 1, 2024 19:43

fixes bug that causes font to change if all text in text editor deleted

788433b

tsole0 removed the Discuss At The Call Issues to be discussed at the fortnightly call label Jul 12, 2024

Merge remote-tracking branch 'origin/release_6.0.0' into model-editor…

93c7048

…-bug-fixes

krzywon changed the base branch from release_6.0.0 to release_6.0.1 October 25, 2024 14:54

krzywon marked this pull request as ready for review October 25, 2024 14:54

Merge branch 'release_6.0.1' into model-editor-bug-fixes

2a234bb

krzywon reviewed Oct 28, 2024

View reviewed changes

src/sas/qtgui/Utilities/PluginDefinition.py Outdated Show resolved Hide resolved

Abstract the empty row removal tool and apply to the PD and regular p…

6ac6c45

…arams in the model editor window

krzywon approved these changes Oct 29, 2024

View reviewed changes

butlerpd added the SasView 6.0.1 label Dec 3, 2024

lucas-wilkins added Defect Bug or undesirable behaviour and removed Bug Fix labels Jan 8, 2025

lucas-wilkins removed the Defect Bug or undesirable behaviour label Jan 8, 2025

lucas-wilkins and others added 2 commits January 8, 2025 15:33

Merge branch 'release_6.0.1' into model-editor-bug-fixes

b781fec

Merge branch 'release_6.0.1' into model-editor-bug-fixes

c34c9bf

butlerpd self-requested a review January 28, 2025 14:32

pkienzle approved these changes Feb 11, 2025

View reviewed changes

Merge branch 'release_6.0.1' into model-editor-bug-fixes

71538b4

pkienzle self-requested a review February 13, 2025 15:09

pkienzle requested changes Feb 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Model Editor Bug Fixes #2901

Model Editor Bug Fixes #2901

tsole0 commented Jun 21, 2024 •

edited

Loading

tsole0 commented Jul 1, 2024

krzywon left a comment •

edited

Loading

krzywon commented Oct 28, 2024

krzywon left a comment •

edited

Loading

pkienzle left a comment

pkienzle Feb 11, 2025

pkienzle Feb 11, 2025

pkienzle Feb 11, 2025

pkienzle Feb 11, 2025

pkienzle commented Feb 11, 2025

pkienzle commented Feb 11, 2025

pkienzle commented Feb 11, 2025

pkienzle commented Feb 12, 2025

pkienzle left a comment

Model Editor Bug Fixes #2901

Are you sure you want to change the base?

Model Editor Bug Fixes #2901

Conversation

tsole0 commented Jun 21, 2024 • edited Loading

Description

How Has This Been Tested?

Review Checklist:

tsole0 commented Jul 1, 2024

krzywon left a comment • edited Loading

Choose a reason for hiding this comment

krzywon commented Oct 28, 2024

krzywon left a comment • edited Loading

Choose a reason for hiding this comment

pkienzle left a comment

Choose a reason for hiding this comment

pkienzle Feb 11, 2025

Choose a reason for hiding this comment

pkienzle Feb 11, 2025

Choose a reason for hiding this comment

pkienzle Feb 11, 2025

Choose a reason for hiding this comment

pkienzle Feb 11, 2025

Choose a reason for hiding this comment

pkienzle commented Feb 11, 2025

pkienzle commented Feb 11, 2025

pkienzle commented Feb 11, 2025

pkienzle commented Feb 12, 2025

pkienzle left a comment

Choose a reason for hiding this comment

tsole0 commented Jun 21, 2024 •

edited

Loading

krzywon left a comment •

edited

Loading

krzywon left a comment •

edited

Loading