Merge pull request #3538 from emma58/params-complain-more

Type check all `exception` arguments in component `__call__` implementations

Author: jsiirola

pyomo/core/base/boolean_var.py

@@ -19,6 +19,7 @@
 from pyomo.core.staleflag import StaleFlagManager
 from pyomo.core.expr.boolean_value import BooleanValue
 from pyomo.core.expr import GetItemExpression
+from pyomo.core.expr.expr_common import _type_check_exception_arg
 from pyomo.core.expr.numvalue import value
 from pyomo.core.base.component import ComponentData, ModelComponentFactory
 from pyomo.core.base.global_set import UnindexedComponent_index
@@ -155,8 +156,9 @@ def set_value(self, val, skip_validation=False):
     def clear(self):
         self.value = None
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Compute the value of this variable."""
+        exception = _type_check_exception_arg(self, exception)
         return self.value
 
     @property

pyomo/core/base/constraint.py

@@ -38,6 +38,7 @@
     InequalityExpression,
     RangedExpression,
 )
+from pyomo.core.expr.expr_common import _type_check_exception_arg
 from pyomo.core.expr.template_expr import templatize_constraint
 from pyomo.core.base.component import ActiveComponentData, ModelComponentFactory
 from pyomo.core.base.global_set import UnindexedComponent_index
@@ -168,8 +169,9 @@ def __init__(self, expr=None, component=None):
         if expr is not None:
             self.set_value(expr)
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Compute the value of the body of this constraint."""
+        exception = _type_check_exception_arg(self, exception)
         body = self.to_bounded_expression()[1]
         if body.__class__ not in native_numeric_types:
             body = value(self.body, exception=exception)

pyomo/core/base/expression.py

@@ -26,6 +26,7 @@
 )
 
 import pyomo.core.expr as EXPR
+from pyomo.core.expr.expr_common import _type_check_exception_arg
 import pyomo.core.expr.numeric_expr as numeric_expr
 from pyomo.core.base.component import ComponentData, ModelComponentFactory
 from pyomo.core.base.global_set import UnindexedComponent_index
@@ -50,8 +51,9 @@ class NamedExpressionData(numeric_expr.NumericValue):
     PRECEDENCE = 0
     ASSOCIATIVITY = EXPR.OperatorAssociativity.NON_ASSOCIATIVE
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Compute the value of this expression."""
+        exception = _type_check_exception_arg(self, exception)
         (arg,) = self.args
         if arg.__class__ in native_types:
             # Note: native_types includes NoneType
@@ -396,8 +398,9 @@ def __init__(self, *args, **kwds):
     # construction
     #
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Return expression on this expression."""
+        exception = _type_check_exception_arg(self, exception)
         if self._constructed:
             return super().__call__(exception)
         raise ValueError(

pyomo/core/base/logical_constraint.py

@@ -20,6 +20,7 @@
 from pyomo.common.modeling import NOTSET
 from pyomo.common.timing import ConstructionTimer
 
+from pyomo.core.expr.expr_common import _type_check_exception_arg
 from pyomo.core.expr.boolean_value import as_boolean, BooleanConstant
 from pyomo.core.expr.numvalue import native_types, native_logical_types
 from pyomo.core.base.component import ActiveComponentData, ModelComponentFactory
@@ -84,8 +85,9 @@ def __init__(self, expr=None, component=None):
         if expr is not None:
             self.set_value(expr)
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Compute the value of the body of this logical constraint."""
+        exception = _type_check_exception_arg(self, exception)
         if self.body is None:
             return None
         return self.body(exception=exception)

pyomo/core/base/matrix_constraint.py

@@ -15,7 +15,9 @@
 
 from pyomo.common.gc_manager import PauseGC
 from pyomo.common.log import is_debug_set
+from pyomo.common.modeling import NOTSET
 from pyomo.core.base.set_types import Any
+from pyomo.core.expr.expr_common import _type_check_exception_arg
 from pyomo.core.expr.numvalue import value
 from pyomo.core.expr.numeric_expr import LinearExpression
 from pyomo.core.base.component import ModelComponentFactory
@@ -130,8 +132,9 @@ def __getstate__(self):
     # possible
     #
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Compute the value of the body of this constraint."""
+        exception = _type_check_exception_arg(self, exception)
         comp = self.parent_component()
         index = self._index
         data = comp._A_data

pyomo/core/base/objective.py

@@ -22,6 +22,7 @@
 from pyomo.common.formatting import tabular_writer
 from pyomo.common.timing import ConstructionTimer
 
+from pyomo.core.expr.expr_common import _type_check_exception_arg
 from pyomo.core.expr.numvalue import value
 from pyomo.core.expr.template_expr import templatize_rule
 from pyomo.core.base.component import ActiveComponentData, ModelComponentFactory
@@ -418,7 +419,8 @@ def __init__(self, *args, **kwd):
     # construction
     #
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
+        exception = _type_check_exception_arg(self, exception)
         if self._constructed:
             if len(self._data) == 0:
                 raise ValueError(

pyomo/core/base/param.py

@@ -23,6 +23,7 @@
 from pyomo.common.modeling import NOTSET
 from pyomo.common.numeric_types import native_types, value as expr_value
 from pyomo.common.timing import ConstructionTimer
+from pyomo.core.expr.expr_common import _type_check_exception_arg
 from pyomo.core.expr.numvalue import NumericValue
 from pyomo.core.base.component import ComponentData, ModelComponentFactory
 from pyomo.core.base.global_set import UnindexedComponent_index
@@ -201,10 +202,12 @@ def set_value(self, value, idx=NOTSET):
             self._value = old_value
             raise
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """
         Return the value of this object.
         """
+        exception = _type_check_exception_arg(self, exception)
+
         if self._value is Param.NoValue:
             if exception:
                 raise ValueError(
@@ -929,10 +932,12 @@ def __init__(self, *args, **kwds):
     # up both the Component and Data base classes.
     #
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """
         Return the value of this parameter.
         """
+        exception = _type_check_exception_arg(self, exception)
+
         if self._constructed:
             if not self._data:
                 if self._mutable:
@@ -976,13 +981,6 @@ class SimpleParam(metaclass=RenamedClass):
 
 
 class IndexedParam(Param):
-    def __call__(self, exception=True):
-        """Compute the value of the parameter"""
-        if exception:
-            raise TypeError(
-                'Cannot compute the value of an indexed Param (%s)' % (self.name,)
-            )
-
     # Because IndexedParam can use a non-standard data store (i.e., the
     # values in the _data dict may not be ComponentData objects), we
     # need to override the normal scheme for pre-allocating

pyomo/core/base/units_container.py

@@ -113,6 +113,7 @@
 
 from pyomo.common.dependencies import pint as pint_module, pint_available
 from pyomo.common.modeling import NOTSET
+from pyomo.core.expr.expr_common import _type_check_exception_arg
 from pyomo.core.expr.numvalue import (
     NumericValue,
     nonpyomo_leaf_types,
@@ -384,14 +385,15 @@ def to_string(self, verbose=None, labeler=None, smap=None, compute_values=False)
         else:
             return _str
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Unit is treated as a constant value, and this method always returns 1.0
 
         Returns
         -------
         : float
            Returns 1.0
         """
+        _type_check_exception_arg(self, exception)
         return 1.0
 
     @property

pyomo/core/base/var.py

@@ -24,6 +24,7 @@
 from pyomo.core.staleflag import StaleFlagManager
 from pyomo.core.expr import GetItemExpression
 from pyomo.core.expr.numeric_expr import NPV_MaxExpression, NPV_MinExpression
+from pyomo.core.expr.expr_common import _type_check_exception_arg
 from pyomo.core.expr.numvalue import (
     NumericValue,
     value,
@@ -197,8 +198,9 @@ def value(self):
     def value(self, val):
         self.set_value(val)
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Compute the value of this variable."""
+        exception = _type_check_exception_arg(self, exception)
         return self._value
 
     @property

pyomo/core/expr/base.py

@@ -13,8 +13,9 @@
 
 from pyomo.common.dependencies import attempt_import
 from pyomo.common.numeric_types import native_types
+from pyomo.common.modeling import NOTSET
 from pyomo.core.pyomoobject import PyomoObject
-from pyomo.core.expr.expr_common import OperatorAssociativity
+from pyomo.core.expr.expr_common import OperatorAssociativity, _type_check_exception_arg
 
 visitor, _ = attempt_import('pyomo.core.expr.visitor')
 
@@ -100,7 +101,7 @@ def args(self):
             f"Derived expression ({self.__class__}) failed to implement args()"
         )
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Evaluate the value of the expression tree.
 
         Parameters
@@ -115,6 +116,7 @@ def __call__(self, exception=True):
         The value of the expression or :const:`None`.
 
         """
+        exception = _type_check_exception_arg(self, exception)
         return visitor.evaluate_expression(self, exception)
 
     def __str__(self):

pyomo/core/expr/boolean_value.py

@@ -13,6 +13,8 @@
 import logging
 
 from pyomo.common.deprecation import deprecated
+from pyomo.common.modeling import NOTSET
+from pyomo.core.expr.expr_common import _type_check_exception_arg
 from pyomo.core.expr.numvalue import native_types, native_logical_types
 from pyomo.core.expr.expr_common import _and, _or, _equiv, _inv, _xor, _impl
 from pyomo.core.pyomoobject import PyomoObject
@@ -296,8 +298,9 @@ def __nonzero__(self):
     def __bool__(self):
         return self.value
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Return the constant value"""
+        exception = _type_check_exception_arg(self, exception)
         return self.value
 
     def pprint(self, ostream=None, verbose=False):

pyomo/core/expr/expr_common.py

@@ -13,6 +13,7 @@
 
 from pyomo.common import enums
 from pyomo.common.deprecation import deprecated
+from pyomo.common.modeling import NOTSET
 
 TO_STRING_VERBOSE = False
 
@@ -108,3 +109,15 @@ def __init__(self):
     def count(self):
         """A property that returns the clone count value."""
         return clone_counter._count
+
+
+def _type_check_exception_arg(cls, exception):
+    if exception is NOTSET:
+        return True
+    elif type(exception) is not bool:
+        raise ValueError(
+            f"{cls.ctype.__name__} '{cls.name}' was called with a non-bool "
+            f"argument for 'exception': {exception}"
+        )
+    else:
+        return exception

pyomo/core/expr/numvalue.py

@@ -17,7 +17,8 @@
     deprecation_warning,
     relocated_module_attribute,
 )
-from pyomo.core.expr.expr_common import ExpressionType
+from pyomo.common.modeling import NOTSET
+from pyomo.core.expr.expr_common import ExpressionType, _type_check_exception_arg
 from pyomo.core.expr.numeric_expr import NumericValue
 
 # TODO: update Pyomo to import these objects from common.numeric_types
@@ -113,7 +114,8 @@ def __str__(self):
     def __repr__(self):
         return repr(self.value)
 
-    def __call__(self, exception=None):
+    def __call__(self, exception=NOTSET):
+        exception = _type_check_exception_arg(self, exception)
         return self.value
 
     def is_constant(self):
@@ -422,8 +424,9 @@ def _compute_polynomial_degree(self, result):
     def __str__(self):
         return str(self.value)
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Return the constant value"""
+        exception = _type_check_exception_arg(self, exception)
         return self.value
 
     def pprint(self, ostream=None, verbose=False):

pyomo/core/expr/template_expr.py

@@ -229,6 +229,11 @@ def __call__(self, *args, **kwargs):
         #
         # TODO: deprecate (then remove) evaluating expressions by
         # "calling" them.
+        #
+        # [ESJ 3/25/25]: Note that since this always calls the ExpressionBase
+        # implementation of __call__ if 'exception' is specified, we need not
+        # check the type of the exception arg here--it will get checked in the
+        # base class.
         try:
             if not args:
                 if not kwargs:

pyomo/core/kernel/conic.py

@@ -10,8 +10,10 @@
 #  ___________________________________________________________________________
 """Various conic constraint implementations."""
 
+from pyomo.common.modeling import NOTSET
 from pyomo.core.expr.numvalue import is_numeric_data
 from pyomo.core.expr import value, exp
+from pyomo.core.expr.expr_common import _type_check_exception_arg
 from pyomo.core.kernel.block import block
 from pyomo.core.kernel.variable import IVariable, variable, variable_tuple
 from pyomo.core.kernel.constraint import (
@@ -133,7 +135,8 @@ def equality(self):
     # to avoid building the body expression, if possible
     #
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
+        exception = _type_check_exception_arg(self, exception)
         try:
             # we wrap the result with value(...) as the
             # alpha term used by some of the constraints

pyomo/core/kernel/constraint.py

@@ -9,14 +9,15 @@
 #  This software is distributed under the 3-clause BSD License.
 #  ___________________________________________________________________________
 
+from pyomo.common.modeling import NOTSET
 from pyomo.core.expr.numvalue import (
     ZeroConstant,
     as_numeric,
     is_potentially_variable,
     is_numeric_data,
     value,
 )
-from pyomo.core.expr.expr_common import ExpressionType
+from pyomo.core.expr.expr_common import ExpressionType, _type_check_exception_arg
 from pyomo.core.expr.relational_expr import (
     EqualityExpression,
     RangedExpression,
@@ -74,8 +75,9 @@ class IConstraint(ICategorizedObject):
     # Interface
     #
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
         """Compute the value of the body of this constraint."""
+        exception = _type_check_exception_arg(self, exception)
         if exception and (self.body is None):
             raise ValueError("constraint body is None")
         elif self.body is None:
@@ -798,7 +800,8 @@ def terms(self, terms):
     # to avoid building the body expression
     #
 
-    def __call__(self, exception=True):
+    def __call__(self, exception=NOTSET):
+        exception = _type_check_exception_arg(self, exception)
         try:
             return sum(
                 value(c, exception=exception) * v(exception=exception)