Merge pull request #3555 from mrmundt/remove-legacy-warning

Remove loud deprecation warning in `contrib.solver`

Author: mrmundt

Diff for: doc/OnlineDocs/explanation/experimental/solvers.rst

@@ -85,7 +85,6 @@ be used with other Pyomo tools / capabilities.
    :skipif: not ipopt_available
    :hide:
 
-   ...
    2 Var Declarations
    ...
    3 Declarations: x y obj
@@ -117,7 +116,6 @@ future methods of specifying solver options are supported:
    :skipif: not ipopt_available
    :hide:
 
-   ...
    2 Var Declarations
    ...
    3 Declarations: x y obj
@@ -154,7 +152,7 @@ Here we use the new interface by importing it directly:
    :skipif: not ipopt_available
    :hide:
 
-   solution_loader: ...
+   termination_condition: ...
    ...
    3 Declarations: x y obj
 
@@ -190,7 +188,7 @@ Here we use the new interface by retrieving it from the new ``SolverFactory``:
    :skipif: not ipopt_available
    :hide:
 
-   solution_loader: ...
+   termination_condition: ...
    ...
    3 Declarations: x y obj
 
@@ -227,7 +225,7 @@ replace the existing (legacy) SolverFactory and utilities with the new
    :skipif: not ipopt_available
    :hide:
 
-   solution_loader: ...
+   termination_condition: ...
    ...
    3 Declarations: x y obj
 
@@ -313,6 +311,37 @@ which can be manipulated similar to a standard ``dict`` in Python.
    :members:
    :undoc-members:
 
+The new interface has condensed :py:class:`~pyomo.opt.results.solver.SolverStatus`,
+:py:class:`~pyomo.opt.results.solver.TerminationCondition`,
+and :py:class:`~pyomo.opt.results.solution.SolutionStatus` into
+:py:class:`~pyomo.contrib.solver.common.results.TerminationCondition`
+and :py:class:`~pyomo.contrib.solver.common.results.SolutionStatus` to
+reduce complexity. As a result, several legacy
+:py:class:`~pyomo.opt.results.solver.SolutionStatus` values are
+no longer achievable. These are detailed in the table below.
+
+.. list-table:: Mapping from unachievable :py:class:`~pyomo.opt.results.solver.SolutionStatus`
+                to future statuses
+   :header-rows: 1
+
+   * - Legacy :py:class:`~pyomo.opt.results.solver.SolutionStatus`
+     - :py:class:`~pyomo.contrib.solver.common.results.TerminationCondition`
+     - :py:class:`~pyomo.contrib.solver.common.results.SolutionStatus`
+   * - other
+     - unknown
+     - noSolution
+   * - unsure
+     - unknown
+     - noSolution
+   * - locallyOptimal
+     - convergenceCriteriaSatisfied
+     - optimal
+   * - globallyOptimal
+     - convergenceCriteriaSatisfied
+     - optimal
+   * - bestSoFar
+     - convergenceCriteriaSatisfied
+     - feasible
 
 Termination Conditions
 ^^^^^^^^^^^^^^^^^^^^^^

Diff for: pyomo/contrib/solver/common/results.py

@@ -21,8 +21,8 @@
     In,
     NonNegativeFloat,
     ADVANCED_OPTION,
+    DEVELOPER_OPTION,
 )
-from pyomo.common.deprecation import deprecation_warning
 from pyomo.opt.results.solution import SolutionStatus as LegacySolutionStatus
 from pyomo.opt.results.solver import (
     TerminationCondition as LegacyTerminationCondition,
@@ -144,7 +144,8 @@ def __init__(
         self.solution_loader = self.declare(
             'solution_loader',
             ConfigValue(
-                description="Object for loading the solution back into the model."
+                description="Object for loading the solution back into the model.",
+                visibility=DEVELOPER_OPTION,
             ),
         )
         self.termination_condition: TerminationCondition = self.declare(
@@ -293,19 +294,6 @@ def legacy_solution_status_map(results):
     objects. Because we condensed results objects, some of the previous statuses
     are no longer clearly achievable.
     """
-    deprecation_warning(
-        """The new interface has condensed LegacySolverStatus,
-LegacyTerminationCondition, and LegacySolutionStatus into TerminationCondition
-and SolutionStatus to reduce complexity. As a result, several LegacySolutionStatus values
-are no longer achievable:
-    - `LegacySolutionStatus.other` -> `TerminationCondition.unknown`, `SolutionStatus.noSolution`
-    - `LegacySolutionStatus.unsure` -> `TerminationCondition.unknown`, `SolutionStatus.noSolution`
-    - `LegacySolutionStatus.locallyOptimal` -> `TerminationCondition.convergenceCriteriaSatisfied`, `SolutionStatus.optimal`
-    - `LegacySolutionStatus.globallyOptimal` -> `TerminationCondition.convergenceCriteriaSatisfied`, `SolutionStatus.optimal`
-    - `LegacySolutionStatus.bestSoFar` -> `TerminationCondition.convergenceCriteriaSatisfied`, `SolutionStatus.feasible`
-""",
-        version='6.9.1.dev0',
-    )
     if results.termination_condition in set(
         [
             TerminationCondition.maxTimeLimit,

Diff for: pyomo/contrib/solver/tests/unit/test_results.py

@@ -192,8 +192,7 @@ def test_display(self):
         res = results.Results()
         stream = StringIO()
         res.display(ostream=stream)
-        expected_print = """solution_loader: None
-termination_condition: TerminationCondition.unknown
+        expected_print = """termination_condition: TerminationCondition.unknown
 solution_status: SolutionStatus.noSolution
 incumbent_objective: None
 objective_bound: None