Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use int for algorithm property when calling python algorithm from c++ #37456

Conversation

robertapplin
Copy link
Contributor

@robertapplin robertapplin commented Jun 3, 2024

Description of work

This PR fixes an error when attempting to use a long instead of an int for a property of a python algorithm. when calling the python algorithm from C++.

Attempt to assign to property (SampleBins) of incorrect type

There was a recent change in behaviour for the PropertyWithValue class introduced in #37196 which caused this problem.

There is no associated issue.

To test:

  1. Go to Inelastic Bayes Fitting interface
  2. Go to Quasi tab
  3. Load the 26176 red from the sample data sets for sample
  4. Load the 26173 res from the sample data sets for resolution
  5. Click Run. It should run successfully

This does not require release notes because it is a regression since the last release

Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@robertapplin robertapplin added Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Indirect/Inelastic Issues and pull requests related to indirect or inelastic ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS labels Jun 3, 2024
@robertapplin robertapplin added this to the Release 6.10 milestone Jun 3, 2024
@robertapplin robertapplin marked this pull request as ready for review June 3, 2024 11:24
@sf1919
Copy link
Contributor

sf1919 commented Jun 3, 2024

Should this have a 6.11 milestone instead? The error was introduced into main so will not be in release-next

@robertapplin robertapplin changed the base branch from main to release-next June 3, 2024 11:55
@robertapplin
Copy link
Contributor Author

robertapplin commented Jun 3, 2024

Should this have a 6.11 milestone instead? The error was introduced into main so will not be in release-next

Oops, no it should be 6.10 but I forgot to change the base branch! I think the error is in release-next

@cailafinn cailafinn self-assigned this Jun 3, 2024
Copy link
Contributor

@cailafinn cailafinn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to write a unit test for this? Doubly important when we can't rely on the compiler to get the typing right.

@robertapplin
Copy link
Contributor Author

Is it possible to write a unit test for this? Doubly important when we can't rely on the compiler to get the typing right.

Its not easy to add a test for this because the code in this area is not in MVP and has Qt everywhere. Instead I have opened a new issue to add manual testing instructions for Inelastic Bayes Fitting. This would catch the problem in the future #37455

Copy link
Contributor

@cailafinn cailafinn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Questions addressed. Code looks good, it's a minor change. Performed functional tests in description and no longer throws/crashes. Thanks for opening that issue!

@SilkeSchomann SilkeSchomann self-assigned this Jun 4, 2024
@SilkeSchomann SilkeSchomann merged commit 28a5e32 into mantidproject:release-next Jun 4, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Indirect/Inelastic Issues and pull requests related to indirect or inelastic ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS
Projects
Status: Merged
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants