Merge branch 'main' into parmest-doc-update

Author: blnicho

doc/OnlineDocs/src/kernel/examples.txt

@@ -76,29 +76,22 @@
           3 :  -5.0 : vl[3] - v :   5.0 :   True
 
 3 SOSConstraint Declarations
-       sd : 	Size=2 	Index= OrderedScalarSet
-    	1
-    		Type=1
-    		Weight : Variable
-    		1 : vd[1]
-    		2 : vd[2]
-    	2
-    		Type=1
-    		Weight : Variable
-    		1 : vl[1]
-    		2 : vl[2]
-    		3 : vl[3]
-       sos1 : 	Size=1 
-    		Type=1
-    		Weight : Variable
-    		1 : vl[1]
-    		2 : vl[2]
-    		3 : vl[3]
-       sos2 : 	Size=1 
-    		Type=2
-    		Weight : Variable
-    		1 : vd[1]
-    		2 : vd[2]
+    sd : Size=2, Index={1, 2}
+        Key : Type : Weight : Variable
+          1 :    1 :      1 :    vd[1]
+            :      :      2 :    vd[2]
+          2 :    1 :      1 :    vl[1]
+            :      :      2 :    vl[2]
+            :      :      3 :    vl[3]
+    sos1 : Size=1, Index=None
+        Key  : Type : Weight : Variable
+        None :    1 :      1 :    vl[1]
+             :      :      2 :    vl[2]
+             :      :      3 :    vl[3]
+    sos2 : Size=1, Index=None
+        Key  : Type : Weight : Variable
+        None :    2 :      1 :    vd[1]
+             :      :      2 :    vd[2]
 
 2 Block Declarations
     b : Size=1, Index=None, Active=True
@@ -120,13 +113,12 @@
                   3 :   1.0 :             pw.SOS2_y[0] + pw.SOS2_y[1] + pw.SOS2_y[2] + pw.SOS2_y[3] :   1.0 :   True
 
         1 SOSConstraint Declarations
-               SOS2_sosconstraint : 	Size=1 
-            		Type=2
-            		Weight : Variable
-            		1 : pw.SOS2_y[0]
-            		2 : pw.SOS2_y[1]
-            		3 : pw.SOS2_y[2]
-            		4 : pw.SOS2_y[3]
+            SOS2_sosconstraint : Size=1, Index=None
+                Key  : Type : Weight : Variable
+                None :    2 :      1 : pw.SOS2_y[0]
+                     :      :      2 : pw.SOS2_y[1]
+                     :      :      3 : pw.SOS2_y[2]
+                     :      :      4 : pw.SOS2_y[3]
 
         3 Declarations: SOS2_y SOS2_constraint SOS2_sosconstraint
 

pyomo/common/formatting.py

@@ -154,8 +154,11 @@ def tabular_writer(ostream, prefix, data, header, row_generator):
             _rows[_key] = None
             continue
 
+        # Include the key for only the first line in a rowset, and only
+        # if we printed out a header (if there is no header, then the
+        # key is not included)
         _rows[_key] = [
-            ((tostr("" if i else _key),) if header else ())
+            (("" if i else tostr(_key),) if header else ())
             + tuple(tostr(x) for x in _r)
             for i, _r in enumerate(_rowSet)
         ]
@@ -190,7 +193,7 @@ def tabular_writer(ostream, prefix, data, header, row_generator):
 
     if any(' ' in r[-1] for x in _rows.values() if x is not None for r in x):
         _width[-1] = '%s'
-    for _key in sorted_robust(_rows):
+    for _key in _rows:
         _rowSet = _rows[_key]
         if not _rowSet:
             _rowSet = [[_key] + [None] * (len(_width) - 1)]

pyomo/common/pyomo_typing.py

@@ -9,6 +9,7 @@
 #  This software is distributed under the 3-clause BSD License.
 #  ___________________________________________________________________________
 
+import sys
 import typing
 
 _overloads = {}
@@ -18,17 +19,22 @@ def _get_fullqual_name(func: typing.Callable) -> str:
     return f"{func.__module__}.{func.__qualname__}"
 
 
-def overload(func: typing.Callable):
-    """Wrap typing.overload that remembers the overloaded signatures
+if sys.version_info[:2] <= (3, 10) and not typing.TYPE_CHECKING:
 
-    This provides a custom implementation of typing.overload that
-    remembers the overloaded signatures so that they are available for
-    runtime inspection.
+    def overload(func: typing.Callable):
+        """Wrap typing.overload that remembers the overloaded signatures
 
-    """
-    _overloads.setdefault(_get_fullqual_name(func), []).append(func)
-    return typing.overload(func)
+        This provides a custom implementation of typing.overload that
+        remembers the overloaded signatures so that they are available for
+        runtime inspection.
 
+        """
+        _overloads.setdefault(_get_fullqual_name(func), []).append(func)
+        return typing.overload(func)
 
-def get_overloads_for(func: typing.Callable):
-    return _overloads.get(_get_fullqual_name(func), [])
+    def get_overloads_for(func: typing.Callable):
+        return _overloads.get(_get_fullqual_name(func), [])
+
+else:
+    from typing import get_overloads as get_overloads_for
+    from typing import overload as overload

pyomo/common/tests/test_formatting.py

@@ -96,8 +96,8 @@ def test_no_header(self):
         data = {(2,): (["a", 1], 1), (1, 3): ({1: 'a', 2: '2'}, '2')}
         tabular_writer(os, "", data.items(), [], lambda k, v: v)
         ref = u"""
-{1: 'a', 2: '2'} : 2
         ['a', 1] : 1
+{1: 'a', 2: '2'} : 2
 """
         self.assertEqual(ref.strip(), os.getvalue().strip())
 

pyomo/contrib/appsi/base.py

@@ -16,6 +16,7 @@
 import weakref
 
 from typing import (
+    TYPE_CHECKING,
     Sequence,
     Dict,
     Optional,
@@ -1714,5 +1715,9 @@ class LegacySolver(LegacySolverInterface, cls):
 
         return decorator
 
+    if TYPE_CHECKING:
+        # NOTE: `Factory.__call__` can return None, but for the common case
+        def __call__(self, name, **kwds) -> Solver: ...
+
 
 SolverFactory = SolverFactoryClass()

pyomo/contrib/cp/sequence_var.py

@@ -134,7 +134,7 @@ def _pprint(self):
         ]
         return (
             headers,
-            self._data.items(),
+            self.items,
             ("IntervalVars",),
             lambda k, v: ['[' + ', '.join(iv.name for iv in v.interval_vars) + ']'],
         )

pyomo/contrib/solver/common/factory.py

@@ -10,9 +10,11 @@
 #  ___________________________________________________________________________
 
 
-from pyomo.opt.base.solvers import LegacySolverFactory
+from typing import TYPE_CHECKING
+
 from pyomo.common.factory import Factory
 from pyomo.contrib.solver.common.base import LegacySolverWrapper
+from pyomo.opt.base.solvers import LegacySolverFactory
 
 
 class SolverFactoryClass(Factory):
@@ -107,6 +109,12 @@ class LegacySolver(LegacySolverWrapper, cls):
 
         return decorator
 
+    if TYPE_CHECKING:
+        from pyomo.contrib.solver.common.base import SolverBase
+
+        # NOTE: `Factory.__call__` can return None, but for the common case
+        def __call__(self, name, **kwds) -> SolverBase: ...
+
 
 #: Global registry/factory for "v2" solver interfaces.
 SolverFactory: SolverFactoryClass = SolverFactoryClass()

pyomo/contrib/solver/tests/solvers/test_gurobi_minlp_walker.py

@@ -565,7 +565,8 @@ def test_handle_complex_number_sqrt(self):
         with self.assertRaisesRegex(
             InvalidValueError,
             r"Invalid number encountered evaluating constant unary expression "
-            r"sqrt\(- p\): math domain error",
+            r"sqrt\(\s*-\s*p\s*\): "
+            r"(?:math domain error|expected a nonnegative input, got -?\d+(?:\.\d+)?)",
         ):
             _, expr = visitor.walk_expression(m.c.body)
 
@@ -578,6 +579,7 @@ def test_handle_invalid_log(self):
         with self.assertRaisesRegex(
             InvalidValueError,
             r"Invalid number encountered evaluating constant unary expression "
-            r"log\(p\): math domain error",
+            r"log\(\s*p\s*\): "
+            r"(?:math domain error|expected a positive input)",
         ):
             _, expr = visitor.walk_expression(m.c.body)

pyomo/core/base/PyomoModel.py

@@ -14,6 +14,7 @@
 from weakref import ref as weakref_ref
 import gc
 import math
