gamspy 1.17.1__tar.gz → 1.18.0__tar.gz

{gamspy-1.17.1 → gamspy-1.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gamspy
-Version: 1.17.1
+Version: 1.18.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/
@@ -31,8 +31,8 @@ Classifier: Operating System :: Microsoft :: Windows
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: gamsapi<52.0.0,>=51.1.0
-Requires-Dist: gamspy_base<52.0.0,>=51.1.0
+Requires-Dist: gamsapi<53.0.0,>=52.1.0
+Requires-Dist: gamspy_base<53.0.0,>=52.1.0
 Requires-Dist: pandas<2.4,>=2.2.2
 Requires-Dist: pydantic>=2.0
 Requires-Dist: requests>=2.28.0

{gamspy-1.17.1 → gamspy-1.18.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gamspy"
-version = "1.17.1"
+version = "1.18.0"
 authors = [
   { name = "GAMS Development Corporation", email = "support@gams.com" },
 ]
@@ -36,8 +36,8 @@ classifiers = [
   "Operating System :: Microsoft :: Windows",
 ]
 dependencies = [
-  "gamsapi >= 51.1.0, < 52.0.0",
-  "gamspy_base >= 51.1.0, < 52.0.0",
+  "gamsapi >= 52.1.0, < 53.0.0",
+  "gamspy_base >= 52.1.0, < 53.0.0",
   "pandas >= 2.2.2, < 2.4",
   "pydantic >= 2.0",
   "requests >= 2.28.0",

{gamspy-1.17.1 → gamspy-1.18.0}/src/gamspy/_backend/backend.py

@@ -12,6 +12,7 @@ from gamspy.exceptions import GamspyException, ValidationError
 
 if TYPE_CHECKING:
     import io
+    from pathlib import Path
 
     from gamspy import Container, Model, Options
     from gamspy._backend.engine import EngineClient, GAMSEngine
@@ -52,7 +53,7 @@ def backend_factory(
     container: Container,
     options: Options | None = None,
     solver: str | None = None,
-    solver_options: dict | None = None,
+    solver_options: dict | Path | None = None,
     output: io.TextIOWrapper | None = None,
     backend: Literal["local", "engine", "neos"] = "local",
     client: EngineClient | NeosClient | None = None,
@@ -126,7 +127,7 @@ class Backend(ABC):
         model: Model | None,
         options: Options,
         solver: str | None,
-        solver_options: dict | None,
+        solver_options: dict | Path | None,
         output: io.TextIOWrapper | None,
         load_symbols: list[Symbol] | None,
     ):

{gamspy-1.17.1 → gamspy-1.18.0}/src/gamspy/_backend/engine.py

@@ -17,6 +17,7 @@ import requests
 
 import gamspy._backend.backend as backend
 import gamspy.utils as utils
+from gamspy._communication import send_job
 from gamspy._options import Options
 from gamspy.exceptions import (
     EngineClientException,
@@ -26,6 +27,8 @@ from gamspy.exceptions import (
 )
 
 if TYPE_CHECKING:
+    from pathlib import Path
+
     from gamspy import Container, Model
     from gamspy._symbols.symbol import Symbol
 
@@ -742,7 +745,7 @@ class GAMSEngine(backend.Backend):
         client: EngineClient | None,
         options: Options,
         solver: str,
-        solver_options: dict | None,
+        solver_options: dict | Path | None,
         output: io.TextIOWrapper | None,
         model: Model,
         load_symbols: list[Symbol] | None,
@@ -916,7 +919,7 @@ class GAMSEngine(backend.Backend):
         options._extra_options["save"] = self.restart_file
         options._export(self.pf_file)
 
-        self.container._send_job(self.job_name, self.pf_file)
+        send_job(self.container._comm_pair_id, self.job_name, self.pf_file)
 
     def _sync(self):
         symbols = utils._get_symbol_names_from_gdx(
@@ -931,7 +934,7 @@ class GAMSEngine(backend.Backend):
         options._set_extra_options(extra_options)
         options._export(self.pf_file)
 
-        self.container._send_job(self.job_name, self.pf_file)
+        send_job(self.container._comm_pair_id, self.job_name, self.pf_file)
 
     def _append_gamspy_files(self) -> list[str]:
         extra_model_files = self.client.extra_model_files + [self.restart_file]

{gamspy-1.17.1 → gamspy-1.18.0}/src/gamspy/_backend/local.py

@@ -5,10 +5,12 @@ from typing import TYPE_CHECKING
 
 import gamspy._backend.backend as backend
 import gamspy._miro as miro
+from gamspy._communication import send_job
 from gamspy.exceptions import GamspyException, _customize_exception
 
 if TYPE_CHECKING:
     import io
+    from pathlib import Path
 
     from gamspy import Container, Model, Options
     from gamspy._symbols.symbol import Symbol
@@ -20,7 +22,7 @@ class Local(backend.Backend):
         container: Container,
         options: Options,
         solver: str | None,
-        solver_options: dict | None,
+        solver_options: dict | Path | None,
         output: io.TextIOWrapper | None,
         model: Model | None,
         load_symbols: list[Symbol] | None,
@@ -89,7 +91,9 @@ class Local(backend.Backend):
         self.options._export(self.pf_file, self.output)
 
         try:
-            self.container._send_job(self.job_name, self.pf_file, self.output)
+            send_job(
+                self.container._comm_pair_id, self.job_name, self.pf_file, self.output
+            )
 
             if not self.is_async() and self.model:
                 self.model._update_model_attributes()

{gamspy-1.17.1 → gamspy-1.18.0}/src/gamspy/_backend/neos.py

@@ -7,12 +7,14 @@ import shutil
 import ssl
 import xmlrpc.client
 import zipfile
-from typing import TYPE_CHECKING
+from pathlib import Path
+from typing import TYPE_CHECKING, Any
 
 import certifi
 
 import gamspy._backend.backend as backend
 import gamspy.utils as utils
+from gamspy._communication import send_job
 from gamspy._options import Options
 from gamspy.exceptions import (
     GamspyException,
@@ -256,7 +258,7 @@ class NeosClient:
     def _prepare_xml(
         self,
         gams_string: str,
-        solver_options: dict | None,
+        solver_options: dict | Path | None,
         gdx_path: str,
         restart_path: str,
         options: Options,
@@ -282,6 +284,9 @@ class NeosClient:
 
         solver_options_str = ""
         if solver_options:
+            if isinstance(solver_options, Path):
+                solver_options = _parse_solver_options(solver_options)
+
             solver_options_str = "\n".join(
                 [f"{key} {value}" for key, value in solver_options.items()]
             )
@@ -380,7 +385,7 @@ class NEOSServer(backend.Backend):
         container: Container,
         options: Options,
         solver: str,
-        solver_options: dict | None,
+        solver_options: dict | Path | None,
         client: NeosClient | None,
         output: io.TextIOWrapper | None,
         model: Model,
@@ -527,7 +532,7 @@ class NEOSServer(backend.Backend):
         options._extra_options["save"] = self.restart_file
         options._export(self.pf_file)
 
-        self.container._send_job(self.job_name, self.pf_file)
+        send_job(self.container._comm_pair_id, self.job_name, self.pf_file)
 
     def _sync(self):
         symbols = utils._get_symbol_names_from_gdx(
@@ -542,4 +547,21 @@ class NEOSServer(backend.Backend):
         options._set_extra_options(extra_options)
         options._export(self.pf_file)
 
-        self.container._send_job(self.job_name, self.pf_file)
+        send_job(self.container._comm_pair_id, self.job_name, self.pf_file)
+
+
+def _parse_solver_options(path: Path) -> dict[str, Any]:
+    """Parse solver options to a dict"""
+    solver_options = {}
+    with open(path) as file:
+        lines = file.readlines()
+
+    for line in lines:
+        if not line or line.startswith("*"):
+            continue
+
+        splitter = "=" if "=" in line else " "
+        key, value = line.split(splitter)
+        solver_options[key.strip()] = value
+
+    return solver_options

{gamspy-1.17.1 → gamspy-1.18.0}/src/gamspy/_cli/install.py

@@ -7,6 +7,7 @@ import subprocess
 import sys
 from typing import TYPE_CHECKING, Annotated
 
+import certifi
 import requests
 import typer
 
@@ -133,11 +134,16 @@ def license(
             command.append("-o")
             command.append(license_path)
 
+        environment_variables = os.environ.copy()
+        if "CURL_CA_BUNDLE" not in environment_variables:
+            environment_variables["CURL_CA_BUNDLE"] = certifi.where()
+
         process = subprocess.run(
             command,
             text=True,
             capture_output=True,
             encoding="utf-8",
+            env=environment_variables,
         )
         if process.returncode:
             raise ValidationError(process.stderr)
@@ -243,6 +249,9 @@ def solver(
 
     addons_path = os.path.join(utils.DEFAULT_DIR, "solvers.txt")
     os.makedirs(utils.DEFAULT_DIR, exist_ok=True)
+    environment_variables = os.environ.copy()
+    if "CURL_CA_BUNDLE" not in environment_variables:
+        environment_variables["CURL_CA_BUNDLE"] = certifi.where()
 
     def install_addons(addons: Iterable[str]):
         for item in addons:
@@ -291,6 +300,7 @@ def solver(
                         check=True,
                         encoding="utf-8",
                         stderr=subprocess.PIPE,
+                        env=environment_variables,
                     )
                 except subprocess.CalledProcessError as e:
                     raise GamspyException(

{gamspy-1.17.1 → gamspy-1.18.0}/src/gamspy/_cli/retrieve.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import os
 import subprocess
 
+import certifi
 import typer
 
 import gamspy.utils as utils
@@ -46,6 +47,10 @@ def license(
     if access_code is None:
         raise ValidationError(f"Given licence id `{access_code}` is not valid!")
 
+    environment_variables = os.environ.copy()
+    if "CURL_CA_BUNDLE" not in environment_variables:
+        environment_variables["CURL_CA_BUNDLE"] = certifi.where()
+
     gamspy_base_dir = utils._get_gamspy_base_directory()
     command = [
         os.path.join(gamspy_base_dir, "gamsgetkey"),
@@ -58,9 +63,7 @@ def license(
         command.append(str(checkout_duration))
 
     process = subprocess.run(
-        command,
-        text=True,
-        capture_output=True,
+        command, text=True, capture_output=True, env=environment_variables
     )
 
     if process.returncode:

{gamspy-1.17.1 → gamspy-1.18.0}/src/gamspy/_cli/run.py

@@ -5,11 +5,12 @@ import platform
 import subprocess
 import sys
 from enum import Enum
-from typing import Annotated
+from pathlib import Path  # noqa: TC003
+from typing import Annotated, Optional
 
 import typer
 
-from gamspy.exceptions import GamspyException, ValidationError
+from gamspy.exceptions import ValidationError
 
 app = typer.Typer(
     rich_markup_mode="rich",
@@ -19,7 +20,7 @@ app = typer.Typer(
 )
 
 
-class ModeEnum(Enum):
+class ModeEnum(str, Enum):
     config = "config"
     base = "base"
     deploy = "deploy"
@@ -35,10 +36,11 @@ def miro(
         typer.Option("--mode", "-m", help="Execution mode of MIRO"),
     ] = ModeEnum.base,  # type: ignore
     path: Annotated[
-        str | None,
+        Optional[Path],  # noqa: UP045
         typer.Option(
             "--path",
             "-p",
+            exists=True,
             help="Path to the MIRO executable (.exe, .app, or .AppImage)",
         ),
     ] = None,
@@ -47,8 +49,8 @@ def miro(
         typer.Option("--skip-execution", help="Whether to skip model execution."),
     ] = False,
     model: Annotated[
-        str | None,
-        typer.Option("--model", "-g", help="Path to the GAMSPy model."),
+        Optional[Path],  # noqa: UP045,
+        typer.Option("--model", "-g", exists=True, help="Path to the GAMSPy model."),
     ] = None,
     args: Annotated[
         list[str] | None,
@@ -56,17 +58,18 @@ def miro(
     ] = None,
 ) -> None:
     if model is None:
-        raise ValidationError("--model must be provided to run MIRO")
+        typer.echo("--model must be provided to run MIRO", file=sys.stderr)
+        sys.exit(1)
 
     model = os.path.abspath(model)
     execution_mode = mode.value
-    path = os.getenv("MIRO_PATH", None)
+    path = os.getenv("MIRO_PATH", path)
 
     if path is None:
         path = path if path is not None else discover_miro()
 
     if path is None:
-        raise GamspyException("--path must be provided to run MIRO")
+        raise ValidationError("--path must be provided to run MIRO")
 
     if platform.system() == "Darwin" and os.path.splitext(path)[1] == ".app":
         path = os.path.join(path, "Contents", "MacOS", "GAMS MIRO")
@@ -79,10 +82,16 @@ def miro(
         if args is not None:
             command += args
 
-        try:
-            subprocess.run(command, env=subprocess_env, check=True)
-        except subprocess.CalledProcessError:
-            return
+        process = subprocess.run(
+            command,
+            env=subprocess_env,
+            capture_output=True,
+            text=True,
+            encoding="utf-8",
+        )
+        if process.returncode != 0:
+            typer.echo(process.stderr, file=sys.stderr)
+            sys.exit(process.returncode)
 
     # Run MIRO
     subprocess_env = os.environ.copy()

{gamspy-1.17.1 → gamspy-1.18.0}/src/gamspy/_cli/uninstall.py

@@ -5,6 +5,7 @@ import subprocess
 import sys
 from typing import TYPE_CHECKING, Annotated
 
+import certifi
 import typer
 
 import gamspy.utils as utils
@@ -70,6 +71,9 @@ def solver(
         ) from e
 
     addons_path = os.path.join(utils.DEFAULT_DIR, "solvers.txt")
+    environment_variables = os.environ.copy()
+    if "CURL_CA_BUNDLE" not in environment_variables:
+        environment_variables["CURL_CA_BUNDLE"] = certifi.where()
 
     def remove_addons(addons: Iterable[str]):
         for item in addons:

gamspy-1.18.0/src/gamspy/_communication.py

@@ -0,0 +1,215 @@
+from __future__ import annotations
+
+import os
+import platform
+import signal
+import socket
+import subprocess
+import threading
+import time
+from typing import TYPE_CHECKING
+
+import certifi
+
+from gamspy import utils
+from gamspy.exceptions import FatalError, GamspyException, ValidationError
+
+if TYPE_CHECKING:
+    import io
+
+    from gamspy import Container
+
+
+_comm_pairs: dict[str, tuple[socket.socket, subprocess.Popen]] = {}
+
+
+def open_connection(container: Container) -> None:
+    LOOPBACK = "127.0.0.1"
+    TIMEOUT = 30
+
+    initial_pf_file = os.path.join(container._process_directory, "gamspy.pf")
+    with open(initial_pf_file, "w") as file:
+        file.write(
+            'incrementalMode="2"\n'
+            f'procdir="{container._process_directory}"\n'
+            f'license="{container._license_path}"\n'
+            f'curdir="{os.getcwd()}"\n'
+        )
+
+    command = [
+        os.path.join(container.system_directory, "gams"),
+        "GAMSPY_JOB",
+        "pf",
+        initial_pf_file,
+    ]
+
+    certificate_path = os.path.join(utils.DEFAULT_DIR, "gamspy_cert.crt")
+    env = os.environ.copy()
+    if os.path.isfile(certificate_path):
+        env["GAMSLICECRT"] = certificate_path
+
+    env = os.environ.copy()
+    if "CURL_CA_BUNDLE" not in env:
+        env["CURL_CA_BUNDLE"] = certifi.where()
+
+    process = subprocess.Popen(
+        command,
+        text=True,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+        errors="replace",
+        start_new_session=platform.system() != "Windows",
+        env=env,
+    )
+
+    port_info = process.stdout.readline().strip()
+
+    try:
+        port = int(port_info.removeprefix("port: "))
+    except ValueError as e:
+        raise ValidationError(
+            f"Error while reading the port! {port_info + process.stdout.read()}"
+        ) from e
+
+    def handler(signum, frame):
+        if platform.system() != "Windows":
+            os.kill(process.pid, signal.SIGINT)
+
+    if threading.current_thread() is threading.main_thread():
+        signal.signal(signal.SIGINT, handler)
+
+    start = time.time()
+    while True:
+        if process.poll() is not None:  # pragma: no cover
+            raise ValidationError(process.communicate()[0])
+
+        try:
+            new_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            new_socket.connect((LOOPBACK, port))
+            break
+        except (ConnectionRefusedError, OSError) as e:
+            new_socket.close()
+            end = time.time()
+
+            if end - start > TIMEOUT:  # pragma: no cover
+                raise FatalError(
+                    f"Timeout while establishing the connection with socket. {process.communicate()[0]}"
+                ) from e
+
+    _comm_pairs[container._comm_pair_id] = (new_socket, process)
+
+
+def get_connection(pair_id: str) -> tuple[socket.socket, subprocess.Popen]:
+    return _comm_pairs[pair_id]
+
+
+def close_connection(pair_id: str):
+    try:
+        _socket, process = get_connection(pair_id)
+    except KeyError:
+        # This means that the connection is already closed.
+        return
+
+    _socket.sendall(b"stop")
+    _socket.close()
+
+    if not process.stdout.closed:
+        process.stdout.close()
+
+    # Wait until the GAMS process dies.
+    while process.poll() is None:
+        ...
+
+    del _comm_pairs[pair_id]
+
+
+def _read_output(process: subprocess.Popen, output: io.TextIOWrapper | None) -> None:
+    if output is not None:
+        while True:
+            data = process.stdout.readline()
+            output.write(data)
+            output.flush()
+            if data.startswith("--- Job ") and "elapsed" in data:
+                break
+
+
+def check_response(response: bytes, job_name: str) -> None:
+    GAMS_STATUS = {
+        1: "Solver is to be called, the system should never return this number.",
+        2: "There was a compilation error.",
+        3: "There was an execution error.",
+        4: "System limits were reached.",
+        5: "There was a file error.",
+        6: "There was a parameter error.",
+        7: "The solve has failed due to a license error. The license you are using may impose model size limits (demo/community license) or you are using a GAMSPy incompatible professional license. Please contact sales@gams.com to find out about license options.",
+        8: "There was a GAMS system error.",
+        9: "GAMS could not be started.",
+        10: "Out of memory.",
+        11: "Out of disk.",
+        109: "Could not create process/scratch directory.",
+        110: "Too many process/scratch directories.",
+        112: "Could not delete the process/scratch directory.",
+        113: "Could not write the script gamsnext.",
+        114: "Could not write the parameter file.",
+        115: "Could not read environment variable.",
+        400: "Could not spawn the GAMS language compiler (gamscmex).",
+        401: "Current directory (curdir) does not exist.",
+        402: "Cannot set current directory (curdir).",
+        404: "Blank in system directory (UNIX only).",
+        405: "Blank in current directory (UNIX only).",
+        406: "Blank in scratch extension (scrext)",
+        407: "Unexpected cmexRC.",
+        408: "Could not find the process directory (procdir).",
+        409: "CMEX library not be found (experimental).",
+        410: "Entry point in CMEX library could not be found (experimental).",
+        411: "Blank in process directory (UNIX only).",
+        412: "Blank in scratch directory (UNIX only).",
+        909: "Cannot add path / unknown UNIX environment / cannot set environment variable.",
+        1000: "Driver error: incorrect command line parameters for gams.",
+        2000: "Driver error: internal error: cannot install interrupt handler.",
+        3000: "Driver error: problems getting current directory.",
+        4000: "Driver error: internal error: GAMS compile and execute module not found.",
+        5000: "Driver error: internal error: cannot load option handling library.",
+    }
+
+    value = response[: response.find(b"#")].decode("ascii")
+    if not value:
+        raise FatalError(
+            "Error while getting the return code from GAMS backend. This means that GAMS is in a bad state. Try to backtrack for previous errors."
+        )
+
+    return_code = int(value)
+
+    if return_code in GAMS_STATUS:
+        try:
+            info = GAMS_STATUS[return_code]
+        except IndexError:  # pragma: no cover
+            info = ""
+
+        raise GamspyException(
+            f"Return code {return_code}. {info} Check {job_name + '.lst'} for more information.",
+            return_code,
+        )
+
+
+def send_job(
+    comm_pair_id: str,
+    job_name: str,
+    pf_file: str,
+    output: io.TextIOWrapper | None = None,
+):
+    _socket, process = get_connection(comm_pair_id)
+    try:
+        # Send pf file
+        _socket.sendall(pf_file.encode("utf-8"))
+
+        # Read output
+        _read_output(process, output)
+
+        # Receive response
+        response = _socket.recv(256)
+        check_response(response, job_name)
+    except ConnectionError as e:
+        raise FatalError(
+            f"There was an error while communicating with GAMS server: {e}",
+        ) from e