gamspy 1.15.0__tar.gz → 1.15.1__tar.gz

{gamspy-1.15.0 → gamspy-1.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gamspy
-Version: 1.15.0
+Version: 1.15.1
 Summary: Python-based algebraic modeling interface to GAMS
 Author-email: GAMS Development Corporation <support@gams.com>
 Project-URL: homepage, https://gams.com/sales/gamspy_facts/
@@ -31,8 +31,8 @@ Classifier: Operating System :: Microsoft :: Windows
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: gamsapi[transfer]==50.4.0
-Requires-Dist: gamspy_base==50.4.0
+Requires-Dist: gamsapi[transfer]==50.4.1
+Requires-Dist: gamspy_base==50.4.1
 Requires-Dist: pydantic>=2.0
 Requires-Dist: certifi>=2022.09.14
 Requires-Dist: urllib3>=2.0.7

{gamspy-1.15.0 → gamspy-1.15.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gamspy"
-version = "1.15.0"
+version = "1.15.1"
 authors = [
   { name = "GAMS Development Corporation", email = "support@gams.com" },
 ]
@@ -36,8 +36,8 @@ classifiers = [
   "Operating System :: Microsoft :: Windows",
 ]
 dependencies = [
-  "gamsapi[transfer] == 50.4.0",
-  "gamspy_base == 50.4.0",
+  "gamsapi[transfer] == 50.4.1",
+  "gamspy_base == 50.4.1",
   "pydantic >= 2.0",
   "certifi >= 2022.09.14",
   "urllib3 >= 2.0.7",

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_algebra/expression.py

@@ -650,6 +650,9 @@ class Expression(operable.Operable):
 
                 if isinstance(node, Symbol):
                     if node.name not in symbols:
+                        if type(node) is gp_syms.Alias:
+                            symbols.append(node.alias_with.name)
+
                         symbols.append(node.name)
                     stack += node.domain
                     node = None

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_cli/install.py

@@ -261,7 +261,7 @@ def solver(
                     _ = subprocess.run(command, check=True, encoding="utf-8", stderr=subprocess.PIPE)
                 except subprocess.CalledProcessError as e:
                     raise GamspyException(
-                        f"Could not install gamspy-{solver_name}. Please check your internet connection. If it's not related to your internet connection, PyPI servers might be down. Please retry it later. Here is the error message of pip:\n\n{e.stderr.decode('utf-8')}"
+                        f"Could not install gamspy-{solver_name}. Please check your internet connection. If it's not related to your internet connection, PyPI servers might be down. Please retry it later. Here is the error message of pip:\n\n{e.stderr}"
                     ) from e
             else:
                 try:

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_cli/retrieve.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import os
 import subprocess
+from typing import Optional
 
 import typer
 
@@ -37,6 +38,7 @@ def license(
         "-o",
         help="Output path for the license file."
     ),
+    checkout_duration: Optional[int] = typer.Option(None, "--checkout-duration", "-c", help="Specifies a duration in hours to checkout a session."),
 ) -> None:
     if input is None or not os.path.isfile(input):
         raise ValidationError(
@@ -49,13 +51,18 @@ def license(
         )
 
     gamspy_base_dir = utils._get_gamspy_base_directory()
+    command = [
+        os.path.join(gamspy_base_dir, "gamsgetkey"),
+        access_code,
+        "-i",
+        input,
+    ]
+    if checkout_duration:
+        command.append("-c")
+        command.append(str(checkout_duration))
+    
     process = subprocess.run(
-        [
-            os.path.join(gamspy_base_dir, "gamsgetkey"),
-            access_code,
-            "-i",
-            input,
-        ],
+        command,
         text=True,
         capture_output=True,
     )

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_config.py

@@ -55,6 +55,10 @@ def _set_default_options() -> None:
     strategy = int(os.getenv("GAMSPY_DROP_DOMAIN_VIOLATIONS", 0))
     configuration["DROP_DOMAIN_VIOLATIONS"] = strategy
 
+    # Do not allow ambiguity in MCP, EMP, MPEC models by default
+    ambiguity = os.getenv("GAMSPY_ALLOW_AMBIGUOUS_EQUATIONS", "auto")
+    configuration["ALLOW_AMBIGUOUS_EQUATIONS"] = ambiguity
+
 
 def set_options(
     options: dict[
@@ -67,6 +71,7 @@ def set_options(
             "ASSUME_VARIABLE_SUFFIX",
             "USE_PY_VAR_NAME",
             "DROP_DOMAIN_VIOLATIONS",
+            "ALLOW_AMBIGUOUS_EQUATIONS",
         ],
         Any,
     ],

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_container.py

@@ -580,7 +580,7 @@ class Container(gt.Container):
         modified_names = []
 
         for name, symbol in self:
-            if symbol.modified:
+            if symbol._modified:
                 if (
                     type(symbol) is gp.Alias
                     and symbol.alias_with.name not in modified_names  # type: ignore

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_convert.py

@@ -490,7 +490,7 @@ class GamsConverter:
             file.write(gams_string)
 
         logger.info(
-            f"GAMS (.gms) file has been generated under {os.path.join(self.path, self.model.name + '.gms')}"
+            f"GAMS (.gms) file has been generated under {self.gms_path}"
         )
 
 

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_miro.py

@@ -45,7 +45,11 @@ def load_miro_symbol_records(container: Container):
         for name in names:
             symbol = container[name]
             symbol._already_loaded = True
-            if isinstance(symbol, gp.Parameter) and symbol._is_miro_table:
+            if (
+                isinstance(symbol, gp.Parameter)
+                and symbol._is_miro_table
+                and symbol._records is not None
+            ):
                 symbol._records.columns = symbol.domain_names + ["value"]
 
     # Load records of miro output symbols

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_symbols/alias.py

@@ -134,7 +134,7 @@ class Alias(gt.Alias, operable.Operable, Symbol, SetMixin):
             # reset some properties
             self._requires_state_check = True
             self.container._requires_state_check = True
-            self.modified = True
+            self._modified = True
             self.alias_with = alias_with
         else:
             if container is None:
@@ -157,7 +157,7 @@ class Alias(gt.Alias, operable.Operable, Symbol, SetMixin):
             self.where = condition.Condition(self)
             self.container._add_statement(self)
 
-            self.modified = False
+            self._modified = False
             self.container._synch_with_gams()
 
     def _serialize(self) -> dict:

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_symbols/equation.py

@@ -18,6 +18,7 @@ from gams.transfer._internals import (
 import gamspy as gp
 import gamspy._algebra.condition as condition
 import gamspy._algebra.expression as expression
+import gamspy._algebra.operable as operable
 import gamspy._symbols.implicits as implicits
 import gamspy._validation as validation
 import gamspy.utils as utils
@@ -273,7 +274,7 @@ class Equation(gt.Equation, Symbol):
                     " domains are equal"
                 )
 
-            if self.domain_forwarding != domain_forwarding:
+            if self._domain_forwarding != domain_forwarding:
                 raise ValueError(
                     "Cannot overwrite symbol in container unless"
                     " 'domain_forwarding' is left unchanged"
@@ -287,8 +288,8 @@ class Equation(gt.Equation, Symbol):
 
             previous_state = self.container._options.miro_protect
             self.container._options.miro_protect = False
-            self.records = None
-            self.modified = True
+            self._records = None
+            self._modified = True
             self._init_definition(definition)
 
             # only set records if records are provided
@@ -360,14 +361,14 @@ class Equation(gt.Equation, Symbol):
                 self.setRecords(records, uels_on_axes=uels_on_axes)
             else:
                 if not self._is_miro_output:
-                    self.modified = False
+                    self._modified = False
                 self.container._synch_with_gams()
 
             container._options.miro_protect = previous_state
 
     def _serialize(self) -> dict:
         info = {
-            "_domain_forwarding": self.domain_forwarding,
+            "_domain_forwarding": self._domain_forwarding,
             "_is_miro_output": self._is_miro_output,
             "_metadata": self._metadata,
             "_synchronize": self._synchronize,
@@ -554,6 +555,37 @@ class Equation(gt.Equation, Symbol):
         self.container._add_statement(statement)
         self._definition = statement
 
+    def _check_ambiguity(self) -> None:
+        """Ambiguity check for MCP, EMP, MPEC models. See #610"""
+        # Looks for =e=, =l= and =g= in an equation definition
+        # with a stack based inorder traversal algorithm (O(N)).
+        stack = []
+
+        assert self._definition is not None
+        node = self._definition.right
+        while True:
+            if node is not None:
+                stack.append(node)
+                node = getattr(node, "left", None)  # type: ignore
+            elif stack:
+                node = stack.pop()
+                if (
+                    isinstance(node, expression.Expression)
+                    and node.operator in {"=e=", "=l=", "=g=", "=x=", "=n="}
+                    and not isinstance(node.right, operable.Operable)
+                ):
+                    raise ValidationError(
+                        f"Definition of `{self.name}` is ambigiuous. Please "
+                        "use gp.Number for numeric values or disable ambiguity "
+                        "check via gp.set_options({'ALLOW_AMBIGUOUS_EQUATIONS': 'no'}). "
+                        "Using numeric values in equations without gp.Number can result in "
+                        f"different order than expected. Print `{self.name}.getDefinition()` to "
+                        "make sure that the equation definition is as expected."
+                    )
+                node = getattr(node, "right", None)
+            else:
+                break  # pragma: no cover
+
     @property
     def l(self):  # noqa: E741, E743
         """
@@ -1000,12 +1032,12 @@ class Equation(gt.Equation, Symbol):
         self._records = records
 
         self._requires_state_check = True
-        self.modified = True
+        self._modified = True
 
         self.container._requires_state_check = True
         self.container.modified = True
 
-        if self._records is not None and self.domain_forwarding:
+        if self._records is not None and self._domain_forwarding:
             self._domainForwarding()
 
             # reset state check flags for all symbols in the container
@@ -1159,7 +1191,7 @@ class Equation(gt.Equation, Symbol):
         output = f"Equation {self.name}"
 
         if self.domain:
-            output += self._get_domain_str(self.domain_forwarding)
+            output += self._get_domain_str(self._domain_forwarding)
 
         if self.description:
             output += ' "' + self.description + '"'

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_symbols/implicits/implicit_equation.py

@@ -2,9 +2,11 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
+import gamspy._symbols as syms
 import gamspy._symbols.alias as alias
 import gamspy._symbols.implicits as implicits
 import gamspy._symbols.set as gams_set
+import gamspy.utils as utils
 from gamspy._symbols.implicits.implicit_symbol import ImplicitSymbol
 
 if TYPE_CHECKING:
@@ -141,10 +143,22 @@ class ImplicitEquation(ImplicitSymbol):
         if self.parent.records is None:
             return None
 
-        recs = self.parent.records
-        for idx, literal in self._scalar_domains:
-            column_name = recs.columns[idx]
-            recs = recs[recs[column_name] == literal]
+        temp_name = "ie" + utils._get_unique_name()
+        temp_param = syms.Parameter._constructor_bypass(
+            self.container, temp_name, self.parent.domain
+        )
+        domain = list(self.domain)
+        for i, d in self._scalar_domains:
+            domain.insert(i, d)
+
+        temp_param[domain] = self.l
+        del self.container.data[temp_name]
+
+        recs = temp_param.records
+        if recs is not None:
+            columns = recs.columns.to_list()
+            columns[columns.index("value")] = "level"
+            recs.columns = columns
 
         return recs
 

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_symbols/implicits/implicit_parameter.py

@@ -1,13 +1,14 @@
 from __future__ import annotations
 
 import logging
-from collections.abc import Iterable
+from collections.abc import Sequence
 from typing import TYPE_CHECKING, Any
 
 import gamspy._algebra.expression as expression
 import gamspy._algebra.operable as operable
 import gamspy._algebra.operation as operation
 import gamspy._symbols as syms
+import gamspy._symbols.implicits as implicits
 import gamspy._validation as validation
 import gamspy.utils as utils
 from gamspy._symbols.implicits.implicit_symbol import ImplicitSymbol
@@ -26,6 +27,7 @@ if TYPE_CHECKING:
     )
     from gamspy._algebra.expression import Expression
     from gamspy._algebra.operation import Operation
+    from gamspy._types import EllipsisType
 
 logger = logging.getLogger("GAMSPy")
 logger.setLevel(logging.WARNING)
@@ -41,6 +43,11 @@ ATTR_MAPPING = {
     "lo": "lower",
     "up": "upper",
     "scale": "scale",
+    "range": "range",
+    "slack": "slack",
+    "slacklo": "slacklo",
+    "slackup": "slackup",
+    "infeas": "infeas",
 }
 
 SET_ATTR_MAPPING = {
@@ -81,7 +88,10 @@ class ImplicitParameter(ImplicitSymbol, operable.Operable):
         self._records = records
         self._assignment = None
 
-    def __getitem__(self, indices: Iterable | str) -> ImplicitParameter:
+    def __getitem__(
+        self,
+        indices: EllipsisType | slice | Sequence | str | implicits.ImplicitSet,
+    ) -> ImplicitParameter:
         domain = validation.validate_domain(self, indices)
 
         return ImplicitParameter(
@@ -94,7 +104,7 @@ class ImplicitParameter(ImplicitSymbol, operable.Operable):
 
     def __setitem__(
         self,
-        indices: Iterable | str,
+        indices: EllipsisType | slice | Sequence | str | implicits.ImplicitSet,
         rhs: Expression | Operation | ImplicitParameter | int | float,
     ) -> None:
         if (
@@ -146,32 +156,6 @@ class ImplicitParameter(ImplicitSymbol, operable.Operable):
     def __repr__(self) -> str:
         return f"ImplicitParameter(parent={self.parent}, name='{self.name}', domain={self.domain}, permutation={self.permutation}), parent_scalar_domains={self.parent_scalar_domains})"
 
-    def _add_new_attr_column(
-        self, extension: str, recs: pd.DataFrame
-    ) -> pd.DataFrame:
-        parent_recs: pd.DataFrame = self.parent.records
-        if extension == "range":
-            recs[extension] = parent_recs["lower"] - parent_recs["upper"]
-        elif extension == "slacklo":
-            recs[extension] = (
-                parent_recs["level"] - parent_recs["lower"]
-            ).clip(0)
-        elif extension == "slackup":
-            recs[extension] = (
-                parent_recs["upper"] - parent_recs["level"]
-            ).clip(0)
-        elif extension == "slack":
-            slacklo = (parent_recs["level"] - parent_recs["lower"]).clip(0)
-            slackup = (parent_recs["upper"] - parent_recs["level"]).clip(0)
-            recs[extension] = slacklo.combine(slackup, min)
-        elif extension == "infeas":
-            distance_to_lower = parent_recs["lower"] - parent_recs["level"]
-            distance_to_upper = parent_recs["level"] - parent_recs["upper"]
-            max_distance = distance_to_lower.combine(distance_to_upper, max)
-            recs[extension] = max_distance.clip(lower=0)
-
-        return recs
-
     @property
     def records(self) -> pd.DataFrame | float | None:
         if self.parent.records is None:
@@ -187,37 +171,49 @@ class ImplicitParameter(ImplicitSymbol, operable.Operable):
             del self.container.data[temp_name]
             return temp_param.records
         elif isinstance(self.parent, syms.Parameter):
-            recs = self.parent.records
-            for idx, literal in self._scalar_domains:
-                column_name = recs.columns[idx]
-                recs = recs[recs[column_name] == literal]
-
-            if all(
-                isinstance(elem, str) and elem != "*" for elem in self.domain
-            ):
+            temp_name = "p" + utils._get_unique_name()
+            temp_param = syms.Parameter._constructor_bypass(
+                self.container, temp_name, self.parent.domain
+            )
+            domain = list(self.domain)
+            for i, d in self._scalar_domains:
+                domain.insert(i, d)
+
+            temp_param[domain] = self[...]
+            del self.container.data[temp_name]
+
+            recs = temp_param.records
+            if len(recs) == 1:
                 return float(recs["value"].squeeze())
 
             return recs
         elif isinstance(self.parent, (syms.Variable, syms.Equation)):
             extension = self.name.split(".")[-1]
-            column_names: list[str] = self.parent.domain_labels
-
-            if extension in ATTR_MAPPING:
+            if self.parent.dimension == 0:
                 extension = ATTR_MAPPING[extension]
-                column_names.append(extension)
+                return float(self.parent.records[extension].squeeze())
+
+            temp_name = "ip" + utils._get_unique_name()
+            temp_param = syms.Parameter._constructor_bypass(
+                self.container, temp_name, self.parent.domain
+            )
+            domain = list(self.domain)
+            for i, d in self._scalar_domains:
+                domain.insert(i, d)
+
+            temp_param[domain] = self
+            del self.container.data[temp_name]
 
-            recs = self.parent.records[column_names].copy()
-            if extension not in ATTR_MAPPING:
-                # eq.range, eq.slacklo, eq.slackup, eq.slack, eq.infeas
-                recs = self._add_new_attr_column(extension, recs)
+            recs = temp_param.records
+            if recs is None:
+                return recs
 
-            for idx, literal in self._scalar_domains:
-                column_name = recs.columns[idx]
-                recs = recs[recs[column_name] == literal]
+            extension = ATTR_MAPPING[extension]
+            columns = recs.columns.to_list()
+            columns[columns.index("value")] = extension
+            recs.columns = columns
 
-            if all(
-                isinstance(elem, str) and elem != "*" for elem in self.domain
-            ):
+            if len(recs) == 1:
                 return float(recs[extension].squeeze())
 
             return recs

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_symbols/implicits/implicit_set.py

@@ -9,6 +9,7 @@ import gamspy._symbols as syms
 import gamspy._validation as validation
 import gamspy.utils as utils
 from gamspy._symbols.implicits.implicit_symbol import ImplicitSymbol
+from gamspy.exceptions import ValidationError
 
 if TYPE_CHECKING:
     import pandas as pd
@@ -67,12 +68,22 @@ class ImplicitSet(ImplicitSymbol, operable.Operable):
         if self.parent.records is None:
             return None
 
-        recs = self.parent.records
-        for idx, literal in self._scalar_domains:
-            column_name = recs.columns[idx]
-            recs = recs[recs[column_name] == literal]
+        if self.extension is not None:
+            raise ValidationError(
+                ".records is not allowed for lag/lead operations."
+            )
+
+        temp_name = "is" + utils._get_unique_name()
+        temp_param = syms.Set._constructor_bypass(
+            self.container, temp_name, self.parent.domain
+        )
+        domain = list(self.domain)
+        for i, d in self._scalar_domains:
+            domain.insert(i, d)
 
-        return recs
+        temp_param[domain] = self
+        del self.container.data[temp_name]
+        return temp_param.records
 
     def latexRepr(self):
         name = self.name.replace("_", "\\_")

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_symbols/implicits/implicit_variable.py

@@ -5,6 +5,7 @@ from typing import TYPE_CHECKING
 
 import gamspy._algebra.expression as expression
 import gamspy._algebra.operable as operable
+import gamspy._symbols as syms
 import gamspy._symbols.implicits as implicits
 import gamspy._validation as validation
 import gamspy.utils as utils
@@ -217,10 +218,22 @@ class ImplicitVariable(ImplicitSymbol, operable.Operable):
         if self.parent.records is None:
             return None
 
-        recs = self.parent.records
-        for idx, literal in self._scalar_domains:
-            column_name = recs.columns[idx]
-            recs = recs[recs[column_name] == literal]
+        temp_name = "iv" + utils._get_unique_name()
+        temp_param = syms.Parameter._constructor_bypass(
+            self.container, temp_name, self.parent.domain
+        )
+        domain = list(self.domain)
+        for i, d in self._scalar_domains:
+            domain.insert(i, d)
+
+        temp_param[domain] = self.l
+        del self.container.data[temp_name]
+
+        recs = temp_param.records
+        if recs is not None:
+            columns = recs.columns.to_list()
+            columns[columns.index("value")] = "level"
+            recs.columns = columns
 
         return recs
 

{gamspy-1.15.0 → gamspy-1.15.1}/src/gamspy/_symbols/parameter.py

@@ -234,7 +234,7 @@ class Parameter(gt.Parameter, operable.Operable, Symbol):
                     " domains are equal"
                 )
 
-            if self.domain_forwarding != domain_forwarding:
+            if self._domain_forwarding != domain_forwarding:
                 raise ValueError(
                     "Cannot overwrite symbol in container unless"
                     " 'domain_forwarding' is left unchanged"
@@ -248,8 +248,8 @@ class Parameter(gt.Parameter, operable.Operable, Symbol):
 
             previous_state = self.container._options.miro_protect
             self.container._options.miro_protect = False
-            self.records = None
-            self.modified = True
+            self._records = None
+            self._modified = True
 
             # only set records if records are provided
             if records is not None:
@@ -301,7 +301,7 @@ class Parameter(gt.Parameter, operable.Operable, Symbol):
             if records is not None:
                 super().setRecords(records, uels_on_axes=uels_on_axes)
                 if self.dimension == 0 and not self._is_miro_symbol:
-                    self.modified = False
+                    self._modified = False
 
                 if gp.get_option("DROP_DOMAIN_VIOLATIONS"):
                     if self.hasDomainViolations():
@@ -311,7 +311,7 @@ class Parameter(gt.Parameter, operable.Operable, Symbol):
                         self._domain_violations = None
             else:
                 if not self._is_miro_symbol:
-                    self.modified = False
+                    self._modified = False
 
             self.container._synch_with_gams(gams_to_gamspy=self._is_miro_input)
 
@@ -319,7 +319,7 @@ class Parameter(gt.Parameter, operable.Operable, Symbol):
 
     def _serialize(self) -> dict:
         info = {
-            "_domain_forwarding": self.domain_forwarding,
+            "_domain_forwarding": self._domain_forwarding,
             "_is_miro_input": self._is_miro_input,
             "_is_miro_output": self._is_miro_output,
             "_is_miro_table": self._is_miro_table,
@@ -490,12 +490,12 @@ class Parameter(gt.Parameter, operable.Operable, Symbol):
         self._records = records
 
         self._requires_state_check = True
-        self.modified = True
+        self._modified = True
 
         self.container._requires_state_check = True
         self.container.modified = True
 
-        if self._records is not None and self.domain_forwarding:
+        if self._records is not None and self._domain_forwarding:
             self._domainForwarding()
 
             # reset state check flags for all symbols in the container
@@ -562,7 +562,7 @@ class Parameter(gt.Parameter, operable.Operable, Symbol):
         """
         representation = self.name
         if self.domain:
-            representation += self._get_domain_str(self.domain_forwarding)
+            representation += self._get_domain_str(self._domain_forwarding)
 
         return representation