+from typing import TypeVar
 
 from pyomo.common import timing
 from pyomo.common.collections import Bunch
@@ -572,6 +573,10 @@ def select(
         StaleFlagManager.mark_all_as_stale(delayed=True)
 
 
+# NOTE: Python 3.11+ use `typing.Self`
+ModelType = TypeVar("ModelType", bound="Model")
+
+
 @ModelComponentFactory.register(
     'Model objects can be used as a component of other models.'
 )
@@ -583,9 +588,9 @@ class Model(ScalarBlock):
 
     _Block_reserved_words = set()
 
-    def __new__(cls, *args, **kwds):
+    def __new__(cls: type[ModelType], *args, **kwds) -> ModelType:
         if cls != Model:
-            return super(Model, cls).__new__(cls)
+            return super(Model, cls).__new__(cls)  # type: ignore
 
         raise TypeError(
             "Directly creating the 'Model' class is not allowed.  Please use the "

pyomo/core/base/block.py

@@ -1836,7 +1836,7 @@ def is_constructed(self):
                 return False
         return True
 
-    def _pprint_blockdata_components(self, ostream):
+    def _pprint_blockdata_components(self, ostream, sort):
         #
         # We hard-code the order of the core Pyomo modeling
         # components, to ensure that the output follows the logical order
@@ -1862,15 +1862,18 @@ def _pprint_blockdata_components(self, ostream):
 
         indented_ostream = StreamIndenter(ostream, self._PPRINT_INDENT)
         for item in items:
-            keys = sorted(self.component_map(item))
+            if SortComponents.ALPHABETICAL in sort:
+                keys = sorted(self.component_map(item))
+            else:
+                keys = list(self.component_map(item))
             if not keys:
                 continue
             #
             # NOTE: these conditional checks should not be hard-coded.
             #
             ostream.write("%d %s Declarations\n" % (len(keys), item.__name__))
             for key in keys:
-                self.component(key).pprint(ostream=indented_ostream)
+                self.component(key).pprint(ostream=indented_ostream, sort=sort)
             ostream.write("\n")
         #
         # Model Order
@@ -2070,17 +2073,17 @@ class Block(ActiveIndexedComponent):
     _ComponentDataClass = BlockData
     _private_data_initializers = defaultdict(lambda: dict)
 
-    @overload
-    def __new__(
-        cls: Type[Block], *args, **kwds
-    ) -> Union[ScalarBlock, IndexedBlock]: ...
-
     @overload
     def __new__(cls: Type[ScalarBlock], *args, **kwds) -> ScalarBlock: ...
 
     @overload
     def __new__(cls: Type[IndexedBlock], *args, **kwds) -> IndexedBlock: ...
 
+    @overload
+    def __new__(
+        cls: Type[Block], *args, **kwds
+    ) -> Union[ScalarBlock, IndexedBlock]: ...
+
     def __new__(cls, *args, **kwds):
         if cls != Block:
             return super(Block, cls).__new__(cls)
@@ -2237,25 +2240,26 @@ def construct(self, data=None):
                 _BlockConstruction.data.pop(id(self), None)
             timer.report()
 
-    def _pprint_callback(self, ostream, idx, data):
+    def _pprint_callback(self, ostream, sort, idx, data):
         if not self.is_indexed():
-            data._pprint_blockdata_components(ostream)
+            data._pprint_blockdata_components(ostream, sort)
         else:
             ostream.write("%s : Active=%s\n" % (data.name, data.active))
             ostream = StreamIndenter(ostream, self._PPRINT_INDENT)
-            data._pprint_blockdata_components(ostream)
+            data._pprint_blockdata_components(ostream, sort)
 
     def _pprint(self):
-        _attrs = [
-            ("Size", len(self)),
-            ("Index", self._index_set if self.is_indexed() else None),
-            ('Active', self.active),
-        ]
         # HACK: suppress the top-level block header (for historical reasons)
         if self.parent_block() is None and not self.is_indexed():
-            return None, self._data.items(), None, self._pprint_callback
+            _attrs = None
         else:
-            return _attrs, self._data.items(), None, self._pprint_callback
+            _attrs = [
+                ("Size", len(self)),
+                ("Index", self._index_set if self.is_indexed() else None),
+                ('Active', self.active),
+            ]
+
+        return _attrs, self.items, None, self._pprint_callback
 
     def display(self, filename=None, ostream=None, prefix=""):
         """