[Pylib] add at_tsim case for simulation callbacks#1894
Draft
tdavidcl wants to merge 3 commits into
Draft
Conversation
Contributor
|
Thanks @tdavidcl for opening this PR! You can do multiple things directly here: Once the workflow completes a message will appear displaying informations related to the run. Also the PR gets automatically reviewed by gemini, you can: |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces an at_tsim parameter to the @callback decorator in SimulationRunner.py, enabling callbacks to trigger at exact simulation times. The review feedback identifies two issues: a regression in CallbackState where tsim_interval callbacks no longer trigger at the start of the simulation (tsim_start) and exact times equal to tsim_start are skipped, and a parsing bug where a single string argument for at_tsim is incorrectly iterated over as individual characters. Suggestions are provided to address both issues.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Comment on lines
+183
to
+190
| candidates = [] | ||
| if info.tsim_interval is not None: | ||
| candidates.append(tsim_start + info.tsim_interval) | ||
| if info.at_tsim is not None: | ||
| future = [t for t in info.at_tsim if t > tsim_start] | ||
| if future: | ||
| candidates.append(min(future)) | ||
| self.next_tsim = min(candidates) if candidates else None |
Contributor
There was a problem hiding this comment.
This change introduces a regression where tsim_interval callbacks are no longer triggered at the start of the simulation (tsim_start). In the original code, self.next_tsim was initialized to tsim_start, allowing the callback to run at t = 0.0 before any simulation steps. By changing it to tsim_start + info.tsim_interval, the initial callback is skipped.
Additionally, if at_tsim contains tsim_start (e.g., 0.0), it will also be skipped because of the strict inequality t > tsim_start.
To fix both issues and preserve the original behavior, we should initialize candidates with tsim_start for tsim_interval, and use t >= tsim_start for at_tsim.
Suggested change
| candidates = [] | |
| if info.tsim_interval is not None: | |
| candidates.append(tsim_start + info.tsim_interval) | |
| if info.at_tsim is not None: | |
| future = [t for t in info.at_tsim if t > tsim_start] | |
| if future: | |
| candidates.append(min(future)) | |
| self.next_tsim = min(candidates) if candidates else None | |
| candidates = [] | |
| if info.tsim_interval is not None: | |
| candidates.append(tsim_start) | |
| if info.at_tsim is not None: | |
| future = [t for t in info.at_tsim if t >= tsim_start] | |
| if future: | |
| candidates.append(min(future)) | |
| self.next_tsim = min(candidates) if candidates else None |
Comment on lines
+50
to
+54
| if at_tsim is not None: | ||
| if isinstance(at_tsim, (int, float)): | ||
| at_tsim = [float(at_tsim)] | ||
| else: | ||
| at_tsim = sorted(float(t) for t in at_tsim) |
Contributor
There was a problem hiding this comment.
If at_tsim is passed as a string (e.g., "10"), it is not an instance of (int, float), so the code falls back to the else block and attempts to iterate over it. Since strings are iterable in Python, this will silently parse "10" as ['1', '0'] and convert them to [1.0, 0.0], leading to unexpected behavior.
To prevent this, we should include str in the isinstance check so that single string values are correctly converted to a single float (or raise a ValueError if the string is not a valid number).
Suggested change
| if at_tsim is not None: | |
| if isinstance(at_tsim, (int, float)): | |
| at_tsim = [float(at_tsim)] | |
| else: | |
| at_tsim = sorted(float(t) for t in at_tsim) | |
| if at_tsim is not None: | |
| if isinstance(at_tsim, (int, float, str)): | |
| at_tsim = [float(at_tsim)] | |
| else: | |
| at_tsim = sorted(float(t) for t in at_tsim) |
Contributor
Workflow reportworkflow report corresponding to commit 4563eb6 Pre-commit check reportPre-commit check: ✅ Test pipeline can run. Clang-tidy diff reportNo relevant changes found. You should now go back to your normal life and enjoy a hopefully sunny day while waiting for the review. Doxygen diff with
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.