gamspy 1.15.0__tar.gz → 1.16.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gamspy
-Version: 1.15.0
+Version: 1.16.0
 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/
@@ -19,11 +19,11 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: POSIX
 Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS
@@ -31,13 +31,12 @@ 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]>=51.1.0
+Requires-Dist: gamspy_base>=51.1.0
 Requires-Dist: pydantic>=2.0
 Requires-Dist: certifi>=2022.09.14
 Requires-Dist: urllib3>=2.0.7
-Requires-Dist: typer>=0.15.1
-Requires-Dist: click<8.2.0
+Requires-Dist: typer>=0.16.0
 Provides-Extra: dev
 Requires-Dist: ruff==0.12.0; extra == "dev"
 Requires-Dist: pre-commit>=3.5.0; extra == "dev"
@@ -67,6 +66,7 @@ Requires-Dist: nbmake>=1.5.3; extra == "doc"
 Requires-Dist: openpyxl>=3.1.2; extra == "doc"
 Requires-Dist: sphinx-tabs>=3.4.7; extra == "doc"
 Requires-Dist: towncrier>=24.8.0; extra == "doc"
+Requires-Dist: geopandas>=1.1.1; extra == "doc"
 Provides-Extra: torch
 Requires-Dist: torch>=2.7.0; extra == "torch"
 Dynamic: license-file

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gamspy"
-version = "1.15.0"
+version = "1.16.0"
 authors = [
   { name = "GAMS Development Corporation", email = "support@gams.com" },
 ]
@@ -25,24 +25,23 @@ classifiers = [
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Operating System :: POSIX",
   "Operating System :: Unix",
   "Operating System :: MacOS",
   "Operating System :: Microsoft :: Windows",
 ]
 dependencies = [
-  "gamsapi[transfer] == 50.4.0",
-  "gamspy_base == 50.4.0",
+  "gamsapi[transfer] >= 51.1.0",
+  "gamspy_base >= 51.1.0",
   "pydantic >= 2.0",
   "certifi >= 2022.09.14",
   "urllib3 >= 2.0.7",
-  "typer >= 0.15.1",
-  "click < 8.2.0",
+  "typer >= 0.16.0",
 ]
 
 [project.urls]
@@ -86,6 +85,7 @@ doc = [
   "openpyxl>=3.1.2",
   "sphinx-tabs>=3.4.7",
   "towncrier>= 24.8.0",
+  "geopandas >= 1.1.1",
 ]
 
 torch = [

{gamspy-1.15.0 → gamspy-1.16.0}/src/gamspy/_algebra/condition.py

@@ -2,12 +2,14 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
+import gamspy._algebra.domain as domain
 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.utils as utils
 from gamspy._symbols.implicits.implicit_symbol import ImplicitSymbol
+from gamspy._symbols.symbol import Symbol
 
 if TYPE_CHECKING:
     import pandas as pd
@@ -103,6 +105,9 @@ class Condition(operable.Operable):
         if isinstance(self.conditioning_on, ImplicitSymbol):
             self.conditioning_on.parent._assignment = statement
             self.conditioning_on.parent._winner = "gams"
+        elif isinstance(self.conditioning_on, Symbol):
+            self.conditioning_on._assignment = statement
+            self.conditioning_on._winner = "gams"
 
         if isinstance(self.conditioning_on, implicits.ImplicitEquation):
             self.conditioning_on.parent._definition = statement
@@ -123,13 +128,38 @@ class Condition(operable.Operable):
     def records(self) -> pd.DataFrame | None:
         assert self.container is not None
         assert self.domain is not None
-        temp_name = "a" + utils._get_unique_name()
-        temp_param = syms.Parameter._constructor_bypass(
-            self.container, temp_name, self.domain
-        )
-        temp_param[...] = self
-        del self.container.data[temp_name]
-        return temp_param.records
+        if isinstance(
+            self.conditioning_on,
+            (syms.Set, syms.Alias, implicits.ImplicitSet),
+        ):
+            temp_name = "c" + utils._get_unique_name()
+            temp_sym = syms.Set._constructor_bypass(
+                self.container,
+                temp_name,
+                self.domain,  # type: ignore
+            )
+            temp_sym[...] = self
+            del self.container.data[temp_name]
+        elif isinstance(self.conditioning_on, domain.Domain):
+            temp_name = "c" + utils._get_unique_name()
+            temp_sym = syms.Set._constructor_bypass(
+                self.container,
+                temp_name,
+                self.domain,  # type: ignore
+            )
+            temp_sym[...].where[self.condition] = True
+            del self.container.data[temp_name]
+        else:
+            temp_name = "c" + utils._get_unique_name()
+            temp_sym = syms.Parameter._constructor_bypass(
+                self.container,
+                temp_name,
+                self.domain,  # type: ignore
+            )
+            temp_sym[...] = self
+            del self.container.data[temp_name]
+
+        return temp_sym.records
 
     def gamsRepr(self) -> str:
         condition_str = (

{gamspy-1.15.0 → gamspy-1.16.0}/src/gamspy/_algebra/domain.py

@@ -39,6 +39,7 @@ class Domain:
         self._sanity_check(sets)
         self.sets = sets
         self.container = self._find_container()  # type: ignore
+        self.domain = sets
         self.where = condition.Condition(self)
 
     def __repr__(self) -> str:

{gamspy-1.15.0 → gamspy-1.16.0}/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.16.0}/src/gamspy/_algebra/operation.py

@@ -744,12 +744,18 @@ class Ord(operable.Operable):
 
     """
 
-    def __init__(self, symbol: Set | Alias):
+    def __new__(cls, symbol: Set | Alias):
         if not isinstance(symbol, (syms.Set, syms.Alias)):
             raise ValidationError(
                 "Ord operation is only for Set and Alias objects!"
             )
 
+        if symbol.is_singleton:
+            return 1
+
+        return super().__new__(cls)
+
+    def __init__(self, symbol: Set | Alias):
         self._symbol = symbol
         self.container = symbol.container
         self.domain: list[Set | Alias] = []

{gamspy-1.15.0 → gamspy-1.16.0}/src/gamspy/_backend/engine.py

@@ -13,9 +13,6 @@ import urllib.parse
 import zipfile
 from typing import TYPE_CHECKING
 
-import certifi
-import urllib3
-
 import gamspy._backend.backend as backend
 import gamspy.utils as utils
 from gamspy._options import Options
@@ -747,9 +744,7 @@ class EngineClient:
         self.is_blocking = is_blocking
         self.tokens: list[str] = []
 
-        self._http = urllib3.PoolManager(
-            cert_reqs="CERT_REQUIRED", ca_certs=certifi.where()
-        )
+        self._http = utils._make_http()
 
         self._engine_config = EngineConfiguration(
             self.host,

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

@@ -5,7 +5,6 @@ import shutil
 import sys
 from typing import Annotated, Iterable, Optional, Union
 
-import certifi
 import typer
 from gamspy.exceptions import GamspyException, ValidationError
 import gamspy.utils as utils
@@ -35,8 +34,6 @@ def license(
     import json
     from urllib.parse import urlencode
 
-    import urllib3
-
     os.makedirs(utils.DEFAULT_DIR, exist_ok=True)
 
     is_alp = not os.path.isfile(license)
@@ -56,10 +53,8 @@ def license(
 
         # Make cmex_type check only for GAMS license server.
         if server == "https://license.gams.com":
-            http = urllib3.PoolManager(
-                cert_reqs="CERT_REQUIRED",
-                ca_certs=certifi.where()
-            )
+            http = utils._make_http()
+
             encoded_args = urlencode({"access_token": alp_id})
             request = http.request(
                 "GET", f"{server}/license-type?" + encoded_args
@@ -261,7 +256,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.16.0}/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.16.0}/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.16.0}/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.16.0}/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.16.0}/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.16.0}/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.16.0}/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
@@ -33,9 +34,9 @@ if TYPE_CHECKING:
     from gamspy._types import EllipsisType
 
 
-eq_types = ["=e=", "=l=", "=g="]
+EQ_TYPES = ["=e=", "=l=", "=g=", "=n=", "=x=", "=b="]
 
-non_regular_map = {
+IRREGULAR_EQ_MAP = {
     "nonbinding": "=n=",
     "external": "=x=",
     "boolean": "=b=",
@@ -43,10 +44,10 @@ non_regular_map = {
 
 
 class EquationType(Enum):
-    REGULAR = "REGULAR"
-    NONBINDING = "NONBINDING"
-    EXTERNAL = "EXTERNAL"
-    BOOLEAN = "BOOLEAN"
+    REGULAR = "regular"
+    NONBINDING = "nonbinding"
+    EXTERNAL = "external"
+    BOOLEAN = "boolean"
 
     @classmethod
     def values(cls):
@@ -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,
@@ -526,18 +527,25 @@ class Equation(gt.Equation, Symbol):
 
     def _set_definition(self, domain, rhs):
         # self[domain] = rhs
+        rhs_repr = rhs.gamsRepr()
+        if self.type == "nonbinding" and not any(
+            eq_type in rhs_repr for eq_type in EQ_TYPES
+        ):
+            # x - c -> x - c == 0
+            rhs = rhs == 0
 
-        if not any(eq_type in rhs.gamsRepr() for eq_type in eq_types):
+        rhs_repr = rhs.gamsRepr()
+        if not any(eq_type in rhs_repr for eq_type in EQ_TYPES):
             raise ValidationError(
                 "Equation definition must contain at least one equality sign such as ==, <= or >=."
             )
 
+        if self.type in IRREGULAR_EQ_MAP and "=e=" in rhs_repr:
+            rhs.operator = IRREGULAR_EQ_MAP[self.type]
+
         if self.type == "external" and "=e=" not in rhs.gamsRepr():
             raise ValidationError("External equations must contain ==")
 
-        if self.type in non_regular_map:
-            rhs._replace_operator(non_regular_map[self.type])
-
         statement = expression.Expression(
             implicits.ImplicitEquation(
                 self,
@@ -554,6 +562,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 +1039,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
@@ -1090,10 +1129,13 @@ class Equation(gt.Equation, Symbol):
         >>> i = gp.Set(m, "i", records=['i1','i2'])
         >>> e = gp.Equation(m, "e", domain=[i])
         >>> e.gamsRepr()
-        'e'
+        'e(i)'
 
         """
-        return self.name
+        representation = self.name
+        if self.domain:
+            representation += self._get_domain_str(self._domain_forwarding)
+        return representation
 
     def latexRepr(self) -> str:
         if self._definition is None:
@@ -1159,7 +1201,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 + '"'
@@ -1223,7 +1265,8 @@ class Equation(gt.Equation, Symbol):
 
 def cast_type(type: str | EquationType) -> str:
     if isinstance(type, str):
-        if type.lower() not in (
+        type = type.lower()
+        if type not in (
             "eq",
             "geq",
             "leq",
@@ -1238,7 +1281,7 @@ def cast_type(type: str | EquationType) -> str:
             )
 
         # assign eq by default
-        if type.upper() == "REGULAR":
+        if type == "regular":
             type = "eq"
 
     elif isinstance(type, EquationType):

{gamspy-1.15.0 → gamspy-1.16.0}/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:
@@ -137,14 +139,26 @@ class ImplicitEquation(ImplicitSymbol):
         return self.parent.slack
 
     @property
-    def records(self) -> pd.DataFrame | float | None:
+    def records(self) -> pd.DataFrame | None:
         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