Merge pull request #3717 from sadavis1/solver-check-fix

Validate an argument using the new api_version() method, also implement that method on wrapper classes

Author: mrmundt

pyomo/contrib/appsi/base.py

@@ -1686,6 +1686,18 @@ def __enter__(self):
     def __exit__(self, t, v, traceback):
         pass
 
+    @classmethod
+    def api_version(self):
+        """
+        Return the public API supported by this interface.
+
+        Returns
+        -------
+        ~pyomo.common.enums.SolverAPIVersion
+            A solver API enum object
+        """
+        return SolverAPIVersion.V1
+
 
 class SolverFactoryClass(Factory):
     def register(self, name, doc=None):

pyomo/contrib/solver/common/base.py

@@ -744,3 +744,15 @@ def warm_start_capable(self):
 
     def default_variable_value(self):
         return None
+
+    @classmethod
+    def api_version(self):
+        """
+        Return the public API supported by this interface.
+
+        Returns
+        -------
+        ~pyomo.common.enums.SolverAPIVersion
+            A solver API enum object
+        """
+        return SolverAPIVersion.V1

pyomo/contrib/solver/tests/unit/test_base.py

@@ -140,6 +140,7 @@ def test_context_manager(self):
 class TestLegacySolverWrapper(unittest.TestCase):
     def test_class_method_list(self):
         expected_list = [
+            'api_version',
             'available',
             'config_block',
             'default_variable_value',

pyomo/gdp/plugins/multiple_bigm.py

@@ -27,6 +27,7 @@
 from pyomo.common.gc_manager import PauseGC
 from pyomo.common.modeling import unique_component_name
 from pyomo.common.dependencies import dill, dill_available, multiprocessing
+from pyomo.common.enums import SolverAPIVersion
 
 from pyomo.core import (
     Block,
@@ -54,8 +55,6 @@
 from pyomo.gdp.plugins.gdp_to_mip_transformation import GDP_to_MIP_Transformation
 from pyomo.gdp.util import _to_dict
 from pyomo.opt import SolverFactory, TerminationCondition
-from pyomo.contrib.solver.common.base import SolverBase as NewSolverBase
-from pyomo.contrib.solver.common.base import LegacySolverWrapper
 from pyomo.repn import generate_standard_repn
 
 from weakref import ref as weakref_ref
@@ -92,11 +91,8 @@ def Solver(val):
         return SolverFactory(val)
     if not hasattr(val, 'solve'):
         raise ValueError("Expected a string or solver object (with solve() method)")
-    if isinstance(val, NewSolverBase) and not isinstance(val, LegacySolverWrapper):
-        raise ValueError(
-            "Please pass an old-style solver object, using the "
-            "LegacySolverWrapper mechanism if necessary."
-        )
+    if not hasattr(val, 'api_version') or val.api_version() is not SolverAPIVersion.V1:
+        raise ValueError("Solver object should support the V1 solver API version")
     return val