Disallow calling del_component with ComponentData arguments
#3440
+14
−12
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
jsiirola
requested changes
Dec 3, 2024
| del projected_constraints[i] | ||
| else: | ||
| projected_constraints[i].activate() | ||
|
|
||
| # clean up | ||
| m.del_component(obj) | ||
| del obj |
There was a problem hiding this comment.
This is unnecessary (it implicitly happens when you reassign obj in the for loop in the next line)
Comment on lines
+1143
to
+1150
| if isinstance(obj, ComponentData) and not isinstance(obj, Component): | ||
| raise ValueError( | ||
| "Argument '%s' to del_component is a ComponentData object. Please " | ||
| "use the Python 'del' function to delete members of indexed " | ||
| "Pyomo objects. The del_component function can only be used to " | ||
| "delete IndexedComponents and ScalarComponents." % name | ||
| ) | ||
|
|
There was a problem hiding this comment.
This doesn't do what you think it does: line 1133 (obj = self.component(name_or_object)) maps the incoming object into its component, so you shouldn't be able to trigger this exception. If we are going to change the behavior of del_component to only admit Components (either by name or reference), we should
- change (possibly inline the logic from) line 1133
- document this in the docstring
- possibly add a deprecation path (because we are changing behavior that has been in Pyomo for over a decade)??
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 #3435
Summary/Motivation:
I think silently deleting the containing component when we call
del_componenton a ComponentData is rude, and the post-processing in Fourier-Motzkin elimination was falling victim to this mistake. This PR adds aValueErrortodel_componentif it is given a ComponentData and revises the FME transformation post-processing routine.Changes proposed in this PR:
del_componentif the arguments is a ComponentDatadel_componentand, in fact, to not add and delete as many components in general.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: