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.

Sign up for GitHub

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

Disallow calling del_component with ComponentData arguments #3440

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
+62 −20
Open

Disallow calling del_component with ComponentData arguments #3440

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
45691f7
modifying the FME post-processing objective without creating and dele…
emma58 Dec 2, 2024
f382c1e
Removing outdated docs from the ComponentData docstring
emma58 Dec 2, 2024
4dcfc65
Raising a ValueError when a ComponentData is passed to del_component
emma58 Dec 2, 2024
871c99d
Merge branch 'main' into fme-del-fix
emma58 Dec 2, 2024
bd2fed0
Removing unnecessary line in FME post-processing
emma58 Dec 3, 2024
cc88554
Adding a test confirming that John is right (no surprises there)
emma58 Jan 7, 2025
757bc6f
Merge branch 'main' into fme-del-fix
emma58 Mar 24, 2025
9759c88
In-lining self.component so that we can check for ComponentDatas, fix…
emma58 Mar 24, 2025
b083f0c
Fixing a bug where obj could be undefined (probably for deleting some…
emma58 Mar 24, 2025
1bebc33
Whoops, also fixing the case where the object isn't on the correct Block
emma58 Mar 24, 2025
f8e8c83
Fixing a use of del_component on a ComponentData in parmest
emma58 Mar 24, 2025
d6eb18e
Merge branch 'main' into fme-del-fix
emma58 Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions pyomo/contrib/fme/fourier_motzkin_elimination.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,12 +730,9 @@ def post_process_fme_constraints(
continue
# deactivate the constraint
projected_constraints[i].deactivate()
m.del_component(obj)
# make objective to maximize its infeasibility
obj = Objective(
expr=projected_constraints[i].body - projected_constraints[i].lower
)
m.add_component(obj_name, obj)
# Our constraint looks like: 0 <= a^Tx - b, so make objective to
# maximize its infeasibility
obj.expr = projected_constraints[i].body - projected_constraints[i].lower
results = solver_factory.solve(m)
if results.solver.termination_condition == TerminationCondition.unbounded:
obj_val = -float('inf')
Expand All @@ -753,13 +750,13 @@ def post_process_fme_constraints(
obj_val = value(obj)
# if we couldn't make it infeasible, it's useless
if obj_val >= tolerance:
m.del_component(projected_constraints[i])
del projected_constraints[i]
else:
projected_constraints[i].activate()

# clean up
m.del_component(obj)
del obj
for obj in active_objs:
obj.activate()
# undo relax integrality
Expand Down
9 changes: 9 additions & 0 deletions pyomo/core/base/block.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
from pyomo.common.timing import ConstructionTimer
from pyomo.core.base.component import (
Component,
ComponentData,
ActiveComponentData,
ModelComponentFactory,
)
Expand Down Expand Up @@ -1139,6 +1140,14 @@ def del_component(self, name_or_object):
# return

name = obj.local_name
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
)

Copy link
Member

Choose a reason for hiding this comment

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

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)??

Copy link
Contributor

Choose a reason for hiding this comment

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

I would argue that this is a bug and does not need a deprecation path.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think block.component() only works with strings if the string refers to a component and not a component data, so we can probably just check if name_or_object is a string?

if name in self._Block_reserved_words:
raise ValueError(
"Attempting to delete a reserved block component:\n\t%s" % (obj.name,)
Expand Down
6 changes: 1 addition & 5 deletions pyomo/core/base/component.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -732,11 +732,7 @@ class ComponentData(ComponentBase):
This is the base class for the component data used
in Pyomo modeling components. Subclasses of ComponentData are
used in indexed components, and this class assumes that indexed
components are subclasses of IndexedComponent. Note that
ComponentData instances do not store their index. This makes
some operations significantly more expensive, but these are (a)
associated with I/O generation and (b) this cost can be managed
with caches.
components are subclasses of IndexedComponent.

Constructor arguments:
owner The component that owns this data object
Expand Down
Loading