Merge pull request #2760 from Robbybp/cyipopt-subclass

Refactor CyIpopt interface to subclass `cyipopt.Problem`

pyomo/contrib/pynumero/algorithms/solvers/implicit_functions.py

@@ -29,10 +29,10 @@
 # Use attempt_import here due to unguarded NumPy import in these files
 pyomo_nlp = attempt_import('pyomo.contrib.pynumero.interfaces.pyomo_nlp')[0]
 nlp_proj = attempt_import('pyomo.contrib.pynumero.interfaces.nlp_projections')[0]
-from pyomo.contrib.pynumero.algorithms.solvers.cyipopt_solver import (
+from pyomo.contrib.pynumero.algorithms.solvers.cyipopt_solver import CyIpoptSolver
+from pyomo.contrib.pynumero.interfaces.cyipopt_interface import (
     cyipopt_available,
     CyIpoptNLP,
-    CyIpoptSolver,
 )
 from pyomo.contrib.pynumero.algorithms.solvers.scipy_solvers import (
     FsolveNlpSolver,

pyomo/contrib/pynumero/algorithms/solvers/pyomo_ext_cyipopt.py

@@ -286,6 +286,10 @@ def __init__(
 
         # currently, this interface does not do anything with Hessians
 
+        # Call CyIpoptProblemInterface.__init__, which calls
+        # cyipopt.Problem.__init__
+        super(PyomoExternalCyIpoptProblem, self).__init__()
+
     def load_x_into_pyomo(self, primals):
         """
         Use this method to load a numpy array of values into the corresponding

pyomo/contrib/pynumero/algorithms/solvers/tests/test_cyipopt_interfaces.py

@@ -32,12 +32,12 @@
 
 from pyomo.contrib.pynumero.interfaces.pyomo_nlp import PyomoNLP
 
-from pyomo.contrib.pynumero.algorithms.solvers.cyipopt_solver import cyipopt_available
+from pyomo.contrib.pynumero.interfaces.cyipopt_interface import cyipopt_available
 
 if not cyipopt_available:
     raise unittest.SkipTest("Pynumero needs cyipopt to run CyIpoptSolver tests")
 
-from pyomo.contrib.pynumero.algorithms.solvers.cyipopt_solver import CyIpoptNLP
+from pyomo.contrib.pynumero.interfaces.cyipopt_interface import CyIpoptNLP
 
 
 def create_model1():

pyomo/contrib/pynumero/algorithms/solvers/tests/test_cyipopt_solver.py

@@ -33,16 +33,13 @@
 
 from pyomo.contrib.pynumero.interfaces.pyomo_nlp import PyomoNLP
 
-from pyomo.contrib.pynumero.algorithms.solvers.cyipopt_solver import cyipopt_available
-
-if not cyipopt_available:
-    raise unittest.SkipTest("Pynumero needs cyipopt to run CyIpoptSolver tests")
-
-from pyomo.contrib.pynumero.algorithms.solvers.cyipopt_solver import (
-    CyIpoptSolver,
+from pyomo.contrib.pynumero.interfaces.cyipopt_interface import (
+    cyipopt_available,
     CyIpoptNLP,
 )
 
+from pyomo.contrib.pynumero.algorithms.solvers.cyipopt_solver import CyIpoptSolver
+
 
 def create_model1():
     m = pyo.ConcreteModel()
@@ -158,6 +155,17 @@ def f(model):
     return model
 
 
+@unittest.skipIf(cyipopt_available, "cyipopt is available")
+class TestCyIpoptNotAvailable(unittest.TestCase):
+    def test_not_available_exception(self):
+        model = create_model1()
+        nlp = PyomoNLP(model)
+        msg = "cyipopt is required"
+        with self.assertRaisesRegex(RuntimeError, msg):
+            solver = CyIpoptSolver(CyIpoptNLP(nlp))
+
+
+@unittest.skipUnless(cyipopt_available, "cyipopt is not available")
 class TestCyIpoptSolver(unittest.TestCase):
     def test_model1(self):
         model = create_model1()
@@ -192,6 +200,7 @@ def test_model1_with_scaling(self):
 
         with open('_cyipopt-scaling.log', 'r') as fd:
             solver_trace = fd.read()
+        cynlp.close()
         os.remove('_cyipopt-scaling.log')
 
         # check for the following strings in the log and then delete the log

pyomo/contrib/pynumero/algorithms/solvers/tests/test_pyomo_ext_cyipopt.py

@@ -179,6 +179,7 @@ def test_pyomo_external_model_scaling(self):
 
         with open('_cyipopt-pyomo-ext-scaling.log', 'r') as fd:
             solver_trace = fd.read()
+        cyipopt_problem.close()
         os.remove('_cyipopt-pyomo-ext-scaling.log')
 
         self.assertIn('nlp_scaling_method = user-scaling', solver_trace)
@@ -253,6 +254,7 @@ def test_pyomo_external_model_ndarray_scaling(self):
 
         with open('_cyipopt-pyomo-ext-scaling-ndarray.log', 'r') as fd:
             solver_trace = fd.read()
+        cyipopt_problem.close()
         os.remove('_cyipopt-pyomo-ext-scaling-ndarray.log')
 
         self.assertIn('nlp_scaling_method = user-scaling', solver_trace)