Merge pull request #29 from IBMDecisionOptimization/prepare_release_2.30

New Release

Author: deepanshu2609

CHANGELOG.rst

@@ -1,8 +1,21 @@
 Changelog
 ---------
 
-Changed in 2.29.241:
+Changed in 2.30.251:
 ````````````````````
+* Fix for SyntaxWarning: invalid escape sequence when running with Python version > 3.12.
+* Replace the deprecated usage of 'strtobool' with Python >= 3.12
+* modeller.constant(x) function creates an unhandled constant(x) in .cpo file
+* docplex config --upgrade requires setuptools with Python >= 3.12
+* docplex config --upgrade retrieves python executable
+* Conda SafetyError on reinstalling with conda install cplex after a docplex config --upgrade
+* C-style comments not allowed inside """ ... """ in some Python 3.12 versions
+* Replace the deprecated usage of strtobool
+* Fix export crash when an incorrect format is passed
+* Report best bound in solve details even if no integer solution has been found
+
+Changed in 2.29.245 (2025.04):
+``````````````````````````````
 
 * each record of a solve history use a unique timestamp for its fields
 

docplex/cp/catalog.py

@@ -268,7 +268,7 @@ def __init__(self, cpname, pyname, kwrd, prio, signs):
         self.cpo_name = cpname
         self.python_name = pyname
         self.priority = prio
-        if kwrd:
+        if kwrd is not None:
             self.keyword = kwrd
         else:
             self.keyword = cpname
@@ -571,8 +571,8 @@ def __ne__(self, other):
                                                                                            CpoSignature(Type_Constraint, (Type_PositiveInt, Type_CumulExpr)),
                                                                                            CpoSignature(Type_Constraint, (Type_CumulExpr, Type_IntExpr)),
                                                                                            CpoSignature(Type_Constraint, (Type_IntExpr, Type_CumulExpr))) )
-Oper_lexicographic               = CpoOperation("lexicographic", "lexicographic", None, -1, ( CpoSignature(Type_Constraint, (Type_IntExprArray, Type_IntExprArray)),) )
-Oper_strict_lexicographic        = CpoOperation("strictLexicographic", "strict_lexicographic", None, -1, ( CpoSignature(Type_Constraint, (Type_IntExprArray, Type_IntExprArray)),) )
+Oper_lexicographic               = CpoOperation("lexicographic", "lexicographic", None, -1, ( CpoSignature(Type_BoolExpr, (Type_IntExprArray, Type_IntExprArray)),) )
+Oper_strict_lexicographic        = CpoOperation("strictLexicographic", "strict_lexicographic", None, -1, ( CpoSignature(Type_BoolExpr, (Type_IntExprArray, Type_IntExprArray)),) )
 Oper_log                         = CpoOperation("log", "log", None, -1, ( CpoSignature(Type_FloatExpr, (Type_FloatExpr,)),) )
 Oper_logical_and                 = CpoOperation("and", "logical_and", "&&", 7, ( CpoSignature(Type_BoolExpr, (Type_BoolExpr, Type_BoolExpr)),
                                                                                  CpoSignature(Type_BoolExpr, (Type_BoolExprArray,)),) )

docplex/cp/config.py

@@ -4,7 +4,7 @@
 # (c) Copyright IBM Corp. 2015 - 2022
 # --------------------------------------------------------------------------
 
-"""
+r"""
 Configuration of the CP Optimizer Python API
 
 This module is the top-level handler of the configuration parameters for

docplex/cp/cpo/cpo_compiler.py

@@ -404,7 +404,7 @@ def _write_expression(self, out, xinfo):
                 if isinstance(expr, CpoAlias):
                     # Simple alias
                     out.write(name + u" = " + self._compile_expression(expr.expr, False) + u";\n")
-                elif isroot and expr.type in (Type_Constraint, Type_SearchPhase, Type_BoolExpr):
+                elif isroot and expr.type in (Type_Constraint, Type_SearchPhase, Type_BoolExpr, Type_Objective):
                     # Named constraint
                     if self.is_format_at_least_12_8:
                         out.write(name + u": " + self._compile_expression(expr, True) + u";\n")
@@ -557,10 +557,12 @@ def _compile_expression(self, expr, root=True):
                             estack[-1] = [res, 0, False]
                             continue
 
-                        cout.append(self._get_id_string(oper.keyword))
-                        cout.append("(")
+                        if len(oper.keyword) > 0:
+                            cout.append(self._get_id_string(oper.keyword))
+                            cout.append("(")
                     if cnx >= oplen:
-                        cout.append(")")
+                        if len(oper.keyword) > 0:
+                            cout.append(")")
                         estack.pop()
                     else:
                         edscr[1] += 1

docplex/cp/cpo/cpo_parser.py

@@ -30,7 +30,7 @@
 MIN_CPO_VERSION_NUMBER = "12.6.0.0"
 
 # Maximum CPO format version number
-MAX_CPO_VERSION_NUMBER = "21.10.0.0"
+MAX_CPO_VERSION_NUMBER = "22.1.2.0"
 
 # Map of all operators. Key is operator, value is list of corresponding operation descriptors
 _ALL_OPERATORS = {}
@@ -806,9 +806,9 @@ def _read_section_internals(self):
                         if compare_natural(ver, MIN_CPO_VERSION_NUMBER) < 0:
                             raise CpoUnsupportedFormatVersionException("Can not parse a CPO file with version {}, lower than {}"
                                                                        .format(ver, MIN_CPO_VERSION_NUMBER))
-                        if compare_natural(ver, MAX_CPO_VERSION_NUMBER) > 0:
-                            raise CpoUnsupportedFormatVersionException("Can not parse a CPO file with version {}, greater than {}"
-                                                                       .format(ver, MAX_CPO_VERSION_NUMBER))
+                        # if compare_natural(ver, MAX_CPO_VERSION_NUMBER) > 0:
+                        #    raise CpoUnsupportedFormatVersionException("Can not parse a CPO file with version {}, greater than {}"
+                        #                                               .format(ver, MAX_CPO_VERSION_NUMBER))
                 self._check_token(self._next_token(), TOKEN_PARENT_CLOSE)
             tok = self._next_token()
 

docplex/cp/expression.py

@@ -2186,7 +2186,13 @@ def _domain_iterator(d):
     if isinstance(d, (tuple, list)):
         for x in d:
             if isinstance(x, (list, tuple)):
-                min, max = x
+                # test changes
+                assert len(x) == 2 or (len(x) == 3 and x[2] == "holes")
+                min, max = x[:2]
+                # if len(x)>2:
+                #    min, max = x[0],x[1] 
+                # else:
+                # min, max = x
                 if min == max:
                     yield min
                 else:

docplex/cp/lp/lp_tokenizer.py

@@ -69,7 +69,7 @@ class LpTokenizer(Tokenizer):
     __slots__ = ()
 
     def __init__(self, **args):
-        """ Create a new tokenizer
+        r""" Create a new tokenizer
         Args:
             See arguments list of :class:`~docplex.cp.utils.Tokenizer`
         """
@@ -201,7 +201,7 @@ def _read_symbol(self):
 
 
     def _read_antislash(self):
-        """ Read token starting by \ """
+        r""" Read token starting by \ """
         self._skip_to_end_of_line()
         return Token(TOKEN_TYPE_COMMENT, None if self.skip_comments else self._get_token()[:-1])
 

docplex/cp/modeler.py

@@ -1735,7 +1735,7 @@ def lexicographic(x, y):
     x = _convert_arg(x, "x", Type_IntExprArray)
     y = _convert_arg(y, "y", Type_IntExprArray)
     _check_same_size_arrays(x, y)
-    return CpoFunctionCall(Oper_lexicographic, Type_Constraint, (x, y))
+    return CpoFunctionCall(Oper_lexicographic, Type_BoolExpr, (x, y))
 
 
 def strict_lexicographic(x, y):
@@ -1762,7 +1762,7 @@ def strict_lexicographic(x, y):
     x = _convert_arg(x, "x", Type_IntExprArray)
     y = _convert_arg(y, "y", Type_IntExprArray)
     _check_same_size_arrays(x, y)
-    return CpoFunctionCall(Oper_strict_lexicographic, Type_Constraint, (x, y))
+    return CpoFunctionCall(Oper_strict_lexicographic, Type_BoolExpr, (x, y))
 
 
 def standard_deviation(x, meanLB=NEGATIVE_INFINITY, meanUB=POSITIVE_INFINITY):

docplex/cp/solution.py

@@ -1776,7 +1776,7 @@ def get_objective_bound(self):
 
 
     def get_objective_gaps(self):
-        """ Gets the numeric values of the gap between objective value and objective bound.
+        r""" Gets the numeric values of the gap between objective value and objective bound.
 
         For a single objective, gap is calculated as gap = \|value - bound\| / max(1e-10, \|value\|)
 
@@ -1792,7 +1792,7 @@ def get_objective_gaps(self):
 
 
     def get_objective_gap(self):
-        """ Gets the numeric values of the gap between the first objective value and objective bound.
+        r""" Gets the numeric values of the gap between the first objective value and objective bound.
 
         For a single objective, gap is calculated as gap = \|value - bound\| / max(1e-10, \|value\|)
 

docplex/mp/cplex_engine.py

@@ -21,6 +21,7 @@
 from docplex.mp.constants import ConflictStatus
 from docplex.mp.constr import IndicatorConstraint, RangeConstraint, BinaryConstraint, \
     EquivalenceConstraint
+from docplex.mp.format import ExchangeFormat
 from docplex.mp.progress import ProgressData
 from docplex.mp.qprogress import QProgressData
 from docplex.mp.solution import SolveSolution, SolutionPool
@@ -2048,12 +2049,13 @@ def solve(self, mdl, parameters=None, **kwargs):
             is_mip = cpx._is_MIP()
 
             solve_ok = self._is_solve_status_ok(cpx_status)
-            if solve_ok:
-                nb_iterations, nb_nodes_processed = get_progress_details(cpx)
-                if is_mip:
+            if is_mip:
+                if not self._is_multiobj():
+                    cpx_bestbound = cpx.solution.MIP.get_best_objective()
+                if solve_ok:
+                    nb_iterations, nb_nodes_processed = get_progress_details(cpx)
                     if not self._is_multiobj():
                         cpx_miprelgap = cpx.solution.MIP.get_mip_relative_gap()
-                        cpx_bestbound = cpx.solution.MIP.get_best_objective()
                     else:
                         cpx_miprelgap = cpx_bestbound = self.get_infinity()
 
@@ -2547,6 +2549,9 @@ def var_by_index(idx):
         return ConflictRefinerResult(conflicts, refined_by=self.name)
 
     def export(self, out, exchange_format):
+        if exchange_format is not None and not isinstance(exchange_format, ExchangeFormat):
+            self._model.fatal("Not a valid  exchange format: {0}", exchange_format)
+
         self.sync_cplex()
         if is_string(out):
             path = out
@@ -2563,7 +2568,7 @@ def export(self, out, exchange_format):
                 else:
                     raise DOcplexException("CPLEX error in SAV export: {0!s}", cpx_se)
         else:
-            # assume a file-like object
+            # delegate to cplex, assume write and close methods.
             filetype = exchange_format.filetype
             return self._cplex.write_to_stream(out, filetype)