-
Notifications
You must be signed in to change notification settings - Fork 533
Require variables and constraints to be specified separately in IncidenceGraphInterface.remove_nodes
#3212
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
Merged
Conversation
This file contains 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
…ve_nodes`; update to raise error on invalid components
mrmundt
reviewed
Mar 28, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3212 +/- ##
==========================================
- Coverage 88.40% 88.39% -0.01%
==========================================
Files 847 847
Lines 95285 95309 +24
==========================================
+ Hits 84232 84252 +20
- Misses 11053 11057 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
jsiirola
reviewed
Apr 3, 2024
…yomo into incidence-remove-error
jsiirola
approved these changes
Apr 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes
If invalid components (those not contained in the incidence graph, including random objects like lists and tuples), were provided to
remove_nodes
, we would silently do nothing instead of raising an error.Summary/Motivation:
The above behavior was present because we weren't calling
self._validate_input
inremove_nodes
. Updating to callself._validate_input
would still silently continue if a bad component was provided, and would give a non-helpful error message if a random object was provided.Changes proposed in this PR:
_validate_input
to give a helpful error message if something that is not in the cached var/conComponentMap
s is provided_validate_input
inremove_nodes
_validate_input
. The alternative would probably be to have some more complicated, custom error-checking code inremove_nodes
directly. I'm considering this breaking change because (a) it makes the method consistent with all the other methods onIncidenceGraphInterface
and (b) I don't think many people are using this method.Legal Acknowledgement
By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution: