-
Notifications
You must be signed in to change notification settings - Fork 222
Fix #5452 - Deprecate ShowRunnerOutput's show_output and implement C++ WorkflowStepResult::showOutput() so both Ruby and Python can use it
#5453
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
Conversation
|
d0cea24 is an optional commit, like I said I disliked the formatting for the Machine readable attributes. Diff without/with it
|
🧪 Test Results DashboardSummary
|
| Run | XML File | Status |
|---|---|---|
| run1 | results.xml |
✅ Found |
| run2 | results.xml |
✅ Found |
| run3 | results.xml |
✅ Found |
d0cea24 to
99f11c9
Compare
|
CI Results for 99f11c9:
|
joseph-robertson
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So the summary here is that we'll need to replace show_output(runner.result) with runner.result.showOutput if we want to avoid the deprecation warning? And, only minimal differences in output.
Correct. Is the deprecation warning a problem? I could understand that the deprecation warning would be annoying for someone in charge of maintaining a large collection of measures (I know you do), but the deprecation is so that we can actually remove it at that some point. Open to discussion on this. |
Seems pretty reasonable to me. |

Pull request overview
ShowRunnerOutput'sshow_outputand implement C++WorkflowStepResult::showOutput()so both Ruby and Python can use itI have tested that there are no changes in output (actually: just a tiny bit) in 3.10.0 versus this branch.
3.10.0 versus this branch, still using "require 'openstudio/measure/ShowRunnerOutput.rb' and calling show_output: only diff is the placement of the second "undefined stepResult"
Running with result.showOutput() instead, the only difference is that the Deprecation warning is gone. And Python and Ruby both produce exactly the same output.
I don't really like the
***Machine-Readable Attributes**formatting.Pull Request Author
src/model/test)src/energyplus/Test)src/osversion/VersionTranslator.cpp)Labels:
IDDChangeAPIChangePull Request - Ready for CIso that CI builds your PRReview Checklist
This will not be exhaustively relevant to every PR.